Skip to main content

Compartmental modelling Python package

Project description


Github release PyPI

license MIT

Build Status Documentation Status

Compartmental modelling Python package


alt tag alt tag

Check the docs to see more.


  • Define a model with simple rules as strings or with custom functions.
  • Pre-defined models like SIR, SIS, SEIR, ...
  • Community-extensions of models.
  • Solve numerically for fixed or time-dependent parameters.
  • Best-fit to existing data, posibly using time windows.
  • Create compartment graphs.
  • Export LaTeX.
  • Export to Wolfram Language (Mathematica).


Assuming you have a Python3 distribution with pip, the latest pypi release can be installed with:

pip3 install comod

To install the optional dependencies you can run

pip3 install 'comod[extras]'

Mind the quotes.

Developer information


To install a development version, cd to the directory with this file and:

pip3 install -e '.[test]'

As an alternative, a virtualenv might be used to install the package:

# Prepare a clean virtualenv and activate it
virtualenv -p /usr/bin/python3.6 venv
source venv/bin/activate
# Install the package
pip3 install -e '.[test]'


To generate the documentation, the docs extra dependencies must be installed.

To generate an html documentation with sphinx run:

make docs

To generate a PDF documentation using LaTeX:

make pdf


To run the unitary tests:

make test

Project details

Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

comod-0.2.1.tar.gz (15.2 kB view hashes)

Uploaded source

Built Distribution

comod-0.2.1-py2.py3-none-any.whl (15.0 kB view hashes)

Uploaded py2 py3

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page