Skip to content

Commit

Permalink
#3 Update license and readme
Browse files Browse the repository at this point in the history
  • Loading branch information
kwabenantim committed Jan 20, 2025
1 parent 3a4e2f1 commit 04bfaea
Show file tree
Hide file tree
Showing 2 changed files with 23 additions and 13 deletions.
2 changes: 1 addition & 1 deletion LICENSE
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
BSD 3-Clause License

Copyright (c) 2023, Chaste - Cancer Heart and Soft Tissue Environment
Copyright (c) 2025, Chaste - Cancer Heart and Soft Tissue Environment

Redistribution and use in source and binary forms, with or without
modification, are permitted provided that the following conditions are met:
Expand Down
34 changes: 22 additions & 12 deletions README.md
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

0 comments on commit 04bfaea

Please sign in to comment.