Skip to content

Commit 2e21210

Browse files
committed
add citation and testing section in readme
1 parent 2818ab2 commit 2e21210

2 files changed

Lines changed: 35 additions & 1 deletion

File tree

README.md

Lines changed: 20 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -102,3 +102,23 @@ git checkout develop
102102
### Contributing
103103

104104
[Pull requests](https://github.com/fish-quant/sim-fish/pulls) are welcome. For major changes, please open an [issue](https://github.com/fish-quant/sim-fish/issues) first to discuss what you would like to change.
105+
106+
### Testing
107+
108+
Please make sure to update tests as appropriate if you open a pull request. You can install exacts dependencies and specific version of [pytest](https://docs.pytest.org/en/latest/) by running the following command:
109+
110+
```bash
111+
pip install -r requirements_dev.txt
112+
```
113+
114+
To perform unit tests, run :
115+
116+
```bash
117+
pytest simfish
118+
```
119+
120+
## Citation
121+
122+
If you exploit this package for your work, please cite:
123+
124+
> 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

docs/source/index.rst

Lines changed: 15 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -74,4 +74,18 @@ Support
7474
=======
7575

7676
If you have any question relative to the package, please open an `issue
77-
<https://github.com/fish-quant/sim-fish/issues>`_ on Github.
77+
<https://github.com/fish-quant/sim-fish/issues>`_ on Github.
78+
79+
------------
80+
81+
Citation
82+
========
83+
84+
If you exploit this package for your work, please cite:
85+
86+
.. code-block:: text
87+
88+
Arthur Imbert, Wei Ouyang, Adham Safieddine, Emeline Coleno, Christophe
89+
Zimmer, Edouard Bertrand, Thomas Walter, Florian Mueller. FISH-quant v2:
90+
a scalable and modular analysis tool for smFISH image analysis. bioRxiv
91+
(2021) https://doi.org/10.1101/2021.07.20.453024

0 commit comments

Comments
 (0)