Skip to content

Commit 6ff778e

Browse files
README: add examples, pipx (#185)
* README: add examples, pipx * pypi badge * Update README.md Co-authored-by: Paul Jonas Jost <70631928+PaulJonasJost@users.noreply.github.com> --------- Co-authored-by: Paul Jonas Jost <70631928+PaulJonasJost@users.noreply.github.com>
1 parent 132ce36 commit 6ff778e

File tree

1 file changed

+20
-1
lines changed

1 file changed

+20
-1
lines changed

README.md

Lines changed: 20 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,7 @@
1+
[![PyPI - Version](https://badge.fury.io/py/PEtab-GUI.svg)](pypi.org/project/PEtab-GUI/)
12
[![DOI](https://zenodo.org/badge/DOI/10.5281/zenodo.15355753.svg)](https://doi.org/10.5281/zenodo.15355753)
2-
# PEtabGUI
33

4+
# PEtabGUI
45

56
PEtabGUI provides a graphical user interface to inspect and edit parameter
67
estimation problems encoded in the
@@ -16,6 +17,13 @@ To install PEtabGUI from [PyPI](https://pypi.org/project/PEtab-GUI/), run:
1617
pip install petab_gui
1718
```
1819

20+
or, to install PEtabGUI in a dedicated virtual environment using
21+
[pipx](https://github.com/pypa/pipx) (to be installed separately), run:
22+
23+
```bash
24+
pipx install petab_gui
25+
```
26+
1927
### From GitHub
2028

2129
To install the latest development version from GitHub, run:
@@ -46,6 +54,17 @@ After installation, launch PEtabGUI from the command line using the
4654
Optionally, you can provide the path to an existing PEtab YAML file
4755
as an argument.
4856

57+
### Examples
58+
59+
A set of real-world PEtab problems is available in the
60+
[PEtab benchmark collection](https://github.com/Benchmarking-Initiative/Benchmark-Models-PEtab).
61+
62+
Download and unpack the [archive](https://github.com/Benchmarking-Initiative/Benchmark-Models-PEtab/archive/refs/heads/master.zip),
63+
then open one of the YAML files inside `Benchmark-Models/*/` using
64+
PEtabGUI.
65+
`Benchmark-Models/Boehm_JProteomeRes2014/Boehm_JProteomeRes2014.yaml`
66+
should serve as a good starting point.
67+
4968
## Features
5069

5170
The PEtabGUI provides a Python-based graphical user interface that simplifies

0 commit comments

Comments
 (0)