Skip to main content

PyGOM - Python Generic ODE Model

pypi version licence Github actions Jupyter Book Badge

A generic framework for Ordinary Differential Equation (ODE) models, especially compartmental type systems. This package provides a simple interface for users to construct ODE models backed by a comprehensive and easy to use tool–box implementing functions to easily perform common operations such as parameter estimation and solving for deterministic or stochastic time evolution. With both the algebraic and numeric calculations performed automatically (but still accessible), the end user is free to focus on model development. Full documentation for this package is avalible on the documentation page.

Installation

Install from Source

The PyGOM source code is available from GitHub:

https://github.com/ukhsa-collaboration/pygom

Clone the repository

git clone https://github.com/ukhsa-collaboration/pygom.git

Create and activate an environment

If you require support for compartmental model diagrams, create (and activate) a Conda environment with Graphviz installed:

conda create -n pygom-env python=3.11 graphviz
conda activate pygom-env

If visualisation is not required, you may use a standard Conda environment or a Python virtual environment (venv).

Install PyGOM

Navigate to the project root

cd pygom

If you wish to install from a specific branch, switch to it prior to installation:

git checkout <branch-name>

Install PyGOM

python -m pip install .

For development work, an editable install can instead be used

python -m pip install -e .

To build the documentation locally, install the additional documentation dependencies:

python -m pip install -e ".[docs]"
Please be aware that there may be redundant files within the package as it is under active development.
The latest fully reviewed version of PyGOM will be on the master branch and we recommend that users install the version from there.

Install from PyPI

Alternatively, install the latest released version directly from PyPI:

https://pypi.org/project/pygom/

pip install pygom

Verifying the Installation

Run the test suite to confirm that the installation completed successfully:

python -m unittest discover --verbose --start-directory tests

This may take some minutes to complete.

Contributors

Thomas Finnie (Thomas.Finnie@ukhsa.gov.uk)

Edwin Tye

Hannah Williams

Jonty Carruthers

Martin Grunnill

Joseph Gibson

Version

0.1.8 Updated and much better documentation.

0.1.7 Add Approximate Bayesian Computation (ABC) as a method of fitting to data

0.1.6 Bugfix scipy API, pickling, print to logging and simulation

0.1.5 Remove auto-simplification for much faster startup

0.1.4 Much faster Tau leap for stochastic simulations

0.1.3 Defaults to python built-in unittest and more in sync with conda

Download files

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

Source Distribution

pygom-0.1.10.tar.gz (3.8 MB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

pygom-0.1.10-py3-none-any.whl (339.1 kB view details)

Uploaded Python 3

File details

Details for the file pygom-0.1.10.tar.gz.

File metadata

  • Download URL: pygom-0.1.10.tar.gz
  • Upload date:
  • Size: 3.8 MB
  • Tags: Source
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/7.0.0 CPython/3.13.14

File hashes

Hashes for pygom-0.1.10.tar.gz
Algorithm Hash digest
SHA256 17d93072172cc9edadb435ee646729df3790960c5f0d5abbe5210e87a01e61b2
MD5 fc5643ab4329fcf03004bfb72f6977ea
BLAKE2b-256 9162f32a24f11720b4884760193cf28d3f1d4b9039f7758478d48c2781814597

See more details on using hashes here.

Provenance

The following attestation bundles were made for pygom-0.1.10.tar.gz:

Publisher: distribute_package.yml on ukhsa-collaboration/pygom

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

File details

Details for the file pygom-0.1.10-py3-none-any.whl.

File metadata

  • Download URL: pygom-0.1.10-py3-none-any.whl
  • Upload date:
  • Size: 339.1 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/7.0.0 CPython/3.13.14

File hashes

Hashes for pygom-0.1.10-py3-none-any.whl
Algorithm Hash digest
SHA256 f094ece1bbde53c5ba834371ef5d8bc1633bfb4abb04491915d0fa792474cbcc
MD5 856f8ac49957cf0847b766eec0201377
BLAKE2b-256 f0708ef88b8e20cc7fb2f8537d50abb85d0426f938b0acc3df43e77631823a29

See more details on using hashes here.

Provenance

The following attestation bundles were made for pygom-0.1.10-py3-none-any.whl:

Publisher: distribute_package.yml on ukhsa-collaboration/pygom

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

Release history Release notifications | RSS feed

This release

0.1.10 This release

2 files

0.1.8

8 files

0.1.7

1 file

0.1.6

1 file

0.1.5

1 file

0.1.4

1 file

0.1.1

1 file

0.1.0

2 files

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