A simple CLI for BioNetGen
A simple CLI for BioNetGen
This is a simple CLI and a library for BioNetGen modelling language.
Use the following pip command
$ pip install bionetgen
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.
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.
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 paramter 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()._simulator
More documentation and tutorials are in progress.
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
Included is a basic
Dockerfile for building and distributing
and can be built with the included
$ 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.
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
|Filename, size||File type||Python version||Upload date||Hashes|
|Filename, size bionetgen-0.2.9-py3-none-any.whl (9.6 MB)||File type Wheel||Python version py3||Upload date||Hashes View|
|Filename, size bionetgen-0.2.9.tar.gz (9.4 MB)||File type Source||Python version None||Upload date||Hashes View|
Hashes for bionetgen-0.2.9-py3-none-any.whl