Skip to content

Commit

Permalink
update readme (#791)
Browse files Browse the repository at this point in the history
* update readme

* formatting

* link, version in contributing

* [pre-commit.ci] auto fixes from pre-commit.com hooks

for more information, see https://pre-commit.ci

* precommit fix

---------

Co-authored-by: Arina Danilina <[email protected]>
Co-authored-by: pre-commit-ci[bot] <66853113+pre-commit-ci[bot]@users.noreply.github.com>
  • Loading branch information
3 people authored Jan 28, 2025
1 parent ba76392 commit d90db30
Show file tree
Hide file tree
Showing 3 changed files with 35 additions and 33 deletions.
49 changes: 31 additions & 18 deletions README.rst
Original file line number Diff line number Diff line change
@@ -1,16 +1,32 @@
|PyPI| |Downloads| |CI| |Pre-commit| |Codecov| |Docs|

moscot - multi-omic single-cell optimal transport tools
Moscot - Multiomics Single-cell Optimal Transport
=======================================================

**moscot** is a scalable framework for Optimal Transport (OT) applications in
single-cell genomics. It can be used for
.. image:: docs/_static/img/light_mode_concept_revised.png
:width: 800px
:align: center
:class: only-light

.. image:: docs/_static/img/dark_mode_concept_revised.png
:width: 800px
:align: center
:class: only-dark


**moscot** is a framework for Optimal Transport (OT) applications in
single-cell genomics. It scales to large datasets and can be used for a
variety of applications across different modalities.

moscot's key applications
---------------------------
- Trajectory inference (incorporating spatial and lineage information).
- Mapping cells to their spatial organisation.
- Aligning spatial transcriptomics slides.
- Translating modalities.
- prototyping of new OT models in single-cell genomics.
- ... and more, check out the `documentation <https://moscot.readthedocs.io>`_ for more information.

- trajectory inference (incorporating spatial and lineage information)
- mapping cells to their spatial organisation
- aligning spatial transcriptomics slides
- translating modalities
- prototyping of new OT models in single-cell genomics

**moscot** is powered by
`OTT <https://ott-jax.readthedocs.io>`_ which is a JAX-based Optimal
Expand All @@ -19,7 +35,7 @@ differentiation and linear memory complexity for OT problems.

Installation
------------
You can install **moscot** via::
Install :mod:`moscot` by running::

pip install moscot

Expand All @@ -31,15 +47,10 @@ In order to install **moscot** from in editable mode, run::

For further instructions how to install jax, please refer to https://github.com/google/jax.

Resources
---------

Please have a look at our `documentation <https://moscot.readthedocs.io>`_

Reference
---------

Our preprint "Mapping cells through time and space with moscot" can be found `here <https://www.biorxiv.org/content/10.1101/2023.05.11.540374v1>`_.
Citing moscot
-------------
If you find a model useful for your research, please consider citing the `Klein et al., 2025`_ manuscript as
well as the publication introducing the model, which can be found in the corresponding documentation.

.. |Codecov| image:: https://codecov.io/gh/theislab/moscot/branch/master/graph/badge.svg?token=Rgtm5Tsblo
:target: https://codecov.io/gh/theislab/moscot
Expand All @@ -64,3 +75,5 @@ Our preprint "Mapping cells through time and space with moscot" can be found `he
.. |Downloads| image:: https://static.pepy.tech/badge/moscot
:target: https://pepy.tech/project/moscot
:alt: Downloads

.. _Klein et al., 2025: https://www.nature.com/articles/s41586-024-08453-2
17 changes: 3 additions & 14 deletions docs/contributing.rst
Original file line number Diff line number Diff line change
Expand Up @@ -9,8 +9,6 @@ Table of Contents
- `Testing`_
- `Writing documentation`_
- `Writing tutorials/examples`_
- `Making a new release`_
- `Creating release notes`_
- `Submitting a PR`_

Contributing to moscot
Expand Down Expand Up @@ -81,7 +79,7 @@ Testing
-------
We use ``tox`` to automate our testing, as well as linting and documentation creation. To run the tests, run::

tox -e py{38,39,310,311}-{linux,macos}
tox -e py{310,311}-{linux,macos}

depending on the Python version(s) in your ``PATH`` and your operating system. We use ``flake8`` and ``mypy`` to further
analyze the code. Use ``# noqa: <error1>,<error2>`` to ignore certain ``flake8`` errors and
Expand All @@ -94,7 +92,7 @@ To run only a subset of tests, run::
where ``<name>`` can be a path to a test file/directory or a name of a test function/class.
For example, to run only the tests in the ``plotting`` module, use::

tox -e py39-linux -- tests/plotting/test_plotting.py
tox -e py310-linux -- tests/plotting/test_plotting.py

If needed, a specific ``tox`` environment can be recreated as::

Expand Down Expand Up @@ -142,13 +140,4 @@ Before submitting a new pull request, please make sure you followed these instru
- make sure that all tests pass locally (see `Testing`_).
- if there is no issue which this PR solves, create a new `one <https://github.com/theislab/moscot/issues/new>`_
briefly explaining what the problem is.
- make sure that the section under ``## Description`` is properly formatted if automatically generating release notes,
see also `Creating release notes`_.

Making a new release
--------------------
TODO

Creating release notes
----------------------
TODO
- make sure that the section under ``## Description`` is properly formatted if automatically generating release notes.
2 changes: 1 addition & 1 deletion docs/index.rst
Original file line number Diff line number Diff line change
Expand Up @@ -15,7 +15,7 @@ Moscot - Multiomics Single-cell Optimal Transport
:class: only-dark

:mod:`moscot` is a framework for Optimal Transport (OT) applications in
single-cell genomics. It scales to large datsets and can be used for a
single-cell genomics. It scales to large datasets and can be used for a
variety of applications across different modalities.

Key applications
Expand Down

0 comments on commit d90db30

Please sign in to comment.