Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

DOC: Add an *Installation* section #122

Merged
merged 2 commits into from
Jul 15, 2021
Merged

DOC: Add an *Installation* section #122

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
1df315d
DOC: Add an _Installation_ section
oesteban Jul 14, 2021
cefd517
DOC: Add installation verification
mgxd Jul 15, 2021
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
3 changes: 2 additions & 1 deletion docs/index.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -51,5 +51,6 @@ Contents
.. toctree::
:maxdepth: 3

installation
changes
api
changes
30 changes: 30 additions & 0 deletions docs/installation.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,30 @@
Installation
============
*NiTransforms* is distributed via *Pypi* and can easily be installed
within your Python distribution with::

python -m pip install nitransforms

Alternatively, you can install the bleeding-edge version of the software
directly from the GitHub repo with::

python -m pip install git+https://github.com/poldracklab/nitransforms.git@master

To verify the installation, you can run the following command::

python -c "import nitransforms as nt; print(nt.__version__)"

You should see the version number.

Developers
----------
Advanced users and developers who plan to contribute with bugfixes, documentation,
etc. can first clone our Git repository::

git clone https://github.com/poldracklab/nitransforms.git


and install the tool in *editable* mode::

cd nitransforms
python -m pip install -e .