Skip to content

Commit 30d3b17

Browse files
authored
Merge pull request #122 from poldracklab/docs/installation
DOC: Add an *Installation* section
2 parents f0e0f7c + cefd517 commit 30d3b17

File tree

2 files changed

+32
-1
lines changed

2 files changed

+32
-1
lines changed

docs/index.rst

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -51,5 +51,6 @@ Contents
5151
.. toctree::
5252
:maxdepth: 3
5353

54+
installation
55+
changes
5456
api
55-
changes

docs/installation.rst

Lines changed: 30 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,30 @@
1+
Installation
2+
============
3+
*NiTransforms* is distributed via *Pypi* and can easily be installed
4+
within your Python distribution with::
5+
6+
python -m pip install nitransforms
7+
8+
Alternatively, you can install the bleeding-edge version of the software
9+
directly from the GitHub repo with::
10+
11+
python -m pip install git+https://github.com/poldracklab/nitransforms.git@master
12+
13+
To verify the installation, you can run the following command::
14+
15+
python -c "import nitransforms as nt; print(nt.__version__)"
16+
17+
You should see the version number.
18+
19+
Developers
20+
----------
21+
Advanced users and developers who plan to contribute with bugfixes, documentation,
22+
etc. can first clone our Git repository::
23+
24+
git clone https://github.com/poldracklab/nitransforms.git
25+
26+
27+
and install the tool in *editable* mode::
28+
29+
cd nitransforms
30+
python -m pip install -e .

0 commit comments

Comments
 (0)