Skip to main content

Optimization tool based on ODE discretisation.

Project description

Documentation Status Test results License

SBML2Julia

SBML2Julia is a tool to for optimizing parameters of ordinary differential equation (ODE) models. SBML2Julia translates a model from SBML/PEtab format into Julia for Mathematical Programming (JuMP), performes the optimization task and returns the results.

Optimization method

SBML2Julia uses the optimization method presented in Scalable nonlinear programming framework for parameter estimation in dynamic biological system models. In brief, contrary to typical parameter optimization methods for ODE systems, SBML2Julia does not rely on simulation of the ODE system. Instead SBML2Julia uses an implicit Euler scheme to time-discretize an ODE system of n equations into m time steps. This transforms the ODE system into a system of n * (m - 1) algebraic equations with n * m variables. These n * m variables (or a subset thereof) can then be cast into an objective function. SBML2Julia then uses interior-point optimization implemented in the Julia language to minimize the objective function constraint to the n * (m - 1) algebraic equations.

Installation

SBML2Julia depends on several Python and Julia packages. If you have Docker installed on your machine, the easiest way of installing these dependencies is to pull the latest SBML2Julia docker image from Docker Hub and build a container.

user@bash:/$ docker pull paulflang/sbml2julia:latest
user@bash:/$ docker run -it paulflang/sbml2julia:latest

To install the latest SBML2Julia version in the Docker container, run:

user@bash:/$ git clone https://github.com/paulflang/sbml2julia.git
user@bash:/$ python3 -m pip install -e sbml2julia

To check if the installation was succesful, run:

user@bash:/$ sbml2julia -h

Alternatively, the SBML2Julia dependencies can be installed as indicated in the Dockerfile in the SBML2Julia GitHub repository. Once these dependencie are installed, SBML2Julia can be installed as above:

user@bash:/$ git clone https://github.com/paulflang/sbml2julia.git
user@bash:/$ python3 -m pip install -e sbml2julia
user@bash:/$ sbml2julia -h

Interfaces

Optimization tasks can be performed from a Python API or a command line interface.

Tutorial, and documentation

Please see the documentation for a description of how to use SBML2Julia.

License

The package is released under the MIT license.

Development team

This package was developed by Paul F. Lang at the University of Oxford, UK and Sungho Shin at the University of Wisconsin-Madison, USA..

Questions and comments

Please contact Paul F. Lang with any questions or comments.

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

sbml2julia-0.1.1.tar.gz (21.9 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

sbml2julia-0.1.1-py3-none-any.whl (20.6 kB view details)

Uploaded Python 3

File details

Details for the file sbml2julia-0.1.1.tar.gz.

File metadata

  • Download URL: sbml2julia-0.1.1.tar.gz
  • Upload date:
  • Size: 21.9 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/3.2.0 pkginfo/1.5.0.1 requests/2.22.0 setuptools/50.3.2 requests-toolbelt/0.9.1 tqdm/4.46.1 CPython/3.8.5

File hashes

Hashes for sbml2julia-0.1.1.tar.gz
Algorithm Hash digest
SHA256 fd989a6cabf4b67f22dfcd1a5940168a585025420c102045d932e885c3c395aa
MD5 9c2abd28ed3717c8b90797adcae19858
BLAKE2b-256 ff2ba5ca578c3523b2a0a61054034b9869133abf9ab8088eafc0f93af20efb07

See more details on using hashes here.

File details

Details for the file sbml2julia-0.1.1-py3-none-any.whl.

File metadata

  • Download URL: sbml2julia-0.1.1-py3-none-any.whl
  • Upload date:
  • Size: 20.6 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/3.2.0 pkginfo/1.5.0.1 requests/2.22.0 setuptools/50.3.2 requests-toolbelt/0.9.1 tqdm/4.46.1 CPython/3.8.5

File hashes

Hashes for sbml2julia-0.1.1-py3-none-any.whl
Algorithm Hash digest
SHA256 a10e3406dfbfeab4f231b4225075e9ca6e51857abbae07f32bfb0a148a54af71
MD5 d30c0563a78d20dada0f9db5e7898948
BLAKE2b-256 da6cd35a575c714055c58e7a2e3d567830de85975563949a35acab9ae3a7cb98

See more details on using hashes here.

Supported by

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