Update installation instructions

RNA-FRETools · Oct 28, 2023 · 5124d6f · 5124d6f
1 parent 0c81982
commit 5124d6f
Show file tree

Hide file tree

Showing 5 changed files with 18 additions and 2 deletions.
diff --git a/README.md b/README.md
@@ -16,7 +16,11 @@ PAMtools is documented [here](https://fdsteffen.github.io/PAMtools/).
 Download and install
 --------------------
 
-Clone or [download](https://github.com/fdsteffen/PAMtools/archive/master.zip) PAMtools into a directory of your choice.
+1. Make sure that you have Matlab (including the curvefit and Statistics and machine Learning toolbox installed).
+
+2. Install [PAM](https://gitlab.com/PAM-PIE/PAM)
+
+3. Clone or [download](https://github.com/fdsteffen/PAMtools/archive/master.zip) PAMtools into a directory of your choice.
 ```
 git clone https://github.com/fdsteffen/PAMtools.git
 ```
@@ -29,6 +33,10 @@ or
 pip install --user -e <path/to/PAMtools>
 ```
 
+4. Copy the file in `matpam/profiles/profile PIE.mat`` into the profiles directory in PAM.
+
+5. Copy the FCS models in `matpam/models` to the Models directory in PAM
+
 Dependencies
 ------------
 

diff --git a/docs/source/README.rst b/docs/source/README.rst
@@ -13,7 +13,11 @@ PAMtools is a set of helper functions written in Matlab and Python to export and
 Download and install
 --------------------
 
-Clone or :download:`download <https://github.com/fdsteffen/PAMtools/archive/master.zip>` PAMtools into a directory of your choice. ::
+1. Make sure that you have Matlab (including the curvefit and Statistics and machine Learning toolbox installed).
+
+2. Install [PAM](https://gitlab.com/PAM-PIE/PAM)
+
+3. Clone or :download:`download <https://github.com/fdsteffen/PAMtools/archive/master.zip>` PAMtools into a directory of your choice. ::
 
     git clone https://github.com/fdsteffen/PAMtools.git
 
@@ -22,6 +26,10 @@ Clone or :download:`download <https://github.com/fdsteffen/PAMtools/archive/mast
 
     pip install <path/to/PAMtools>
 
+4. Copy the file in `matpam/profiles/profile PIE.mat`` into the profiles directory in PAM.
+
+5. Copy the FCS models in `matpam/models` to the Models directory in PAM
+
 
 Dependencies
 ------------

diff --git a/docs/source/_static/extract_2Dplot.PNG → docs/source/_static/extract_2Dplot.png b/docs/source/_static/extract_2Dplot.PNG → docs/source/_static/extract_2Dplot.png
diff --git a/docs/source/_static/extract_timetrace.PNG → docs/source/_static/extract_timetrace.png b/docs/source/_static/extract_timetrace.PNG → docs/source/_static/extract_timetrace.png
diff --git a/docs/source/_static/write_FCS.PNG → docs/source/_static/write_FCS.png b/docs/source/_static/write_FCS.PNG → docs/source/_static/write_FCS.png