Skip to content

Commit c064fb3

Browse files
README.md (#73)
First README.md explaining installation and start
1 parent 243cdef commit c064fb3

1 file changed

Lines changed: 30 additions & 2 deletions

File tree

README.md

Lines changed: 30 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,2 +1,30 @@
1-
# pyPESTO_GUI
2-
a graphical user-interface for pyPESTO and PEtab
1+
# PEtabGUI
2+
3+
This is a graphical user interface to create parameter estimation problems. It is
4+
based on the [PEtab](https://petab.readthedocs.io/en/latest/#) format.
5+
6+
## Installation
7+
8+
To install the PEtabGUI, you can follow these steps:
9+
10+
1. Clone the repository:
11+
```bash
12+
git clone https://github.com/PaulJonasJost/PEtab_GUI.git
13+
```
14+
15+
2. Pip install the PEtab GUI:
16+
```bash
17+
pip install .
18+
```
19+
(Run this command line within the repository folder)
20+
21+
22+
## Usage
23+
24+
To start the PEtab GUI, you can run the following command line:
25+
```bash
26+
PEtab_gui $PATH_TO_YOUR_MODEL
27+
```
28+
where `$PATH_TO_YOUR_MODEL` is an optional argument with a file path of your
29+
yaml-model file in case you want to work on an existing model. You can also leave this
30+
argument out to start from scratch.

0 commit comments

Comments
 (0)