Skip to content

Commit 67cef00

Browse files
committed
README: add examples, pipx
1 parent e11b47c commit 67cef00

1 file changed

Lines changed: 18 additions & 0 deletions

File tree

README.md

Lines changed: 18 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -16,6 +16,13 @@ To install PEtabGUI from [PyPI](https://pypi.org/project/PEtab-GUI/), run:
1616
pip install petab_gui
1717
```
1818

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

2128
To install the latest development version from GitHub, run:
@@ -46,6 +53,17 @@ After installation, launch PEtabGUI from the command line using the
4653
Optionally, you can provide the path to an existing PEtab YAML file
4754
as an argument.
4855

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

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

0 commit comments

Comments
 (0)