Skip to content

Commit

Permalink
Update README.md
Browse files Browse the repository at this point in the history
  • Loading branch information
paulflang authored Dec 10, 2024
1 parent 4f0a561 commit ce6a898
Showing 1 changed file with 3 additions and 1 deletion.
4 changes: 3 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -11,7 +11,9 @@

SBMLToolkit.jl is a lightweight tool to import models specified in the Systems Biology Markup Language (SBML) into the Julia SciML ecosystem. There are multiple ways to specify the same model in SBML. Please help us improving SBMLToolkit.jl by creating a GitHub issue if you experience errors when converting your SBML model.

SBMLToolkit uses the [SBML.jl](https://github.com/LCSB-BioCore/SBML.jl) wrapper of the [libSBML](https://model.caltech.edu/software/libsbml/) library to lower dynamical SBML models into completed dynamical systems. If you would like to import BioNetGen models use the `writeSBML()` export function or import the `.net` file with [ReactionNetworkImporters.jl](https://github.com/SciML/ReactionNetworkImporters.jl). For constrained-based modeling, please have a look at [COBREXA.jl](https://github.com/COBREXA/COBREXA.jl). We also recommend trying [SBMLImporter.jl](https://github.com/sebapersson/SBMLImporter.jl). While SBMLToolkit.jl has a slightly cleaner interface, SBMLImporter.jl respects directionality of events, can output concentrations in addition to amounts, and provides better simulation performance for models including time-triggered events and SBML `piecewise` expressions. If you are an experienced SBML user and interested if SBMLToolkit supports certain (SBML test suite)[https://github.com/sbmlteam/sbml-test-suite] cases, you can download the logs from the latest CI run of the [SBMLToolkitTestSuite](https://github.com/SciML/SBMLToolkitTestSuite.jl/actions/workflows/CI.yml).
SBMLToolkit uses the [SBML.jl](https://github.com/LCSB-BioCore/SBML.jl) wrapper of the [libSBML](https://model.caltech.edu/software/libsbml/) library to lower dynamical SBML models into completed dynamical systems. If you would like to import BioNetGen models use the `writeSBML()` export function or import the `.net` file with [ReactionNetworkImporters.jl](https://github.com/SciML/ReactionNetworkImporters.jl). For constrained-based modeling, please have a look at [COBREXA.jl](https://github.com/COBREXA/COBREXA.jl). We also recommend trying [SBMLImporter.jl](https://github.com/sebapersson/SBMLImporter.jl). While SBMLToolkit.jl has a slightly cleaner interface, SBMLImporter.jl respects directionality of events, can output concentrations in addition to amounts, and provides better simulation performance for models including time-triggered events and SBML `piecewise` expressions.

If you are an experienced SBML user and interested if SBMLToolkit supports certain [SBML test suite](https://github.com/sbmlteam/sbml-test-suite) cases, you can download the logs from the latest CI run of the [SBMLToolkitTestSuite](https://github.com/SciML/SBMLToolkitTestSuite.jl/actions/workflows/CI.yml).

## Installation

Expand Down

0 comments on commit ce6a898

Please sign in to comment.