Skip to content

Commit

Permalink
add citation
Browse files Browse the repository at this point in the history
  • Loading branch information
niklasmueboe committed Aug 5, 2024
1 parent 0890ead commit 7ed4395
Show file tree
Hide file tree
Showing 3 changed files with 19 additions and 11 deletions.
6 changes: 6 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -36,6 +36,12 @@ This project follows the [SemVer](https://semver.org/) guidelines for versioning

## Citations

If you are using `sainsc` for your research please cite

Müller-Bötticher, N., Tiesmeyer, S., Eils, R., and Ishaque, N.
"Sainsc: a computational tool for segmentation-free analysis of in-situ capture"
bioRxiv (2024) https://doi.org/10.1101/2024.08.02.603879

## License

This project is licensed under the MIT License - for details please refer to the
Expand Down
10 changes: 7 additions & 3 deletions docs/source/index.rst
Original file line number Diff line number Diff line change
Expand Up @@ -10,10 +10,14 @@ It is easily integratable with the `scverse <https://github.com/scverse>`_
`AnnData <https://anndata.readthedocs.io/>`_ or
`SpatialData <https://spatialdata.scverse.org/>`_ format.

.. Citations
.. ---------
Citations
---------

.. tbd
If you are using `sainsc` for your research please cite

Müller-Bötticher, N., Tiesmeyer, S., Eils, R., and Ishaque, N.
"Sainsc: a computational tool for segmentation-free analysis of in-situ capture"
bioRxiv (2024) https://doi.org/10.1101/2024.08.02.603879

.. toctree::
:maxdepth: 1
Expand Down
14 changes: 6 additions & 8 deletions docs/source/installation.rst
Original file line number Diff line number Diff line change
Expand Up @@ -5,19 +5,17 @@ Installation
PyPI and ``pip``
----------------

``sainsc`` will soon be available to install from `PyPI <https://pypi.org/>`_.
To install ``sainsc`` from `PyPI <https://pypi.org/>`_ using ``pip`` just run

.. To install ``sainsc`` from `PyPI <https://pypi.org/>`_ using ``pip`` just run
.. .. code-block:: bash
.. code-block:: bash
.. pip install sainsc
pip install sainsc
.. If you want to have support for :py:mod:`spatialdata` use
If you want to have support for :py:mod:`spatialdata` use

.. .. code-block:: bash
.. code-block:: bash
.. pip install 'sainsc[spatialdata]'
pip install sainsc[spatialdata]
Bioconda and ``conda``
Expand Down

0 comments on commit 7ed4395

Please sign in to comment.