Sim-FISH

Getting started

To avoid dependency conflicts, we recommend the the use of a dedicated virtual or conda environment. In a terminal run the command:

$ conda create -n simfish_env python=3.6
$ source activate simfish_env

We recommend two options to then install Sim-FISH in your virtual environment.

Download the package from PyPi

Use the package manager pip to install Sim-FISH. In a terminal run the command:

$ pip install sim-fish

Clone package from Github

Clone the project’s Github repository and install it manually with the following commands:

$ git clone git@github.com:fish-quant/sim-fish.git
$ cd sim-fish
$ pip install .

---

API reference

Simulations

• Image simulation
• Pattern simulation
• Utility functions

---

Support

If you have any question relative to the package, please open an issue on Github.

---

Citation

If you exploit this package for your work, please cite:

Arthur Imbert, Wei Ouyang, Adham Safieddine, Emeline Coleno, Christophe
Zimmer, Edouard Bertrand, Thomas Walter, Florian Mueller. FISH-quant v2:
a scalable and modular analysis tool for smFISH image analysis. bioRxiv
(2021) https://doi.org/10.1101/2021.07.20.453024