1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374
//! rebop is a fast stochastic simulator for well-mixed chemical
//! reaction networks.
//!
//! Performance and ergonomics are taken very seriously. For this reason,
//! two independent APIs are provided to describe and simulate reaction
//! networks:
//!
//! * a macro-based DSL implemented by [`define_system`], usually the
//! most efficient, but that requires to compile a rust program;
//! * a function-based API implemented by the module [`gillespie`], also
//! available through Python bindings. This one does not require a rust
//! compilation and allows the system to be defined at run time. It is
//! typically 2 or 3 times slower than the macro DSL, but still faster
//! than all other software tried.
//!
//! # The macro DSL
//!
//! It currently only supports reaction rates defined by the law of mass
//! action. The following macro defines a dimerization reaction network
//! naturally:
//!
//! ```rust
//! use rebop::define_system;
//! define_system! {
//! r_tx r_tl r_dim r_decay_mRNA r_decay_prot;
//! Dimers { gene, mRNA, protein, dimer }
//! transcription : gene => gene + mRNA @ r_tx
//! translation : mRNA => mRNA + protein @ r_tl
//! dimerization : 2 protein => dimer @ r_dim
//! decay_mRNA : mRNA => @ r_decay_mRNA
//! decay_protein : protein => @ r_decay_prot
//! }
//! ```
//!
//! To simulate the system, put this definition in a rust code file and
//! instantiate the problem, set the parameters, the initial values, and
//! launch the simulation:
//!
//! ```rust
//! # use rebop::define_system;
//! # define_system! {
//! # r_tx r_tl r_dim r_decay_mRNA r_decay_prot;
//! # Dimers { gene, mRNA, protein, dimer }
//! # transcription : gene => gene + mRNA @ r_tx
//! # translation : mRNA => mRNA + protein @ r_tl
//! # dimerization : 2 protein => dimer @ r_dim
//! # decay_mRNA : mRNA => @ r_decay_mRNA
//! # decay_protein : protein => @ r_decay_prot
//! # }
//! let mut problem = Dimers::new();
//! problem.r_tx = 25.0;
//! problem.r_tl = 1000.0;
//! problem.r_dim = 0.001;
//! problem.r_decay_mRNA = 0.1;
//! problem.r_decay_prot = 1.0;
//! problem.gene = 1;
//! problem.advance_until(1.0);
//! println!("t = {}: dimer = {}", problem.t, problem.dimer);
//! ```
//!
//! Or for the classic SIR example:
//!
//! ```rust
//! use rebop::define_system;
//!
//! define_system! {
//! r_inf r_heal;
//! SIR { S, I, R }
//! infection : S + I => 2 I @ r_inf
//! healing : I => R @ r_heal
//! }
//!
//! fn main() {
//! let mut problem = SIR::new();
//! problem.r_inf = 1e-4;
//! problem.r_heal = 0.01;
//! problem.S = 999;
//! problem.I = 1;
//! println!("time,S,I,R");
//! for t in 0..250 {
//! problem.advance_until(t as f64);
//! println!("{},{},{},{}", problem.t, problem.S, problem.I, problem.R);
//! }
//! }
//! ```
//!
//! which can produce an output similar to this one:
//!
//! ![Typical SIR output](https://github.com/Armavica/rebop/blob/master/sir.png)
//!
//! # Python bindings
//!
//! This API shines through the Python bindings which allow one to
//! define a model easily:
//!
//! ```python
//! import rebop
//!
//! sir = rebop.Gillespie()
//! sir.add_reaction(1e-4, ['S', 'I'], ['I', 'I'])
//! sir.add_reaction(0.01, ['I'], ['R'])
//! print(sir)
//!
//! ds = sir.run({'S': 999, 'I': 1}, tmax=250, nb_steps=250)
//! ```
//!
//! You can test this code by installing `rebop` from PyPI with
//! `pip install rebop`. To build the Python bindings from source,
//! the simplest is to clone this git repository and use `maturin
//! develop`.
//!
//! # The traditional API
//!
//! The function-based API underlying the Python package is also available
//! from Rust, if you want to be able to define models at run time (instead
//! of at compilation time with the macro DSL demonstrated above).
//! The SIR model is defined as:
//!
//! ```rust
//! use rebop::gillespie::{Gillespie, Rate};
//!
//! let mut sir = Gillespie::new([999, 1, 0]);
//! // [ S, I, R]
//! // S + I => 2 I with rate 1e-4
//! sir.add_reaction(Rate::lma(1e-4, [1, 1, 0]), [-1, 1, 0]);
//! // I => R with rate 0.01
//! sir.add_reaction(Rate::lma(0.01, [0, 1, 0]), [0, -1, 1]);
//!
//! println!("time,S,I,R");
//! for t in 0..250 {
//! sir.advance_until(t as f64);
//! println!("{},{},{},{}", sir.get_time(), sir.get_species(0), sir.get_species(1), sir.get_species(2));
//! }
//! ```
//!
//! # Performance
//!
//! Performance is taken very seriously, and as a result, rebop
//! outperforms every other package and programming language that we
//! tried.
//!
//! *Disclaimer*: Most of this software currently contains much more
//! features than rebop (e.g. spatial models, custom reaction rates,
//! etc.). Some of these features might have required them to make
//! compromises on speed. Moreover, as much as we tried to keep the
//! comparison fair, some return too much or too little data, or write
//! them on disk. The baseline that we tried to approach for all these
//! programs is the following: *the model was just modified, we want
//! to simulate it `N` times and print regularly spaced measurement
//! points*. This means that we always include initialization or
//! (re-)compilation time if applicable. We think that it is the most
//! typical use-case of a researcher who works on the model. This
//! benchmark methods allows to record both the initialization time
//! (y-intercept) and the simulation time per simulation (slope).
//!
//! Many small benchmarks on toy examples are tracked to guide the
//! development. To compare the performance with other software,
//! we used a real-world model of low-medium size (9 species and 16
//! reactions): the Vilar oscillator (*Mechanisms of noise-resistance
//! in genetic oscillators*, Vilar et al., PNAS 2002). Here, we
//! simulate this model from `t=0` to `t=200`, reporting the state at
//! time intervals of `1` time unit.
//!
//! ![Vilar oscillator benchmark](https://github.com/Armavica/rebop/blob/master/benches/vilar/vilar.png)
//!
//! We can see that rebop's macro DSL is the fastest of all, both in
//! time per simulation, and with compilation time included. The second
//! fastest is rebop's traditional API invoked by convenience through
//! the Python bindings.
//!
//! # Features to come
//!
//! * compartment volumes
//! * arbitrary reaction rates
//! * other SSA algorithms
//! * tau-leaping
//! * adaptive tau-leaping
//! * hybrid models (continuous and discrete)
//! * SBML
//! * CLI interface
//! * parameter estimation
//! * local sensitivity analysis
//! * parallelization
//!
//! # Features probably not to come
//!
//! * events
//! * space (reaction-diffusion systems)
//! * rule modelling
//!
//! # Benchmark ideas
//!
//! * DSMTS
//! * purely decoupled exponentials
//! * ring
//! * Toggle switch
//! * LacZ, LacY/LacZ (from STOCKS)
//! * Lotka Volterra, Michaelis--Menten, Network (from StochSim)
//! * G protein (from SimBiology)
//! * Brusselator / Oregonator (from Cellware)
//! * GAL, repressilator (from Dizzy)
//!
//! # Similar software
//!
//! ## Maintained
//!
//! * [GillesPy2](https://github.com/StochSS/GillesPy2)
//! * [STEPS](https://github.com/CNS-OIST/STEPS)
//! * [SimBiology](https://fr.mathworks.com/help/simbio/)
//! * [Copasi](http://copasi.org/)
//! * [BioNetGen](http://bionetgen.org/)
//! * [VCell](http://vcell.org/)
//! * [Smoldyn](http://www.smoldyn.org/)
//! * [KaSim](https://kappalanguage.org/)
//! * [StochPy](https://github.com/SystemsBioinformatics/stochpy)
//! * [BioSimulator.jl](https://github.com/alanderos91/BioSimulator.jl)
//! * [DiffEqJump.jl](https://github.com/SciML/DiffEqJump.jl)
//! * [Gillespie.jl](https://github.com/sdwfrost/Gillespie.jl)
//! * [GillespieSSA2](https://github.com/rcannood/GillespieSSA2)
//! * [Cayenne](https://github.com/quantumbrake/cayenne)
//!
//! ## Seem unmaintained
//!
//! * [Dizzy](http://magnet.systemsbiology.net/software/Dizzy/)
//! * [Cellware](http://www.bii.a-star.edu.sg/achievements/applications/cellware/)
//! * [STOCKS](https://doi.org/10.1093/bioinformatics/18.3.470)
//! * [StochSim](http://lenoverelab.org/perso/lenov/stochsim.html)
//! * [Systems biology toolbox](http://www.sbtoolbox.org/)
//! * [StochKit](https://github.com/StochSS/StochKit) (successor: GillesPy2)
//! * [SmartCell](http://software.crg.es/smartcell/)
//! * [NFsim](http://michaelsneddon.net/nfsim/)
use pyo3::prelude::*;
use std::collections::HashMap;
pub use rand;
pub use rand_distr;
pub mod gillespie;
mod gillespie_macro;
/// Reaction system composed of species and reactions.
#[pyclass]
struct Gillespie {
species: HashMap<String, usize>,
reactions: Vec<(f64, Vec<String>, Vec<String>)>,
}
#[pymethods]
impl Gillespie {
#[new]
fn new() -> Self {
Gillespie {
species: HashMap::new(),
reactions: Vec::new(),
}
}
/// Number of species currently in the system
fn nb_species(&self) -> PyResult<usize> {
Ok(self.species.len())
}
/// Add a Law of Mass Action reaction to the system.
///
/// The forward reaction rate is `rate`, while `reactants` and `products` are lists of
/// respectively reactant names and product names. Add the reverse reaction with the rate
/// `reverse_rate` if it is not `None`.
fn add_reaction(
&mut self,
rate: f64,
reactants: Vec<String>,
products: Vec<String>,
reverse_rate: Option<f64>,
) -> PyResult<()> {
// Insert unknown reactants in known species
for reactant in &reactants {
if !self.species.contains_key(reactant) {
self.species.insert(reactant.clone(), self.species.len());
}
}
// Insert unknown products in known species
for product in &products {
if !self.species.contains_key(product) {
self.species.insert(product.clone(), self.species.len());
}
}
self.reactions
.push((rate, reactants.clone(), products.clone()));
if let Some(rrate) = reverse_rate {
self.reactions.push((rrate, products, reactants));
}
Ok(())
}
/// Number of reactions currently in the system.
fn nb_reactions(&self) -> PyResult<usize> {
Ok(self.reactions.len())
}
/// Run the system until `tmax` with `nb_steps` steps.
///
/// The initial configuration is specified in the dictionary `init`.
/// Returns `times, vars` where `times` is an array of `nb_steps + 1` uniformly spaced time
/// points between `0` and `tmax`, and `vars` is a dictionary of species name to array of
/// values at the given time points. One can specify a random `seed` for reproducibility.
fn run(
&self,
init: HashMap<String, usize>,
tmax: f64,
nb_steps: usize,
seed: Option<u64>,
) -> PyResult<(Vec<f64>, HashMap<String, Vec<isize>>)> {
let mut x0 = vec![0; self.species.len()];
for (name, &value) in &init {
if let Some(&id) = self.species.get(name) {
x0[id] = value as isize;
}
}
let mut g = match seed {
Some(seed) => gillespie::Gillespie::new_with_seed(x0, seed),
None => gillespie::Gillespie::new(x0),
};
for (rate, reactants, products) in self.reactions.iter() {
let mut vreactants = vec![0; self.species.len()];
for reactant in reactants {
vreactants[self.species[reactant]] += 1;
}
let rate = gillespie::Rate::lma(*rate, vreactants);
let mut actions = vec![0; self.species.len()];
for reactant in reactants {
actions[self.species[reactant]] -= 1;
}
for product in products {
actions[self.species[product]] += 1;
}
g.add_reaction(rate, actions);
}
let mut times = Vec::new();
// species.shape = (species, nb_steps)
let mut species = vec![Vec::new(); self.species.len()];
for i in 0..=nb_steps {
let t = tmax * i as f64 / nb_steps as f64;
times.push(t);
g.advance_until(t);
for s in 0..self.species.len() {
species[s].push(g.get_species(s));
}
}
let mut result = HashMap::new();
for (name, &id) in &self.species {
result.insert(name.clone(), species[id].clone());
}
Ok((times, result))
}
fn __str__(&self) -> PyResult<String> {
let mut s = format!(
"{} species and {} reactions\n",
self.species.len(),
self.reactions.len()
);
for (rate, reactants, products) in &self.reactions {
s.push_str(&reactants.join(" + "));
s.push_str(" --> ");
s.push_str(&products.join(" + "));
s.push_str(&format!(" @ {}\n", rate));
}
Ok(s)
}
}
#[pymodule]
fn rebop(m: &Bound<'_, PyModule>) -> PyResult<()> {
m.add("__version__", env!("CARGO_PKG_VERSION"))?;
m.add_class::<Gillespie>()?;
Ok(())
}