Skip to content

Commit

Permalink
forgot to commit last doc fixes..
Browse files Browse the repository at this point in the history
  • Loading branch information
francoislaurent committed Jul 20, 2021
1 parent 8d12d45 commit 625d85e
Show file tree
Hide file tree
Showing 2 changed files with 5 additions and 7 deletions.
4 changes: 2 additions & 2 deletions containers/available_images.rst
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,7 @@ Available singularity images are:
resulting in command ``python3.6 -s -m tramway $@``.
The included Python dependencies are the following:

```
``
bcrypt==3.2.0
cached-property==1.5.2
cffi==1.14.6
Expand Down Expand Up @@ -45,4 +45,4 @@ stopit==1.1.2
threadpoolctl==2.2.0
tifffile==2020.9.3
tqdm==4.61.2
```
``
8 changes: 3 additions & 5 deletions doc/installation.rst
Original file line number Diff line number Diff line change
Expand Up @@ -7,20 +7,18 @@ You will need Python >= 3.6.

::

pip install --user tramway
pip install tramway

or::

git clone https://github.com/DecBayComp/TRamWAy
cd TRamWAy
pip install --user .
pip install -e .

On Linux, in both cases you may also want to pass the ``--user`` option to ``pip install``.

``pip install`` will install some Python dependencies if missing, but you may still need to install the `HDF5 reference library <https://support.hdfgroup.org/downloads/index.html>`_.

Note also that Python3's *pip* command may be available as *pip3* and installing |tramway| for Python2 or Python3 does not make it available for Python3 or Python2 respectively.
You may want to install |tramway| twice, once for each Python version.

To compile the documentation and get a local copy, after installing |tramway| do::

cd doc
Expand Down

0 comments on commit 625d85e

Please sign in to comment.