Installation¶
It is highly recommended to install the project into a new virtual environment.
Installation from PyPI¶
The atldld package can be easily installed from PyPI.
pip install atldld
Installation from source¶
As an alternative to installing from PyPI, if you want to try the latest version you can also install from source.
pip install git+https://github.com/BlueBrain/Atlas-Download-Tools
Development installation¶
For development installation one needs additional dependencies grouped in extras_requires in the
following way:
dev - pytest + plugins, flake8, pydocstyle, tox
docs - sphinx
git clone https://github.com/BlueBrain/Atlas-Download-Tools
cd Atlas-Download-Tools
pip install -e '.[dev,docs]'
Generating documentation¶
To generate the documentation make sure you have dependencies from extras_requires - docs.
cd docs
make clean && make html
One can view the docs by opening docs/_build/html/index.html in a browser.