Skip to main content

Graphical user interface for the PEtab format

Project description

PyPI - Version DOI

PEtab-GUI

PEtab-GUI provides a graphical user interface to inspect and edit parameter estimation problems encoded in the PEtab format.

Installation

From PyPI

To install PEtab-GUI from PyPI, run:

pip install petab_gui

or, to install PEtab-GUI in a dedicated virtual environment using pipx (to be installed separately), run:

pipx install petab_gui

From GitHub

To install the latest development version from GitHub, run:

pip install git+https://github.com/PEtab-dev/PEtab-GUI/

From a local copy

  1. Clone the repository:

    git clone https://github.com/PEtab-dev/PEtab-GUI.git
    
  2. Install the package from the root of the working tree:

    pip install .
    

Usage

After installation, launch PEtab-GUI from the command line using the petab_gui command.

Optionally, you can provide the path to an existing PEtab YAML file as an argument.

After loading a PEtab problem, PEtab-GUI will look something like this: PEtab-GUI Screenshot

Examples

A set of real-world PEtab problems is available in the PEtab benchmark collection.

Download and unpack the archive, then open one of the YAML files inside Benchmark-Models/*/ using PEtab-GUI. Benchmark-Models/Boehm_JProteomeRes2014/Boehm_JProteomeRes2014.yaml should serve as a good starting point.

Features

The PEtab-GUI provides a Python-based graphical user interface that simplifies the creation, editing, and validation of PEtab parameter estimation problems.

  • Unified Environment
    • Integrates all PEtab components (SBML models, conditions, observables, measurements, parameters, and visualization files).
    • Supports drag-and-drop import of YAML or individual component files.
    • Automatically resolves mismatches and converts matrix-format experimental data into valid PEtab format.
  • Interactive and Intuitive Editing
    • Dockable, resizable, and movable table widgets for each PEtab file.
    • Context-aware editing with combo-boxes, drop-downs, and multi-cell editing.
    • Automatic generation of missing observables/conditions with customizable defaults.
    • Real-time validation and plausibility checks with PEtab linting tools.
    • SBML view in both XML and human-readable Antimony syntax.
  • Visualization and Simulation
    • Interactive plots linking measurement data with model simulations.
    • Bidirectional highlighting between plots and tables.
    • Built-in simulation via BasiCO with one-click parameter testing.
    • Intelligent defaults for visualization with optional user customization.
    • Ability to disable plotting for large models to maintain responsiveness.
  • Archiving and Export
    • Export individual tables, the SBML model, or complete PEtab problems.
    • Save as directory structures or COMBINE archives for reproducibility

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

petab_gui-0.1.4.tar.gz (1.9 MB view details)

Uploaded Source

Built Distribution

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

petab_gui-0.1.4-py3-none-any.whl (111.4 kB view details)

Uploaded Python 3

File details

Details for the file petab_gui-0.1.4.tar.gz.

File metadata

  • Download URL: petab_gui-0.1.4.tar.gz
  • Upload date:
  • Size: 1.9 MB
  • Tags: Source
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/6.1.0 CPython/3.13.7

File hashes

Hashes for petab_gui-0.1.4.tar.gz
Algorithm Hash digest
SHA256 788ae16ec94ece855a6a83affdd6c998c387a62ae2f7341b0d1a5e37783b686b
MD5 11e8ac21ace565e4eeda202f4614dfc4
BLAKE2b-256 8fff1e760d5a93b6931325470f39dee6b80cee2ecc87df269a86d8bfce523d1e

See more details on using hashes here.

Provenance

The following attestation bundles were made for petab_gui-0.1.4.tar.gz:

Publisher: python-publish.yml on PEtab-dev/PEtab-GUI

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

File details

Details for the file petab_gui-0.1.4-py3-none-any.whl.

File metadata

  • Download URL: petab_gui-0.1.4-py3-none-any.whl
  • Upload date:
  • Size: 111.4 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/6.1.0 CPython/3.13.7

File hashes

Hashes for petab_gui-0.1.4-py3-none-any.whl
Algorithm Hash digest
SHA256 10ad042132302bc922323ad5ea95647a05678cdabdd39e29b051034b5ae02ff2
MD5 446732d3a2dd75b07b1aaee6a97e7eef
BLAKE2b-256 e52b6cb55b5625a8d8f34decca7828d8e43aa2eaef675c9c4bcb8d8e69c317ac

See more details on using hashes here.

Provenance

The following attestation bundles were made for petab_gui-0.1.4-py3-none-any.whl:

Publisher: python-publish.yml on PEtab-dev/PEtab-GUI

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

Supported by

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