Skip to content

Commit

Permalink
Update readme, fix link
Browse files Browse the repository at this point in the history
  • Loading branch information
dweindl committed Jun 13, 2024
1 parent 7c264b4 commit 9ac3543
Showing 1 changed file with 4 additions and 3 deletions.
7 changes: 4 additions & 3 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -20,10 +20,11 @@ generating the tests and evaluating results. This can be installed via

## Use the test suite

The [cases](cases) subdirectory contains a collection of enumerated tests.
The [petabtests/cases](petabtests/cases) subdirectory contains a collection
of enumerated tests.
Each test contains a descriptive `wxyz.md` file, and a script file `wxyz.py`
file that can be used to generate all problem and solution files for the test.
The necessary files are in the same case specific folder, starting with an
The necessary files are in the same case-specific folder, starting with an
underscore.
In each case folder, there is a file `_wxyz.yaml` containing the parameter
estimation problem description, and a file `_wxyz_solution.yaml` containing
Expand All @@ -45,7 +46,7 @@ employed: Simulations, chi2 value and log-likelihood. A tool can be said to
cover a test problem if any of those values matches the ground truth values
up to some tolerance.

The python module provides convenience functions for evaluation in
The python package provides convenience functions for evaluation in
[petabtests/evaluate.py](petabtests/evaluate.py).

-> [Overview of passed test cases for different tools supporting PEtab](https://github.com/PEtab-dev/PEtab#petab-features-supported-in-different-tools)

0 comments on commit 9ac3543

Please sign in to comment.