Skip to content

Commit 883351d

Browse files
committed
Update README.md
1 parent d2be77c commit 883351d

File tree

1 file changed

+17
-1
lines changed

1 file changed

+17
-1
lines changed

README.md

+17-1
Original file line numberDiff line numberDiff line change
@@ -2,6 +2,10 @@
22

33
`ratesb_python` is a Python package designed for analyzing rate laws in SBML (Systems Biology Markup Language) and Antimony models, which are commonly used in systems biology for representing biological networks. This package offers a user-friendly API to help ensure that your models are robust and accurate by providing detailed warnings and errors related to rate laws.
44

5+
## ReadTheDocs
6+
7+
For detailed documentation, please visit [ReadTheDocs](https://longxf-ratesb-python.readthedocs-hosted.com/en/latest/).
8+
59
## Installation
610

711
To install `ratesb_python`, execute the following command in your terminal:
@@ -12,8 +16,15 @@ pip install ratesb_python
1216

1317
## Usage
1418

15-
Below is an example demonstrating how to use the ratesb_python package with file input:
19+
Below are examples demonstrating how to use the ratesb_python package with file input:
20+
21+
Simple example:
22+
```python
23+
from ratesn_python import check_model
24+
print(check_model("S->P;k1*S"))
25+
```
1626

27+
Complex example:
1728
```python
1829
from ratesb_python import Analyzer
1930

@@ -195,6 +206,11 @@ python -m unittest
195206
* Added check_model method to allow user to use the package with one line
196207
* Solved when running sympy with sympy builtin symbols that raise error such as "S", a reaction like "S->P;k1*S" would work now
197208

209+
### 0.2.6
210+
* Created ReadTheDocs
211+
* Bug Fixes
212+
* Improved test coverage to 99%
213+
198214
## Contributing
199215

200216
Contributions to `ratesb_python` are welcomed! Whether it's bug reports, feature requests, or new code contributions, we value your feedback and contributions. Please submit a pull request or open an issue on our [GitHub repo](https://github.com/sys-bio/ratesb_python).

0 commit comments

Comments
 (0)