Skip to main content

SBML-shorthand conversion tools

Project description

sbmlsh - SBML-shorthand

This page describes a "shorthand" version of SBML that is much easier to read and write by hand than real SBML, together with a software tool that translates the shorthand model description to real SBML.

It isn't really meant as a complete alternative to GUI model-building tools. It is just a useful tool for rapid building of essential model structure. Once the basics are defined, you can translate to SBML and load up in the GUI tool of your choice.

Example

The following is a complete description of a simple enzyme-kinetics model using the shorthand notation.

@model:2.3.1=MichaelisMentenKinetics "Michaelis-Menten Kinetics"
@compartments
 cell=1
@species
 cell:Substrate=1000
 cell:Enzyme=100
 cell:Complex=0
 cell:Product=0
@parameters
 k1=1
 k1r=2
@reactions
@rr=SubstrateEnzymeBinding "Substrate-enzyme binding"
 Substrate+Enzyme -> Complex
 k1*Substrate*Enzyme-k1r*Complex
@r=Conversion
 Complex -> Product + Enzyme
 k2*Complex : k2=3

You can download this example: mm.mod. Using the translation tool below, this model translates to this SBML.

Latest SBML-shorthand specification

  • SBML-shorthand specification, version 3.1.1 (PDF) - targeted at SBML Level 3, Version 1.

Python package containing conversion tools

pip install sbmlsh

mod2sbml model translation script

  • mod2sbml documentation (PDF) (version 3.1.1.1), which is targeted at SBML-shorthand version 3.1.1, and all previous versions.

sbml2mod reverse translation script

  • sbml2mod (version 3.1.1.1) is the reverse translation tool for Level 3, version 1 and all previous versions.

Obviously, as the shorthand specification does not contain all SBML features, there is likely to be loss involved. However, there should be no semantic loss in the round-trip SBML-sh -> SBML -> SBML-sh. ie. doing a mod2sbml conversion followed by a sbml2mod conversion should get back to a shorthand file that is semantically equivalent to the original.

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

sbmlsh-0.0.3.tar.gz (172.6 kB view details)

Uploaded Source

Built Distribution

sbmlsh-0.0.3-py3-none-any.whl (17.2 kB view details)

Uploaded Python 3

File details

Details for the file sbmlsh-0.0.3.tar.gz.

File metadata

  • Download URL: sbmlsh-0.0.3.tar.gz
  • Upload date:
  • Size: 172.6 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/4.0.2 CPython/3.10.12

File hashes

Hashes for sbmlsh-0.0.3.tar.gz
Algorithm Hash digest
SHA256 7cfd228bd8a8f9859d5ca371cbe2e90e2c100acd11102bf4b240d6f04d1082a0
MD5 8127a68ffb18ce4e50cfc01f0f196e61
BLAKE2b-256 80c4c42b20e40ffa4d55a61496ef09399b09456d4a5fab743858e4f647ba1b32

See more details on using hashes here.

File details

Details for the file sbmlsh-0.0.3-py3-none-any.whl.

File metadata

  • Download URL: sbmlsh-0.0.3-py3-none-any.whl
  • Upload date:
  • Size: 17.2 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/4.0.2 CPython/3.10.12

File hashes

Hashes for sbmlsh-0.0.3-py3-none-any.whl
Algorithm Hash digest
SHA256 a992c70e11208c76ca151dfa8840f861567bce9d175a530a63854da311ec3d22
MD5 0d87cce277558830c37319a7d00053d5
BLAKE2b-256 44153d27f339f586e648f94573c09bf732d80882992d0af8fe0b0a0a9aeebec2

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