|
a |
|
b/README.md |
|
|
1 |
|PyPI| |Downloads| |CI| |Pre-commit| |Codecov| |Docs| |
|
|
2 |
|
|
|
3 |
Moscot - Multiomics Single-cell Optimal Transport |
|
|
4 |
======================================================= |
|
|
5 |
|
|
|
6 |
.. image:: docs/_static/img/light_mode_concept_revised.png |
|
|
7 |
:width: 800px |
|
|
8 |
:align: center |
|
|
9 |
:class: only-light |
|
|
10 |
|
|
|
11 |
.. image:: docs/_static/img/dark_mode_concept_revised.png |
|
|
12 |
:width: 800px |
|
|
13 |
:align: center |
|
|
14 |
:class: only-dark |
|
|
15 |
|
|
|
16 |
|
|
|
17 |
**moscot** is a framework for Optimal Transport (OT) applications in |
|
|
18 |
single-cell genomics. It scales to large datasets and can be used for a |
|
|
19 |
variety of applications across different modalities. |
|
|
20 |
|
|
|
21 |
moscot's key applications |
|
|
22 |
--------------------------- |
|
|
23 |
- Trajectory inference (incorporating spatial and lineage information). |
|
|
24 |
- Mapping cells to their spatial organisation. |
|
|
25 |
- Aligning spatial transcriptomics slides. |
|
|
26 |
- Translating modalities. |
|
|
27 |
- prototyping of new OT models in single-cell genomics. |
|
|
28 |
- ... and more, check out the `documentation <https://moscot.readthedocs.io>`_ for more information. |
|
|
29 |
|
|
|
30 |
|
|
|
31 |
**moscot** is powered by |
|
|
32 |
`OTT <https://ott-jax.readthedocs.io>`_ which is a JAX-based Optimal |
|
|
33 |
Transport toolkit that supports just-in-time compilation, GPU acceleration, automatic |
|
|
34 |
differentiation and linear memory complexity for OT problems. |
|
|
35 |
|
|
|
36 |
Installation |
|
|
37 |
------------ |
|
|
38 |
Install **moscot** by running:: |
|
|
39 |
|
|
|
40 |
pip install moscot |
|
|
41 |
|
|
|
42 |
In order to install **moscot** from in editable mode, run:: |
|
|
43 |
|
|
|
44 |
git clone https://github.com/theislab/moscot |
|
|
45 |
cd moscot |
|
|
46 |
pip install -e . |
|
|
47 |
|
|
|
48 |
For further instructions how to install jax, please refer to https://github.com/google/jax. |
|
|
49 |
|
|
|
50 |
Citing moscot |
|
|
51 |
------------- |
|
|
52 |
If you find a model useful for your research, please consider citing the `Klein et al., 2025`_ manuscript as |
|
|
53 |
well as the publication introducing the model, which can be found in the corresponding documentation. |
|
|
54 |
|
|
|
55 |
.. |Codecov| image:: https://codecov.io/gh/theislab/moscot/branch/master/graph/badge.svg?token=Rgtm5Tsblo |
|
|
56 |
:target: https://codecov.io/gh/theislab/moscot |
|
|
57 |
:alt: Coverage |
|
|
58 |
|
|
|
59 |
.. |PyPI| image:: https://img.shields.io/pypi/v/moscot.svg |
|
|
60 |
:target: https://pypi.org/project/moscot/ |
|
|
61 |
:alt: PyPI |
|
|
62 |
|
|
|
63 |
.. |CI| image:: https://img.shields.io/github/actions/workflow/status/theislab/moscot/test.yml?branch=main |
|
|
64 |
:target: https://github.com/theislab/moscot/actions |
|
|
65 |
:alt: CI |
|
|
66 |
|
|
|
67 |
.. |Pre-commit| image:: https://results.pre-commit.ci/badge/github/theislab/moscot/main.svg |
|
|
68 |
:target: https://results.pre-commit.ci/latest/github/theislab/moscot/main |
|
|
69 |
:alt: pre-commit.ci status |
|
|
70 |
|
|
|
71 |
.. |Docs| image:: https://img.shields.io/readthedocs/moscot |
|
|
72 |
:target: https://moscot.readthedocs.io/en/stable/ |
|
|
73 |
:alt: Documentation |
|
|
74 |
|
|
|
75 |
.. |Downloads| image:: https://static.pepy.tech/badge/moscot |
|
|
76 |
:target: https://pepy.tech/project/moscot |
|
|
77 |
:alt: Downloads |
|
|
78 |
|
|
|
79 |
.. _Klein et al., 2025: https://www.nature.com/articles/s41586-024-08453-2 |