Skip to content

Commit

Permalink
Fix codeblocks in docs
Browse files Browse the repository at this point in the history
  • Loading branch information
jules-samaran committed Feb 29, 2024
1 parent 8b4b319 commit b975d4a
Showing 1 changed file with 14 additions and 0 deletions.
14 changes: 14 additions & 0 deletions docs/source/index.rst
Original file line number Diff line number Diff line change
Expand Up @@ -7,15 +7,25 @@ Welcome to scConfluence's documentation!
========================================

.. toctree::
:hidden:
:maxdepth: 1
:glob:
:caption: Tutorials

tutorials/*.ipynb

.. toctree::
:hidden:
:maxdepth: 3
:caption: API

model
unimodal
base_module
nn
distributions
dataset_utils

scConfluence is a novel method for the integration of unpaired multiomics data combining
uncoupled autoencoders and Inverse Optimal Transport to learn low-dimensional cell
embeddings. These embeddings can then be used for visualization and clustering, useful
Expand All @@ -41,13 +51,15 @@ Installation should typically take a minute and is continuously tested with Pyth
on an Ubuntu virtual machine.

.. code-block:: bash
pip install scconfluence
via GitHub (development version)
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^

.. code-block:: bash
git clone git@github.com:cantinilab/scconfluence.git
cd scconfluence
pip install .
Expand All @@ -57,6 +69,7 @@ Test your development installation (optional)
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^

.. code-block:: bash
pip install pytest
pytest .
Expand All @@ -71,6 +84,7 @@ You may download a preprocessed 10X Multiome demo dataset `here <https://figshar
A GPU is not required for the method to run, but is strongly recommended.

.. code-block:: python
import scconfluence
import mudata as md
import scanpy as sc
Expand Down

0 comments on commit b975d4a

Please sign in to comment.