Skip to main content

Harissa 🌶

PyPI - Version Conda - Version

This is a Python package for both simulation and inference of gene regulatory networks from single-cell data. Its name comes from ‘HARtree approximation for Inference along with a Stochastic Simulation Algorithm.’ It is implemented in the context of a mechanistic approach to gene regulatory network inference from single-cell data, based upon an underlying stochastic dynamical model driven by the transcriptional bursting phenomenon.

Main functionalities:

  1. Network inference interpreted as calibration of a dynamical model;
  2. Data simulation (typically scRNA-seq) from the same dynamical model.

Other available tools:

  • Basic GRN visualization (directed graphs with positive or negative edge weights);
  • Binarization of scRNA-seq data (using gene-specific thresholds derived from the calibrated dynamical model).

The current version of Harissa has benefited from improvements introduced within Cardamom, which can be seen as an alternative method for the inference part. The two inference methods remain complementary at this stage and may be merged into the same package in the future. They were both evaluated in a recent benchmark.

Installation

Harissa can be installed using pip:

pip install harissa

This command will also check for all required dependencies (see below) and install them if necessary. If the installation is successful, all scripts in the tests folder should run smoothly (note that network4.py must be run before test_binarize.py).

Basic usage

from harissa import NetworkModel
model = NetworkModel()

# Inference
model.fit(data)

# Simulation
sim = model.simulate(time)

Here data should be a two-dimensional array of single-cell gene expression counts, where each row represents a cell and each column represents a gene, except for the first column, which contains experimental time points. A toy example is:

import numpy as np

data = np.array([
    #t g1 g2 g3
    [0, 4, 1, 0], # Cell 1
    [0, 5, 0, 1], # Cell 2
    [1, 1, 2, 4], # Cell 3
    [1, 2, 0, 8], # Cell 4
    [1, 0, 0, 3], # Cell 5
])

The time argument for simulations is either a single time or a list of time points. For example, a single-cell trajectory (not available from scRNA-seq) from t = 0h to t = 10h can be simulated using:

time = np.linspace(0, 10, 1000)

The sim output stores mRNA and protein levels as attributes sim.m and sim.p, respectively (each row is a time point and each column is a gene).

About the data

The inference algorithm specifically exploits time-course data, where single-cell profiling is performed at a number of time points after a stimulus (see this paper for an example with real data). Each group of cells collected at the same experimental time tk forms a snapshot of the biological heterogeneity at time tk. Due to the destructive nature of the measurement process, successive snapshots are made of different cells. Such data is therefore different from so-called ‘pseudotime’ trajectories, which attempt to reorder cells according to some smoothness hypotheses.

Tutorial

Please see the notebooks for introductory examples, or the tests folder for basic usage scripts. To get an idea of the main features, you can start by running the notebooks in order:

  • Notebook 1: simulate a basic repressilator network with 3 genes;
  • Notebook 2: perform network inference from a small dataset with 4 genes;
  • Notebook 3: compare two branching pathways with 4 genes from both ‘single-cell’ and ‘bulk’ viewpoints.

Numerical acceleration

# Inference
model.fit(data, use_numba=True)

# Simulation
sim = model.simulate(time, use_numba=True)

The use_numba option is not activated by default for simulations since it takes time to compile (~8s) but it is then much more efficient (~20 times faster) which is typically suited for large numbers of genes and/or cells.

Dependencies

The package depends on standard scientific libraries numpy and scipy. Optionally, it can load numba for accelerating the inference procedure (used by default) and the simulation procedure (not used by default). It also depends optionally on matplotlib and networkx for network visualization.

Citation

If you use Harissa in your work, please cite this paper (also available on arXiv).

Metadata

Release files for harissa 3.1.2

For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.

Source distribution (sdist)

Source distribution for harissa 3.1.2
File Size Uploaded
harissa-3.1.2.tar.gz 28.2 kB Details

Built distribution (wheel)

Table of built distributions (wheels) for harissa 3.1.2
File Interpreter ABI Platform
harissa-3.1.2-py3-none-any.whl Python 3 none any Details

Total release size: 56.6 kB

Release files / harissa-3.1.2.tar.gz

Download URL harissa-3.1.2.tar.gz
Size 28.2 kB
Tags Source
SHA-256 checksum
How to use checksums
16185ae583a86d8a93c0337b16fd959a2d8fcf9e64e30d4916b2786986c500a6
BLAKE2b-256 checksum
How to use checksums
79cbc7da33bd685cc37c2372bdb31136418773d49ece4aaaf60613e3693ddfe6
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
Yes
Uploaded via twine/6.1.0 CPython/3.12.9

Provenance

Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.

PyPI Publish Attestation

PyPI verified that this artifact, at this checksum, originated from the publisher listed below.

Signed by GitHub Actions, verified by PyPI on Mar 17, 2025.

Transparency log

Release files / harissa-3.1.2-py3-none-any.whl

Download URL harissa-3.1.2-py3-none-any.whl
Size 28.4 kB
Tags Python 3
SHA-256 checksum
How to use checksums
f5b2362b0be0e81a1d35e65d5ff6ef13aae47e02337d8eb7759b442f40174123
BLAKE2b-256 checksum
How to use checksums
cbdd44d1401e522c999b8d6f69c798d77cb8e925682de3761434aa5504f1bfcc
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
Yes
Uploaded via twine/6.1.0 CPython/3.12.9

Provenance

Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.

PyPI Publish Attestation

PyPI verified that this artifact, at this checksum, originated from the publisher listed below.

Signed by GitHub Actions, verified by PyPI on Mar 17, 2025.

Transparency log
Anthropic, PBC Visionary sponsor Bloomberg Visionary sponsor Hudson River Trading Visionary sponsor Meta Visionary sponsor NVIDIA Visionary sponsor Microsoft Sustainability sponsor Depot Continuous Integration AWS Cloud computing and Security Sponsor Datadog Monitoring Fastly CDN Google Download Analytics Sentry Error logging StatusPage Status page