Sovereign 8s.is mirror of standardgalactic/Cassiopeia
  • Python 97.8%
  • Cython 1.2%
  • C++ 1%
Find a file
Repository files (latest commit first)
Filename Latest commit message Latest commit date
mgjones 1ee5959eb9
Some checks failed
cassiopeia / build (3.10) (push) Has been cancelled
cassiopeia / build (3.11) (push) Has been cancelled
cassiopeia / build (3.12) (push) Has been cancelled
updated sphinx version pins
2026-02-05 14:46:32 -05:00
.github/workflows updated versions to test 2025-07-25 16:01:07 -07:00
cassiopeia reverted back to try-except logic (code with simpler logic commented out) because get_tree_topology() does not return None if there is no tree 2025-10-08 19:10:27 -04:00
data updated ccphylo config and gitignore 2023-10-10 11:56:09 -07:00
docs updated python versions, name of spatial imputation 2025-07-25 15:31:14 -07:00
notebooks added data availability link to spatial tutorial 2026-02-05 13:14:35 -05:00
test added test function for tree without character matrix, with test for if dissimilarity map is still copied. added a commented-out test function for cassiopeia tree defined without a tree - get_tree_topology() raises error 2025-10-08 19:14:23 -04:00
.gitattributes attrs file so that codebase registers as python, not ipynb 2022-02-03 11:12:57 -08:00
.gitignore bumped version to 2.1.0 2024-10-24 16:03:04 -04:00
.readthedocs.yml updated readthedocs.yml 2026-02-05 14:35:44 -05:00
AUTHORS.rst updated authors, include ecos as an install dependency 2025-07-22 15:58:27 -07:00
build.py move to poetry 2022-02-03 16:31:33 -08:00
codecov.yml added coverage reports 2021-08-03 17:55:57 -07:00
conftest.py added python 3.11 compatability 2024-10-24 15:36:07 -04:00
CONTRIBUTING.rst updated moc imports in docs 2023-08-28 16:28:03 -07:00
LICENSE pruned neighborhoods, updated missing data handling in greedy, alternative solutions & lca distance criteria for hybrid 2020-01-08 10:36:44 -08:00
Makefile update makefile 2022-02-03 19:04:47 -08:00
MANIFEST.in update gitignore and MANIFEST 2022-01-14 10:53:04 -08:00
pyproject.toml updated sphinx version pins 2026-02-05 14:46:32 -05:00
README.md updated readme 2025-07-22 15:59:44 -07:00
setup.py remove old setup py 2022-02-03 17:33:48 -08:00
version.py changed sphinx thumbnail css 2021-07-30 16:10:20 -07:00

cassiopeia

Stars Documentation Status Build
Status Coverage

Cassiopeia: A pipeline for single-cell lineage tracing data

Cassiopeia is an end-to-end pipeline for single-cell lineage tracing experiments. The software contained here comes equipped with modules for processing sequencing reads, reconstructing & plotting trees, analyzing these trees, and benchmarking new algorithms.

You can find all of our documentation here.

We also have provided tutorials for three modules:

You can also find our originally describing Cassiopeia published in Genome Biology.

Free Software: MIT License

Installation

For users:

pip install git+https://github.com/YosefLab/Cassiopeia@master#egg=cassiopeia-lineage

For developers:

  1. Clone the package as so: git clone https://github.com/YosefLab/Cassiopeia.git

  2. Ensure that you have Python >= 3.10 installed. (Due to dependencies and ongoing updates to Python, we will not guarantee support for python <= 3.9) We prefer using miniconda.

  3. [Optional] If you intend to use the CassiopeiaILP solver, please be sure that Gurobi is installed. You can follow the instructions listed here. To verify that it's working correctly, use the following tests:

    • Run the command gurobi.sh from a terminal window
    • From the Gurobi installation directory (where there is a setup.py file), use python setup.py install --user
  4. [Optional] To use fast versions of Neighbor-Joining and UPGMA, install CCPhylo. Then copy the file ./data/ccphylo_config.ini to your ./cassiopeia directory, rename it config.ini and set the Path variable to point to your CCPhylo installation.

  5. Install Cassiopeia by first changing into the Cassiopeia directory and then pip3 install . or make install. To install dev and docs requirements, you can run pip3 install .[dev,docs].

  6. [Optional] To use tools built for the analysis of spatial lineage tracing datasets, you can install Cassiopeia with pip install .[spatial]. Please note that we recommend using Python >= 3.9 for these analyses as some features might not be available otherwise, due to package dependencies (especially 3D visualization).

To verify that it installed correctly, install pytest (pip install pytest) and try running our tests with make test.

Reference

If you've found Cassiopeia useful for your research, please consider citing our paper published in Genome Biology:

Matthew G Jones*, Alex Khodaverdian*, Jeffrey J Quinn*, Michelle M Chan, Jeffrey A Hussmann, Robert Wang, Chenling Xu, Jonathan S Weissman, Nir Yosef. (2020), Inference of single-cell phylogenies from lineage tracing data using Cassiopeia, Genome Biology