Skip to main content

A simple CLI and library for the BioNetGen modeling language

Project description

A simple CLI for BioNetGen

BNG CLI build status Open in Remote - Containers Documentation Status Downloads Downloads

This is a simple CLI and a library for BioNetGen modeling language. PyBioNetGen also includes a heavily updated version of Atomizer which allows for conversion of models written in Systems Biology Markup Language (SBML) into BioNetGen language (BNGL) format.

Please see the documentation to learn how to use PyBioNetGen.

Installation

You will need both python (3.7 and above) and perl installed. Once both are available you can use the following pip command to install the package

$ pip install bionetgen

Features

PyBioNetGen comes with a command line interface (CLI), based on cement framework, as well as a functional library that can be imported. The CLI can be used to run BNGL models, generate Jupyter notebooks and do rudimentary plotting.

The library side provides a simple BNGL model runner as well as a model object that can be manipulated and used to get libRoadRunner simulators for the model.

PyBioNetGen also includes a heavily updated version of Atomizer which allows for conversion of SBML models into BNGL format. Atomizer can also be used to automatically try to infer the internal structure of SBML species during the conversion, see here for more information. Please note that this version of Atomizer is the main supported version and the version distributed with BioNetGen will eventually be deprecated.

The model object requires a system call to BioNetGen so the initialization can be relatively costly, in case you would like to use it for parallel applications, use the libRoadRunner simulator instead, unless you are doing NFSim simulations.

Usage

Sample CLI usage

$ bionetgen -h # help on every subcommand
$ bionetgen run -h # help on run subcommand
$ bionetgen run -i mymodel.bngl -o output_folder # this runs the model in output_folder

Sample library usage

import bionetgen 

ret = bionetgen.run("/path/to/mymodel.bngl", out="/path/to/output/folder")
# out keyword is optional, if not given, 
# generated files will be deleted after running
res = ret.results['mymodel']
# res will be a numpy record array of your gdat results

model = bionetgen.bngmodel("/path/to/mymodel.bngl")
# model will be a python object that contains all model information
print(model.parameters) # this will print only the parameter block in BNGL format
print(model) # this will print the entire BNGL
model.parameters.k = 1 # setting parameter k to 1
with open("new_model.bngl", "w") as f:
    f.write(str(model)) # writes the changed model to new_model file

# this will give you a libRoadRunner instance of the model
librr_sim = model.setup_simulator()

You can find more tutorials here.

Environment Setup

The following demonstrates setting up and working with a development environment:

### create a virtualenv for development

$ make virtualenv

$ source env/bin/activate


### run bionetgen cli application

$ bionetgen --help


### run pytest / coverage

$ make test

Docker

Included is a basic Dockerfile for building and distributing BioNetGen CLI, and can be built with the included make helper:

$ make docker

$ docker run -it bionetgen --help

Publishing to PyPI

You can use make dist command to make the distribution and push to PyPI with

python -m twine upload dist/*

You'll need to have a PyPI API token created, see here for more information.

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

bionetgen-0.8.6.tar.gz (11.7 MB view details)

Uploaded Source

Built Distribution

bionetgen-0.8.6-py3-none-any.whl (12.8 MB view details)

Uploaded Python 3

File details

Details for the file bionetgen-0.8.6.tar.gz.

File metadata

  • Download URL: bionetgen-0.8.6.tar.gz
  • Upload date:
  • Size: 11.7 MB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.1.0 CPython/3.12.3

File hashes

Hashes for bionetgen-0.8.6.tar.gz
Algorithm Hash digest
SHA256 5c0f38d91b940f0c93e4845c8e3c880f4aec3c02b72332f078d4155a2e510313
MD5 3ff9cdadd4e2063db044cc5e35999561
BLAKE2b-256 65469131c7ff7beccd577f7fec1421ac10fb54d5541e1b101a2a55870296ea5e

See more details on using hashes here.

File details

Details for the file bionetgen-0.8.6-py3-none-any.whl.

File metadata

  • Download URL: bionetgen-0.8.6-py3-none-any.whl
  • Upload date:
  • Size: 12.8 MB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.1.0 CPython/3.12.3

File hashes

Hashes for bionetgen-0.8.6-py3-none-any.whl
Algorithm Hash digest
SHA256 9bb77e159853831bda1efa6f8cb59f4171aa33fdfdc02ae2795553a851415c5f
MD5 4dbdeeffe57a9c25df9e7cfdb315334e
BLAKE2b-256 761b767705c9d10fb44d2b4275c55590d0f63a1724b44163c436ea3db65f68a1

See more details on using hashes here.

Supported by

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