PEtab --- a data format for specifying parameter estimation problems in systems biology
This repository describes PEtab --- a data format for specifying parameter estimation problems in systems biology, provides a Python library for easy access and validation of PEtab files.
About PEtab
PEtab is built around SBML and based on tab-separated values (TSV) files. It is meant as a standardized way to provide information for parameter estimation which is out of the current scope of SBML. This includes for example:
-
Specifying and linking measurements to models
-
Defining model outputs
-
Specifying noise models
-
-
Specifying parameter bounds for optimization
-
Specifying multiple simulation condition with potentially shared parameters
Documentation
Documentation of the PEtab data format and Python library is available at https://petab.readthedocs.io/en/latest/.
References
Where PEtab is used / supported:
-
Within the systems biology optimization benchmark problem collection
PEtab support for D2D and AMIGO2 is under development.
If your project or tool is using PEtab, and you would like to have it listed here, please let us know.
Using PEtab
If you would like to use PEtab yourself, please have a look at doc/documentation_data_format.md or at the example models provided in the benchmark problem collection.
To convert your existing parameter estimation problem to the PEtab format, you will have to:
-
Specify your model in SBML
-
Set up model outputs and noise model using
AssignmentRules as described in the PEtab documentation -
Create a condition table, if appropriate
-
Create a table of measurements
-
Create a parameter table
If you are using Python, some handy functions of the
PEtab library can help
you with that. This include also a PEtab validator called petablint which
you can use to check if your files adhere to the PEtab standard. If you have
further questions regarding PEtab, feel free to post an
issue at our github repository.
PEtab Python library
PEtab comes with a Python package for creating, checking, and working with PEtab files. This library is available on pypi and the easiest way to install it is running
pip3 install petab
It will require Python>=3.6 to run.
Development versions of the PEtab library can be installed using
pip3 install https://github.com/PEtab-dev/PEtab/archive/develop.zip
(replace develop by the branch or commit you would like to install).
When setting up a new parameter estimation problem, the most useful tools will be:
-
The PEtab validator, which is now automatically installed using Python entrypoints to be available as a shell command from anywhere called
petablint -
petab.create_parameter_dfto create the parameter table, once you have set up the model, condition table and measurement table -
Functions in
petab.migrationsfor updating PEtab files from earlier versions
Extending PEtab
We are aware of the fact that PEtab may not serve everybody's needs. If you have a suggestion of how to extend PEtab, feel free to post an issue at our github repository.
Release files for petab 0.1.2
For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.
Source distribution (sdist)
| File | Size | Uploaded | |
|---|---|---|---|
| petab-0.1.2.tar.gz | 49.3 kB | Details |
Built distribution (wheel)
| File | Interpreter | ABI | Platform | Reset |
|---|---|---|---|---|
| petab-0.1.2-py3-none-any.whl | Python 3 | none | any | Details |
Total release size: 107.3 kB
Release files / petab-0.1.2.tar.gz
| Download URL | petab-0.1.2.tar.gz |
|---|---|
| Size | 49.3 kB |
| Tags | Source |
|
SHA-256 checksum How to use checksums |
c466efb467581355f1224c27586379a389c0bcfad6cb9d4a9da6a8652a9f2b28
|
|
BLAKE2b-256 checksum How to use checksums |
05a2549fb376b62729f462bcf6d83cc4df4075d285d957cb43517d4576ec694c
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
twine/3.1.1 pkginfo/1.5.0.1 requests/2.23.0 setuptools/40.6.2 requests-toolbelt/0.9.1 tqdm/4.43.0 CPython/3.6.10
|
Release files / petab-0.1.2-py3-none-any.whl
| Download URL | petab-0.1.2-py3-none-any.whl |
|---|---|
| Size | 57.9 kB |
| Tags | Python 3 |
|
SHA-256 checksum How to use checksums |
812eda16fa61589474e3ae2bd00463e9d5b3017b3b98e5bbe8ea2079278fe671
|
|
BLAKE2b-256 checksum How to use checksums |
20ba2be18241344670582cf8844c007c9f1f8eb09829103026831d58253b1059
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
twine/3.1.1 pkginfo/1.5.0.1 requests/2.23.0 setuptools/40.6.2 requests-toolbelt/0.9.1 tqdm/4.43.0 CPython/3.6.10
|
