Skip to content
Snippets Groups Projects
Commit 6ee15132 authored by Paul McCarthy's avatar Paul McCarthy :mountain_bicyclist:
Browse files

DOC: Readme fixes

parent 3b02f6c6
No related branches found
No related tags found
No related merge requests found
...@@ -29,7 +29,7 @@ Install ``fslpy`` and its core dependencies via pip:: ...@@ -29,7 +29,7 @@ Install ``fslpy`` and its core dependencies via pip::
pip install fslpy pip install fslpy
``fslpy`` is also available on `conda-forge <https://conda-forge.org/>`_: ``fslpy`` is also available on `conda-forge <https://conda-forge.org/>`_::
conda install -c conda-forge fslpy conda install -c conda-forge fslpy
...@@ -44,16 +44,16 @@ All of the core dependencies of ``fslpy`` are listed in the `requirements.txt ...@@ -44,16 +44,16 @@ All of the core dependencies of ``fslpy`` are listed in the `requirements.txt
Some extra dependencies are listed in `requirements.txt Some extra dependencies are listed in `requirements.txt
<requirements-extra.txt>`_ which provide addditional functionality: <requirements-extra.txt>`_ which provide addditional functionality:
- ``wxPython``: The `fsl.utils.idle <fsl/utils/idle.py>`_ module has - ``wxPython``: The `fsl.utils.idle <fsl/utils/idle.py>`_ module has
functionality to schedule functions on the ``wx`` idle loop. functionality to schedule functions on the ``wx`` idle loop.
- ``indexed_gzip``: The `fsl.data.image.Image <fsl/data/image.py>`_ class - ``indexed_gzip``: The `fsl.data.image.Image <fsl/data/image.py>`_ class
can use ``indexed_gzip`` to keep large compressed images on disk instead can use ``indexed_gzip`` to keep large compressed images on disk instead
of decompressing and loading them into memory.. of decompressing and loading them into memory..
- ``trimesh``/``rtree``: The `fsl.data.mesh.TriangleMesh <fsl/data/mesh.py>`_ - ``trimesh``/``rtree``: The `fsl.data.mesh.TriangleMesh <fsl/data/mesh.py>`_
class has some methods which use ``trimesh`` to perform geometric queries class has some methods which use ``trimesh`` to perform geometric queries
on the mesh. on the mesh.
If you are using Linux, need to install wxPython first, as binaries are not If you are using Linux, need to install wxPython first, as binaries are not
...@@ -89,10 +89,6 @@ The HTML documentation will be generated and saved in the ``doc/html/`` ...@@ -89,10 +89,6 @@ The HTML documentation will be generated and saved in the ``doc/html/``
directory. directory.
If you are interested in contributing to ``fslpy``, check out the
`contributing guide <doc/contributing.rst>`_.
Tests Tests
----- -----
...@@ -105,6 +101,14 @@ A test report will be generated at ``report.html``, and a code coverage report ...@@ -105,6 +101,14 @@ A test report will be generated at ``report.html``, and a code coverage report
will be generated in ``htmlcov/``. will be generated in ``htmlcov/``.
Contributing
------------
If you are interested in contributing to ``fslpy``, check out the
`contributing guide <doc/contributing.rst>`_.
Credits Credits
------- -------
......
0% Loading or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment