Merge ef45ceb into 7bf15d9

.travis.yml

@@ -44,6 +44,7 @@ env:
     # Values are "true", "false" or "".
     - TEST_NOTEBOOKS="true"
     - USE_SIMA="true"
+    - USE_SUITE2P="true"
     # Set flag for whether to use a conda environment
     # values can be:
     # "" or "false":  conda not used
@@ -68,6 +69,7 @@ jobs:
       language: shell
       env:
         - TRAVIS_PYTHON_VERSION="2.7.17"
+        - USE_SUITE2P="false"
 
     - name: "Python 2.7.17 [oldest, no sima] on macOS 10.14"
       os: osx
@@ -77,6 +79,7 @@ jobs:
         - TRAVIS_PYTHON_VERSION="2.7.17"
         - USE_OLDEST_DEPS="true"
         - USE_SIMA="false"
+        - USE_SUITE2P="false"
 
     - name: "Python 3.7.5 [no sima] on macOS 10.14"
       os: osx
@@ -131,8 +134,11 @@ jobs:
     - python: "2.7"
       env:
         - USE_OLDEST_DEPS="true"
+        - USE_SUITE2P="false"
 
     - python: "2.7"
+      env:
+        - USE_SUITE2P="false"
 
     - python: "3.5"
       env:
@@ -367,6 +373,11 @@ install:
         else
             rm -f examples/*SIMA* examples/*sima*;
         fi;
+        if [[ "$USE_SUITE2P" == "true" ]]; then
+            echo "suite2p" >> requirements_all.txt;
+        else
+            rm -f examples/*Suite2p*;
+        fi;
     fi;
   # Show the resulting list of packages
   - cat requirements_all.txt;

README.rst

@@ -1,6 +1,5 @@
 |Gitter| |PyPI badge| |Travis| |Documentation| |Codecov| |Coveralls| |Downloads|
 
-
 FISSA
 =====
 
@@ -33,16 +32,9 @@ general discussion and help with installation or setup, please see the
 
 Usage
 -----
+A general tutorial on the use of FISSA can be found `here <https://rochefort-lab.github.io/fissa/examples/Basic%20usage.html>`__.
 
-A general tutorial on the use of FISSA can be found at:
-https://rochefort-lab.github.io/fissa/examples/Basic%20usage.html
-
-An example workflow with another Python toolbox (SIMA):
-https://rochefort-lab.github.io/fissa/examples/SIMA%20example.html
-
-An example workflow importing data exported from a MATLAB toolbox
-(cNMF):
-https://rochefort-lab.github.io/fissa/examples/cNMF%20example.html
+We also provide example workflows with other Python toolboxes (`SIMA <https://rochefort-lab.github.io/fissa/examples/SIMA%20example.html>`__ and `Suite2p <https://rochefort-lab.github.io/fissa/examples/Suite2p%20example.html>`__), as well as for MATLAB (`cNMF <https://rochefort-lab.github.io/fissa/examples/cNMF%20example.html>`__).
 
 These notebooks can also be run on your own machine. To do so, you will
 need to `download a copy of the