.. scTimeBench documentation master file, created by
   sphinx-quickstart on Thu Mar 19 11:24:54 2026.
   You can adapt this file completely to your liking, but it should at least
   contain the root `toctree` directive.

scTimeBench Documentation
=========================

.. raw:: html

   <p>
      <a href="https://www.python.org/downloads/release/python-31012/">
         <img src="https://img.shields.io/badge/Python-3.10%2B-blue.svg?logo=python&style=flat-square" alt="Python 3.10+" />
      </a>
      <a href="https://opensource.org/license/mit">
         <img src="https://img.shields.io/badge/License-MIT-blue.svg?style=flat-square" alt="MIT License" />
      </a>
      <a href="https://www.biorxiv.org/content/10.64898/2026.03.16.712069v1">
         <img src="https://img.shields.io/badge/bioRXiv-10.64898/2026.03.16.712069v1-red.svg?style=flat-square" alt="bioRxiv preprint" />
      </a>
      <a href="https://colab.research.google.com/drive/1J-yNXu_FcSnhrCwTDQKjWCBSHsmdbohJ?usp=sharing">
         <img src="https://img.shields.io/badge/Google-Colab-orange?logo=googlecolab&style=flat-square" alt="Google Colab" />
      </a>
      <a href="https://github.com/li-lab-mcgill/scTimeBench/actions/workflows/ci-install.yml">
         <img src="https://github.com/li-lab-mcgill/scTimeBench/actions/workflows/ci-install.yml/badge.svg" alt="Install" />
      </a>
      <a href="https://pypi.org/project/scTimeBench/">
         <img src="https://img.shields.io/pypi/v/scTimeBench.svg?logo=pypi&style=flat-square" alt="Pypi" />
      </a>
      </a>
      <a href="https://doi.org/10.5281/zenodo.19196641">
         <img src="https://zenodo.org/badge/DOI/10.5281/zenodo.19196641.svg" alt="DOI" />
      </a>
   </p>

Welcome to the scTimeBench documentation!

This project provides a comprehensive benchmarking suite for single cell time series methods. You will find detailed information on how to run the benchmark and how to extend it with new methods, metrics and datasets.


.. toctree::
   :maxdepth: 2
   :caption: Contents

   setup
   base_run
   leaderboard
   data_contrib
   metric_contrib
   method_contrib
   api



TODO
* Update documentation for sqlite database management and csv extraction.