Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add SBMLImporter to the README #261

Merged
merged 8 commits into from
Nov 22, 2024
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
50 changes: 0 additions & 50 deletions .github/workflows/downstream.yml

This file was deleted.

21 changes: 13 additions & 8 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,8 +1,8 @@
# SBML.jl

| Build status | Documentation | Stats |
|:---:|:---:|:---:|
| ![CI status](https://github.com/LCSB-BioCore/SBML.jl/workflows/CI/badge.svg?branch=master) [![codecov](https://codecov.io/gh/LCSB-BioCore/SBML.jl/branch/master/graph/badge.svg?token=eJehiv1yWs)](https://codecov.io/gh/LCSB-BioCore/SBML.jl) | [![stable documentation](https://img.shields.io/badge/docs-stable-blue)](https://lcsb-biocore.github.io/SBML.jl/stable) [![dev documentation](https://img.shields.io/badge/docs-dev-cyan)](https://lcsb-biocore.github.io/SBML.jl/dev) | [![SBML Downloads](https://shields.io/endpoint?url=https://pkgs.genieframework.com/api/v1/badge/SBML)](https://pkgs.genieframework.com?packages=SBML) |
| Build status | Documentation |
|:---:|:---:|
| ![CI status](https://github.com/LCSB-BioCore/SBML.jl/workflows/CI/badge.svg?branch=master) [![codecov](https://codecov.io/gh/LCSB-BioCore/SBML.jl/branch/master/graph/badge.svg?token=eJehiv1yWs)](https://codecov.io/gh/LCSB-BioCore/SBML.jl) | [![stable documentation](https://img.shields.io/badge/docs-stable-blue)](https://lcsb-biocore.github.io/SBML.jl/stable) [![dev documentation](https://img.shields.io/badge/docs-dev-cyan)](https://lcsb-biocore.github.io/SBML.jl/dev) |


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.
Expand All @@ -12,17 +12,22 @@ 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.
- Connections to the [SciML](https://github.com/SciML)
[ModelingToolkit](https://github.com/SciML/ModelingToolkit.jl) ecosystem:
- [SBMLToolkit.jl](https://github.com/SciML/SBMLToolkit.jl), for working with
the models' reaction dynamics as ODE systems.
- [SBMLImporter.jl](https://github.com/sebapersson/SBMLImporter.jl) for
importing the SBML models into
[Catalyst.jl](https://github.com/SciML/Catalyst.jl), allowing simulations
via Catalyst's `JumpProblem`, `SDEProblem`, or `ODEProblem` and fitting
models to data via [PEtab.jl](https://github.com/sebapersson/PEtab.jl).

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

#### Acknowledgements

`SBML.jl` was developed at the Luxembourg Centre for Systems Biomedicine of the
University of Luxembourg ([uni.lu/lcsb](https://www.uni.lu/lcsb)), and the UCL
University of Luxembourg ([lcsb.uni.lu](https://lcsb.uni.lu/)), and the UCL
Research Software Development Group
([ucl.ac.uk/arc](https://www.ucl.ac.uk/arc)). The development was supported by
European Union's Horizon 2020 Programme under PerMedCoE project
Expand Down
2 changes: 1 addition & 1 deletion src/unitful.jl
Original file line number Diff line number Diff line change
Expand Up @@ -57,7 +57,7 @@ $(TYPEDSIGNATURES)
Converts a [`UnitPart`](@ref) to a corresponding Unitful unit.

The conversion is done according to the formula from
[SBML L3v2 core manual release 2](http://sbml.org/Special/specifications/sbml-level-3/version-2/core/release-2/sbml-level-3-version-2-release-2-core.pdf)(section 4.4.2).
[SBML L3v2 core manual release 2](https://sbml.org/specifications/sbml-level-3/version-2/core/release-2/sbml-level-3-version-2-release-2-core.pdf)(section 4.4.2).
"""
unitful(u::UnitPart) =
(u.multiplier * UNITFUL_KIND_STRING[u.kind] * exp10(u.scale))^u.exponent
Expand Down
Loading