Skip to content

Commit

Permalink
Update README.md
Browse files Browse the repository at this point in the history
  • Loading branch information
fdsteffen authored Oct 28, 2024
1 parent 0cf5a2a commit f92f295
Showing 1 changed file with 5 additions and 22 deletions.
27 changes: 5 additions & 22 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -16,41 +16,24 @@ PAMtools is documented [here](https://fdsteffen.github.io/PAMtools/).
Download and install
--------------------

1. Make sure that you have Matlab (including the curvefit and Statistics and machine Learning toolbox installed).
1. Make sure that you have Matlab (including the curvefit and Statistics and machine Learning toolbox installed). **MatPAM** uses the function `jsonencode()` and therefore requires Matlab 2016b (9.1) or newer

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.
3. Clone PAMtools into a directory of your choice.
```
git clone https://github.com/fdsteffen/PAMtools.git
```

- Add the **MatPAM** folder to the Matlab search path
- Install the **PyPAM** module via pip
```
pip install --user git+https://github.com/fdsteffen/PAMtools.git
or
pip install --user -e <path/to/PAMtools>
pip install .
```

4. Copy the file in `matpam/profiles/profile PIE.mat`` into the profiles directory in PAM.
4. Copy the file in `src/pamtools/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
------------

- **MatPAM** uses the function `jsonencode()` and therefore requires Matlab 2016b (9.1) or newer

- **PyPAM** depends on the following Python packages:

- numpy
- scipy
- pandas
- matplotlib
- seaborn
- uncertainties
- naturalcolors (get it from [here](https://github.com/fdsteffen/naturalcolors.git))
5. Copy the FCS models in `src/pamtools/matpam/models` to the Models directory in PAM

---
<sup><a name="pymol">1</a></sup> W. Schrimpf, A. Barth, J. Hendrix, D.C. Lamb, *Biophys. J.* **2018**, *114*, 1518–1528. [![](https://img.shields.io/badge/DOI-10.1016/j.bpj.2018.02.035-blue.svg)](https://doi.org/10.1016/j.bpj.2018.02.035)

0 comments on commit f92f295

Please sign in to comment.