Usage
=====

.. _installation:

Installation
------------

To use MultiVeloVAE, first install it using pip:

.. code-block:: console

   $ pip install multivelovae


Examples
--------

The example notebooks of running the mouse brain and HSPC datasets are located in `paper-notebooks <https://github.com/welch-lab/MultiVeloVAE/tree/main/paper-notebooks>`_.
Processed AnnData objects are shared directly through `figshare <https://figshare.com/articles/dataset/Post-processed_anndata_objects_for_MultiVeloVAE/30280333>`_.
Expected runtimes using RTX3060-level graphics cards can be found inside each notebook.

`This file <https://github.com/welch-lab/MultiVeloVAE/blob/main/paper-notebooks/reproducible_package_versions.txt>`_ lists the versions of packages used to generate manuscript figures.