-
Notifications
You must be signed in to change notification settings - Fork 23
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
Showing
2 changed files
with
56 additions
and
1 deletion.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,54 @@ | ||
Installation | ||
============ | ||
|
||
.. note:: | ||
|
||
RLTK only supports Python 3 and it's tested under Python 3.6. | ||
|
||
pip | ||
---- | ||
|
||
Using pip to install:: | ||
|
||
pip install rltk | ||
|
||
If you want to update RLTK:: | ||
|
||
pip install -U rltk | ||
|
||
Generally, it's recommended to install packages in a virtual environment:: | ||
|
||
virtualenv rltk_env | ||
source activate rltk_env | ||
pip install rltk | ||
|
||
Install from source | ||
------------------- | ||
|
||
The other way to install RLTK is to clone from GitHub repository and build it from source:: | ||
|
||
git clone https://github.com/usc-isi-i2/rltk.git | ||
cd rltk | ||
|
||
virtualenv rltk_env | ||
source activate rltk_env | ||
pip install -e . | ||
|
||
Run tests | ||
--------- | ||
|
||
RLTK uses `pytest <https://pytest.org/>`_ for unit tests. To run them, simply do following command from the root of rltk package:: | ||
|
||
pytest | ||
|
||
If you need more detailed information, do:: | ||
|
||
pytest -v --color=yes | ||
|
||
Build documentation | ||
------------------- | ||
|
||
Documentation is powered by `Sphinx <http://www.sphinx-doc.org/en/master/usage/restructuredtext/basics.html>`_ , to generate it on your local, please run:: | ||
|
||
cd docs | ||
make html # the generated doc is located at _build/html/index.html |