|
a |
|
b/docs/index.rst |
|
|
1 |
|PyPI| |Downloads| |CI| |Pre-commit| |Codecov| |Docs| |
|
|
2 |
|
|
|
3 |
Moscot - Multiomics Single-cell Optimal Transport |
|
|
4 |
================================================= |
|
|
5 |
.. module:: moscot |
|
|
6 |
|
|
|
7 |
.. image:: _static/img/light_mode_concept_revised.png |
|
|
8 |
:width: 800px |
|
|
9 |
:align: center |
|
|
10 |
:class: only-light |
|
|
11 |
|
|
|
12 |
.. image:: _static/img/dark_mode_concept_revised.png |
|
|
13 |
:width: 800px |
|
|
14 |
:align: center |
|
|
15 |
:class: only-dark |
|
|
16 |
|
|
|
17 |
:mod:`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 |
Key applications |
|
|
22 |
---------------- |
|
|
23 |
- :doc:`Trajectory inference <notebooks/tutorials/200_temporal_problem>` |
|
|
24 |
(incorporating :doc:`spatial <notebooks/tutorials/500_spatiotemporal>` |
|
|
25 |
and :doc:`lineage <notebooks/tutorials/100_lineage>` information). |
|
|
26 |
- :doc:`Mapping <notebooks/tutorials/400_spatial_mapping>` cells to their spatial organisation. |
|
|
27 |
- :doc:`Aligning <notebooks/tutorials/300_spatial_alignment>` spatial transcriptomics slides. |
|
|
28 |
- :doc:`Translating <notebooks/tutorials/600_tutorial_translation>` modalities. |
|
|
29 |
- ... and more, check out the :doc:`user guide <user_guide>` for more information. |
|
|
30 |
|
|
|
31 |
Getting started |
|
|
32 |
---------------- |
|
|
33 |
- Read the :doc:`user guide <user_guide>` to get a high-level overview of :mod:`moscot`. |
|
|
34 |
- Take a look at our :doc:`tutorials <notebooks/tutorials/index>` to learn how to use :mod:`moscot` for data analysis. |
|
|
35 |
- For more technical examples and specific use cases, check out the :doc:`examples <notebooks/examples/index>` section. |
|
|
36 |
- To see :mod:`moscot` in action, read our `Klein et al., 2025`_ manuscript. |
|
|
37 |
- For a high-level introduction of moscot, check out our `research briefing <https://doi.org/10.1038/d41586-025-00107-1>`_. |
|
|
38 |
|
|
|
39 |
Citing moscot |
|
|
40 |
------------- |
|
|
41 |
If you find a model useful for your research, please consider citing the `Klein et al., 2025`_ manuscript as |
|
|
42 |
well as the publication introducing the model, which can be found in the corresponding documentation. |
|
|
43 |
|
|
|
44 |
Important resources |
|
|
45 |
------------------- |
|
|
46 |
.. grid:: 3 |
|
|
47 |
:gutter: 1 |
|
|
48 |
|
|
|
49 |
.. grid-item-card:: Installation |
|
|
50 |
:link: installation |
|
|
51 |
:link-type: doc |
|
|
52 |
|
|
|
53 |
Learn how to install :mod:`moscot`. |
|
|
54 |
|
|
|
55 |
.. grid-item-card:: User API |
|
|
56 |
:link: user/index |
|
|
57 |
:link-type: doc |
|
|
58 |
|
|
|
59 |
Find a detailed documentation of :mod:`moscot`. |
|
|
60 |
|
|
|
61 |
.. grid-item-card:: Contributing |
|
|
62 |
:link: contributing |
|
|
63 |
:link-type: doc |
|
|
64 |
|
|
|
65 |
Add a functionality or report a bug. |
|
|
66 |
|
|
|
67 |
.. grid-item-card:: Examples |
|
|
68 |
:link: notebooks/examples/index |
|
|
69 |
:link-type: doc |
|
|
70 |
|
|
|
71 |
Find brief and concise examples of :mod:`moscot`. |
|
|
72 |
|
|
|
73 |
.. grid-item-card:: Tutorials |
|
|
74 |
:link: notebooks/tutorials/index |
|
|
75 |
:link-type: doc |
|
|
76 |
|
|
|
77 |
Check out how to use :mod:`moscot` for data analysis. |
|
|
78 |
|
|
|
79 |
.. grid-item-card:: Manuscript |
|
|
80 |
|
|
|
81 |
Please have a look at `Klein et al., 2025`_ to learn more. |
|
|
82 |
|
|
|
83 |
.. toctree:: |
|
|
84 |
:maxdepth: 2 |
|
|
85 |
:hidden: |
|
|
86 |
|
|
|
87 |
installation |
|
|
88 |
user_guide |
|
|
89 |
user/index |
|
|
90 |
developer/index |
|
|
91 |
ot_background |
|
|
92 |
notebooks/tutorials/index |
|
|
93 |
notebooks/examples/index |
|
|
94 |
contributing |
|
|
95 |
references |
|
|
96 |
|
|
|
97 |
|
|
|
98 |
.. |Codecov| image:: https://codecov.io/gh/theislab/moscot/branch/master/graph/badge.svg?token=Rgtm5Tsblo |
|
|
99 |
:target: https://codecov.io/gh/theislab/moscot |
|
|
100 |
:alt: Coverage |
|
|
101 |
|
|
|
102 |
.. |PyPI| image:: https://img.shields.io/pypi/v/moscot.svg |
|
|
103 |
:target: https://pypi.org/project/moscot/ |
|
|
104 |
:alt: PyPI |
|
|
105 |
|
|
|
106 |
.. |CI| image:: https://img.shields.io/github/actions/workflow/status/theislab/moscot/test.yml?branch=main |
|
|
107 |
:target: https://github.com/theislab/moscot/actions |
|
|
108 |
:alt: CI |
|
|
109 |
|
|
|
110 |
.. |Pre-commit| image:: https://results.pre-commit.ci/badge/github/theislab/moscot/main.svg |
|
|
111 |
:target: https://results.pre-commit.ci/latest/github/theislab/moscot/main |
|
|
112 |
:alt: pre-commit.ci status |
|
|
113 |
|
|
|
114 |
.. |Docs| image:: https://img.shields.io/readthedocs/moscot |
|
|
115 |
:target: https://moscot.readthedocs.io/en/stable/ |
|
|
116 |
:alt: Documentation |
|
|
117 |
|
|
|
118 |
.. |Downloads| image:: https://static.pepy.tech/badge/moscot |
|
|
119 |
:target: https://pepy.tech/project/moscot |
|
|
120 |
:alt: Downloads |
|
|
121 |
|
|
|
122 |
.. _Klein et al., 2025: https://www.nature.com/articles/s41586-024-08453-2 |