Skip to main content

A customizable SBML to Matlab parser

Project description

SBML2dae: a customizable SBML to Matlab parser

GitHub Actions License

Description

At the same time as we developed OneModel, we created SBML2dae: a SBML-compatible python package which provides programming tools to generate SBML exporters to other programming languages for simulation or analysis. SBML2dae is open-source and complies with OneModel's design philosophy.

By default, SBML2dae only allows exporting SBML to Matlab. However, it is straightforward for an expert user to create a new parser for another programming language such as Modelica, Julia, or Python. We expect more syntactic parsers to be incorporated using SBML2dae (by our group or by the community).

The differences with other Matlab parsers are (i) SBML2dae allows the simulation of algebraic loops (an indispensable element for the simulation of reduced-order models, using the quasi-steady-state approximation), (ii) it generates Matlab code using classes that significantly facilitates the integration of the models with the rest of Matlab tools and (iii) SBML2dae is easily modifiable to change the way of exporting the models.

Motivation

There are excellent tools for simulation and analysis of SBML models, but one of the most significant drawbacks is when the tool does not fit the needs of pre-existing workflows. SBML2dae solves this problem by allowing the user to implement customized SBML parsers that fit their particular workflow quickly.

How to setup

SBML2dae can be installed from PyPI and is compatible with Python 3.7+ for Window, Mac and Linux.

The latest package can be installed with:

pip install sbml2dae

Quick example

SBML2dae provides a simple command-line interface to export SBML models into Matlab code.

Go to the examples folder in this repository and use the following command:

sbml2dae export ex01_simple_gene_expression.xml

It will generate a build folder with the SBML model exported into Matlab.

Citing

If you use SBML2dae in your research, please use the following citations in your published works:

  • Santos-Navarro, F. N., Navarro, J. L., Boada, Y., Vignoni, A., & Picó, J. (2022). "OneModel: an open-source SBML modeling tool focused on accessibility, simplicity, and modularity." DYCOPS.

  • Santos-Navarro, F. N., Vignoni, A., & Picó, J. (2022). "Multi-scale host-aware modeling for analysis and tuning of synthetic gene circuits for bioproduction." PhD thesis.

License

Copyright 2022 Fernando N. Santos-Navarro, Jose Luis Herrero, Yadira Boada, Alejandro Vignoni, and Jesús Picó

Licensed under the Apache License, Version 2.0 (the "License"); you may not use this software except in compliance with the License. You may obtain a copy of the License at http://www.apache.org/licenses/LICENSE-2.0

Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License.

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

sbml2dae-0.1.7.tar.gz (15.0 kB view details)

Uploaded Source

Built Distribution

sbml2dae-0.1.7-py3-none-any.whl (14.4 kB view details)

Uploaded Python 3

File details

Details for the file sbml2dae-0.1.7.tar.gz.

File metadata

  • Download URL: sbml2dae-0.1.7.tar.gz
  • Upload date:
  • Size: 15.0 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: poetry/1.1.13 CPython/3.6.9 Linux/4.15.0-175-generic

File hashes

Hashes for sbml2dae-0.1.7.tar.gz
Algorithm Hash digest
SHA256 a79ef376416fceafb722e9c89d682d47016b54a1a287e5e3b982c8b704ca592d
MD5 86c05aa73af79bffea9be3e11b9f0574
BLAKE2b-256 ca9915cbd5e5d407f14837136b54a30efe34174fef4642655056ee9903b93d82

See more details on using hashes here.

File details

Details for the file sbml2dae-0.1.7-py3-none-any.whl.

File metadata

  • Download URL: sbml2dae-0.1.7-py3-none-any.whl
  • Upload date:
  • Size: 14.4 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: poetry/1.1.13 CPython/3.6.9 Linux/4.15.0-175-generic

File hashes

Hashes for sbml2dae-0.1.7-py3-none-any.whl
Algorithm Hash digest
SHA256 2ff88891f52af53630acd54a16fd67b0149beaee7c220525699fde142460fd94
MD5 cd03f83c8606465607927430382536ea
BLAKE2b-256 db3066d2e8c70919eed222ef686db2fa800b90b1e337a4744173703b9e033ac9

See more details on using hashes here.

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page