README.md 1.99 KB
Newer Older
1
# SBML.jl
2

Miroslav Kratochvil's avatar
Miroslav Kratochvil committed
3 4
| Build status | Documentation |
|:---:|:---:|
Laurent Heirendt's avatar
Laurent Heirendt committed
5
| ![CI](https://github.com/LCSB-BioCore/SBML.jl/workflows/CI/badge.svg?branch=master) | [![doc](https://img.shields.io/badge/docs-stable-blue)](https://lcsb-biocore.github.io/SBML.jl/stable) |
6

Miroslav Kratochvil's avatar
Miroslav Kratochvil committed
7

8 9 10 11 12 13 14 15 16 17 18
This is a simple wrap of some of the libSBML functionality, mainly the model loading for purposes of COBRA analysis methods and exploration of ODE system and reaction dynamics.

You might like to try the packages that use SBML.jl; these now include:

- [COBREXA.jl](https://github.com/LCSB-BioCore/COBREXA.jl), the exascale-ready
  constraint-based analysis and reconstruction toolkit for finding and modeling
  steady metabolic fluxes with the models
- [SBMLToolkit.jl](https://github.com/SciML/SBMLToolkit.jl), for working with
  the reaction dynamics of the models as ODE systems, well connected to the
  [SciML](https://github.com/SciML)
  [ModelingToolkit](https://github.com/SciML/ModelingToolkit.jl) ecosystem.
Miroslav Kratochvil's avatar
Miroslav Kratochvil committed
19 20

Other functionality will be added as needed. Feel free to submit a PR that increases the loading "coverage".
21

22 23
#### Acknowledgements

Miroslav Kratochvil's avatar
Miroslav Kratochvil committed
24
`SBML.jl` was developed at the Luxembourg Centre for Systems Biomedicine of the
25 26 27 28 29 30 31
University of Luxembourg ([uni.lu/lcsb](https://www.uni.lu/lcsb)). The
development was supported by European Union's Horizon 2020 Programme under
PerMedCoE project ([permedcoe.eu](https://www.permedcoe.eu/)) agreement no.
951773.

<img src="docs/src/assets/unilu.svg" alt="Uni.lu logo" height="64px">   <img src="docs/src/assets/lcsb.svg" alt="LCSB logo" height="64px">   <img src="docs/src/assets/permedcoe.svg" alt="PerMedCoE logo" height="64px">

anand jain's avatar
anand jain committed
32 33 34 35 36 37
## Installation

```julia
]add SBML # or
using Pkg; Pkg.add("SBML")
```
38

39 40 41 42 43 44
## Usage

```julia
using SBML
m = readSBML("myModel.xml")

Miroslav Kratochvil's avatar
Miroslav Kratochvil committed
45
# m is now a Model structure with:
46 47 48 49 50
m.reactions
m.species
m.compartments
...
```
51 52 53 54

There are several helper functions, for example you can get a nice list of reactions, metabolites and the stoichiometric matrix as follows:

```julia
Laurent Heirendt's avatar
Laurent Heirendt committed
55
mets, rxns, S = getS(m)
56
```