PyGOM - Python Generic ODE Model
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
Built Distribution
Filter files by name, interpreter, ABI, and platform.
If you're not sure about the file name format, learn more about wheel file names.
Copy a direct link to the current filters
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
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
17d93072172cc9edadb435ee646729df3790960c5f0d5abbe5210e87a01e61b2
|
|
| MD5 |
fc5643ab4329fcf03004bfb72f6977ea
|
|
| BLAKE2b-256 |
9162f32a24f11720b4884760193cf28d3f1d4b9039f7758478d48c2781814597
|
Provenance
The following attestation bundles were made for pygom-0.1.10.tar.gz:
Publisher:
distribute_package.yml on ukhsa-collaboration/pygom
-
Statement:
-
Statement type:
https://in-toto.io/Statement/v1 -
Predicate type:
https://docs.pypi.org/attestations/publish/v1 -
Subject name:
pygom-0.1.10.tar.gz -
Subject digest:
17d93072172cc9edadb435ee646729df3790960c5f0d5abbe5210e87a01e61b2 - Sigstore transparency entry: 2306945117
- Sigstore integration time:
-
Permalink:
ukhsa-collaboration/pygom@74aee9dceacfd8ff623860219751ffecf029db6a -
Branch / Tag:
refs/tags/v0.1.10 - Owner: https://github.com/ukhsa-collaboration
-
Access:
public
-
Token Issuer:
https://token.actions.githubusercontent.com -
Runner Environment:
github-hosted -
Publication workflow:
distribute_package.yml@74aee9dceacfd8ff623860219751ffecf029db6a -
Trigger Event:
push
-
Statement type:
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
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
f094ece1bbde53c5ba834371ef5d8bc1633bfb4abb04491915d0fa792474cbcc
|
|
| MD5 |
856f8ac49957cf0847b766eec0201377
|
|
| BLAKE2b-256 |
f0708ef88b8e20cc7fb2f8537d50abb85d0426f938b0acc3df43e77631823a29
|
Provenance
The following attestation bundles were made for pygom-0.1.10-py3-none-any.whl:
Publisher:
distribute_package.yml on ukhsa-collaboration/pygom
-
Statement:
-
Statement type:
https://in-toto.io/Statement/v1 -
Predicate type:
https://docs.pypi.org/attestations/publish/v1 -
Subject name:
pygom-0.1.10-py3-none-any.whl -
Subject digest:
f094ece1bbde53c5ba834371ef5d8bc1633bfb4abb04491915d0fa792474cbcc - Sigstore transparency entry: 2306945131
- Sigstore integration time:
-
Permalink:
ukhsa-collaboration/pygom@74aee9dceacfd8ff623860219751ffecf029db6a -
Branch / Tag:
refs/tags/v0.1.10 - Owner: https://github.com/ukhsa-collaboration
-
Access:
public
-
Token Issuer:
https://token.actions.githubusercontent.com -
Runner Environment:
github-hosted -
Publication workflow:
distribute_package.yml@74aee9dceacfd8ff623860219751ffecf029db6a -
Trigger Event:
push
-
Statement type: