Merge pull request fury-gl#91 from skoudoro/doc-update

[Doc] add installation instruction
BramshQamar · Aug 1, 2019 · 1ce3ca4 · 1ce3ca4
2 parents 7899dc9 + e764c17
commit 1ce3ca4
Show file tree

Hide file tree

Showing 7 changed files with 97 additions and 18 deletions.
diff --git a/docs/examples/viz_roi_contour.py b/docs/examples/viz_roi_contour.py
@@ -13,9 +13,14 @@
 from dipy.reconst.shm import CsaOdfModel
 from dipy.data import default_sphere
 from dipy.direction import peaks_from_model
-from dipy.tracking.local import ThresholdTissueClassifier
+try:
+    from dipy.tracking.local import ThresholdTissueClassifier as ThresholdStoppingCriterion
+    from dipy.tracking.local import LocalTracking
+except ModuleNotFoundError:
+    from dipy.tracking.stopping_criterion import ThresholdStoppingCriterion
+    from dipy.tracking.local_tracking import LocalTracking
+
 from dipy.tracking import utils
-from dipy.tracking.local import LocalTracking
 from dipy.tracking.streamline import Streamlines
 from fury import actor, window
 from fury.colormap import line_colors
@@ -38,7 +43,7 @@
                              min_separation_angle=45,
                              mask=white_matter)
 
-classifier = ThresholdTissueClassifier(csa_peaks.gfa, .25)
+classifier = ThresholdStoppingCriterion(csa_peaks.gfa, .25)
 
 seed_mask = labels == 2
 seeds = utils.seeds_from_mask(seed_mask, density=[1, 1, 1], affine=affine)

diff --git a/docs/source/_templates/page.html b/docs/source/_templates/page.html
@@ -73,7 +73,7 @@ <h1 id="logo-wrap">
             <a href="{{ pathto('reference/index')}}" class="main-nav-link">API</a>
             <a href="{{ pathto('auto_tutorials/index')}}" class="main-nav-link">Tutorial</a>
             <a href="{{ pathto('auto_examples/index')}}" class="main-nav-link">Examples</a>
-            <a href="{{ pathto('community/index')}}" class="main-nav-link">Community</a>
+            <a href="{{ pathto('community')}}" class="main-nav-link">Community</a>
             <a href="https://github.com/fury-gl/fury" class="main-nav-link"><i class="fa fa-github-alt"></i></a>
         </nav>
         <a id="mobile-nav-toggle">

diff --git a/docs/source/authors_link.rst → docs/source/community.rst b/docs/source/authors_link.rst → docs/source/community.rst
@@ -1,6 +1,16 @@
-========
-Credits
-========
+=========
+Community
+=========
+
+Join Us!
+--------
+
+- via `Slack <https://join.slack.com/t/fury-gl/shared_invite/enQtNzE1NTk2Mzc3OTQyLTQyNDZiNTUxNWUyZjFmMzZlNDUxZDQ0MzllYjUyYTY1MjFhMmQyYmI3NjJkYzc3YTMwNmRjOWIzMDBjNTYzMDU>`_
+- via `mailing list <https://mail.python.org/mailman3/lists/fury.python.org>`_
+- via `github <https://github.com/fury-gl/fury>`_
+
+Contributors
+------------
 
 .. raw:: html
 

diff --git a/docs/source/conf.py b/docs/source/conf.py
@@ -31,7 +31,7 @@
 
 # If your documentation needs a minimal Sphinx version, state it here.
 #
-needs_sphinx = '1.6'
+needs_sphinx = '2.1'
 
 # Add any Sphinx extension module names here, as strings. They can be
 # extensions coming with Sphinx (named 'sphinx.ext.*') or your custom

diff --git a/docs/source/getting_started.rst b/docs/source/getting_started.rst
@@ -46,14 +46,7 @@ FURY is distributed under the BSD 3 License
 Credits
 --------
 
-The following people have been involved in the development of FURY:
-
-* Eleftherios Garyfallidis, Indiana University, IN, USA
-* Marc-Alexandre Côté, Microsoft Research, Montreal, QC, CA
-* David Reagan, Indiana University, IN, USA
-* Ranveer Aggarwal, Microsoft, Hyderabad, Telangana, India
-* Serge Koudoro, Indiana University, IN, USA
-* Karandeep Singh Juneja, India
+Go to :doc:`Community page <community>` to see who have been involved in the development of FURY:
 
 Bug reports and support
 ---------------------------

diff --git a/docs/source/index.rst b/docs/source/index.rst
@@ -13,5 +13,5 @@ test
    reference/index
    contributing_link
    release-history
-   authors_link
+   community
 
diff --git a/docs/source/installation.rst b/docs/source/installation.rst
@@ -2,6 +2,77 @@
 Installation
 ============
 
-At the command line::
+FURY supports Python 3.5+. You can currently still use Python 2.7 but it will soon stop being supported as the Python 2.7 end of life is on December 31st 2019.
+
+Dependencies
+------------
+
+The mandatory dependencies are:
+
+- numpy >= 1.7.1
+- vtk >= 8.1.0
+- scipy >= 0.9
+
+The optional dependencies are:
+
+- matplotlib >= 2.0.0
+- dipy >= 0.16.0
+
+
+Installation with PyPi
+----------------------
+
+In a terminal, issue the following command::
 
     $ pip install fury
+
+Installation with Conda
+-----------------------
+
+Our conda package is on the Conda-Forge channel. You will need to run the following command::
+
+    $ conda install -c conda-forge fury
+
+Installation via Source
+-----------------------
+
+**Step 1.** Get the latest source by cloning this repo::
+
+    $ git clone https://github.com/fury-gl/fury.git
+
+**Step 2.** Install requirements::
+
+    $ pip install -r requirements/default.txt
+
+**Step 3.** Install fury via::
+
+    $ pip install .
+
+or::
+
+    $ pip install -e .
+
+**Step 4:** Enjoy!
+
+Test the Installation
+---------------------
+
+You can check your installation via this command::
+
+    $ python -c "from fury import get_info; print(get_info())"
+
+This command will give you important information about FURY's installation. The next step will be to run a :doc:`tutorial <auto_tutorials/index>`.
+
+Running the Tests
+-----------------
+
+There are two ways to run FURY tests:
+
+- From python interpreter::
+
+    $ from fury.tests import test
+    $ test()
+
+- From the command line. You need to be on the FURY package folder::
+
+    pytest -svv fury