-
Notifications
You must be signed in to change notification settings - Fork 0
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
1 parent
3a4e2f1
commit 04bfaea
Showing
2 changed files
with
23 additions
and
13 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,34 +1,44 @@ | ||
# Chaste code generation from SBML | ||
# SBML → Chaste | ||
|
||
The `chaste_codegen_sbml` module takes [SBML](https://synonym.caltech.edu/) models as input and uses [libSBML](https://synonym.caltech.edu/software/libsbml/) to parse the models and output C++ code for Chaste. | ||
`chaste_codegen_sbml` converts [SBML](https://synonym.caltech.edu/) models to C++ Chaste code. It relies on [libSBML](https://synonym.caltech.edu/software/libsbml/) for parsing SBML. | ||
|
||
## Installation | ||
### User install | ||
Installation via [`pipx`](https://pipx.pypa.io/) is recommended | ||
``` | ||
pipx install git+https://github.com/Chaste/chaste-codegen-sbml@develop | ||
``` | ||
|
||
Alternatively, install via `pip` (optionally in a virtual environment) | ||
Alternatively, install via `pip` | ||
``` | ||
# Create and activate a virtual environment | ||
# Create and activate a virtual environment (optional) | ||
python -m venv sbml-venv | ||
source sbml-venv/bin/activate | ||
# Install | ||
pip install git+https://github.com/Chaste/chaste-codegen-sbml@develop | ||
``` | ||
|
||
### Developer install | ||
Clone the repository and install the package in editable mode along with the `dev` dependencies: | ||
## Usage | ||
``` | ||
chaste_codegen_sbml [-h] | ||
``` | ||
|
||
## Development | ||
### Getting the code | ||
``` | ||
# Clone the repository | ||
git clone https://github.com/Chaste/chaste-codegen-sbml | ||
cd chaste-codegen-sbml | ||
pip install -e .[dev] | ||
# Create and activate a virtual environment | ||
python -m venv venv | ||
source venv/bin/activate | ||
# Install in editable mode along with dev dependencies | ||
pip install -e ."[dev]" | ||
``` | ||
|
||
## Usage | ||
### Running tests | ||
``` | ||
chaste_codegen_sbml [-h] | ||
python -m pytest | ||
``` | ||
|
||
## Testing |