Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Update README #149

Merged
merged 2 commits into from
Jan 10, 2025
Merged

Update README #149

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
b8e1e59
closes #142
dilpath Jan 7, 2025
b5372e3
Merge branch 'develop' into fix_142
dilpath Jan 10, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
13 changes: 4 additions & 9 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -4,12 +4,11 @@
[![DOI](https://zenodo.org/badge/DOI/10.5281/zenodo.14183390.svg)](https://doi.org/10.5281/zenodo.14183390)


The repository for the development of the extension to PEtab for model
selection, including the additional file formats and Python 3 package.
The PEtab extension for model selection, including additional file formats and library.

## Install

The Python 3 package provides both the Python 3 and command-line (CLI)
The Python 3 library provides both the Python 3 and command-line (CLI)
interfaces, and can be installed from PyPI, with `pip3 install petab-select`.

## Documentation
Expand All @@ -19,12 +18,8 @@ Further documentation is available at

## Examples

There are example Jupyter notebooks for usage of PEtab Select with

- the command-line interface, and
- the Python 3 interface,

in the `doc/examples` directory.
There are example Jupyter notebooks covering the Python API, CLI, and visualization in the "doc/examples" directory.
The notebooks can be viewed at [https://petab-select.readthedocs.io/en/stable/examples.html](https://petab-select.readthedocs.io/en/stable/examples.html).

## Supported features

Expand Down
Loading