https://github.com/biosimulators/biosimulators_utils
Utilities for building standardized command-line interfaces for biosimulation software packages
Science Score: 23.0%
This score indicates how likely this project is to be science-related based on various indicators:
-
○CITATION.cff file
-
✓codemeta.json file
Found codemeta.json file -
○.zenodo.json file
-
○DOI references
-
○Academic publication links
-
✓Committers with academic emails
3 of 12 committers (25.0%) from academic institutions -
○Institutional organization owner
-
○JOSS paper metadata
-
○Scientific vocabulary similarity
Low similarity (10.3%) to scientific vocabulary
Keywords
Keywords from Contributors
Repository
Utilities for building standardized command-line interfaces for biosimulation software packages
Basic Info
- Host: GitHub
- Owner: biosimulators
- License: mit
- Language: Python
- Default Branch: dev
- Homepage: https://docs.biosimulators.org/Biosimulators_utils
- Size: 14.4 MB
Statistics
- Stars: 4
- Watchers: 5
- Forks: 6
- Open Issues: 46
- Releases: 190
Topics
Metadata Files
README.md
BioSimulators utils
Command-line application and high-level utilities for reading, writing, validating, and executing COMBINE/OMEX format files that contain descriptions of simulations in Simulation Experiment Description Markup Language (SED-ML) format with models in formats such as the BioNetGen Language (BNGL) and the Systems Biology Markup Language (SBML).
Installation
Requirements
- Python >= 3.7
- pip (latest)
Optional requirements
- Docker: required to execute containerized simulation tools
- Java: required to parse and validate NeuroML/LEMS files
- Perl: required to parse and validate BioNetGen files
- RBApy: required to parse and validate RBA files
- XPP: required to parse and validate XPP files
Install latest release from PyPI
pip install biosimulators-utils
Install latest revision from GitHub
pip install git+https://github.com/biosimulators/Biosimulators_utils.git#biosimulators_utils
Installation optional features
To use BioSimulators utils to validate BNGL models, install BioSimulators utils with the bgnl option:
pip install biosimulators-utils[bgnl]
To use BioSimulators utils to validate CellML models, install BioSimulators utils with the cellml option:
pip install biosimulators-utils[cellml]
To use BioSimulators utils to validate LEMS models, install Java and then install BioSimulators utils with the lems option:
pip install biosimulators-utils[lems]
To use BioSimulators utils to validate NeuroML models, install BioSimulators utils with the neuroml option:
pip install biosimulators-utils[neuroml]
To use BioSimulators utils to validate SBML models, install BioSimulators utils with the sbml option:
pip install biosimulators-utils[sbml]
To use BioSimulators utils to validate SBML models, install BioSimulators utils with the smoldyn option:
pip install biosimulators-utils[smoldyn]
To use BioSimulators utils to convert Escher metabolic maps to Vega flux data visualizations, install BioSimulators utils with the escher option:
pip install biosimulators-utils[escher]
To use BioSimulators utils to execute containerized simulation tools, install BioSimulators utils with the containers option:
pip install biosimulators-utils[containers]
To use BioSimulators utils to log the standard output and error produced by simulation tools, install BioSimulators utils with the logging option:
pip install biosimulators-utils[logging]
Dockerfile and Docker image
This package is available in the ghcr.io/biosimulators/biosimulators Docker image. This image includes all of the optional dependencies and installation options.
To install and run this image, run the following commands:
docker pull ghcr.io/biosimulators/biosimulators
docker run -it --rm ghcr.io/biosimulators/biosimulators
This image includes this package, as well as standardized Python APIs for the simulation tools validated by BioSimulators. Because this image aims to incorporate as many simulation tools as possible within a single Python environment, this image may sometimes lag behind the latest version of this package.
The Dockerfile for this image is available here.
Tutorials
Command-line interface
A tutorial for the command-line interface is available here.
Python API
Interactive tutorials for using BioSimulators-utils and Python APIs for simulation tools to execute simulations are available online from Binder here. The Jupyter notebooks for these tutorials are also available here.
API documentation
API documentation is available here.
License
This package is released under the MIT license.
Development team
This package was developed by the Karr Lab at the Icahn School of Medicine at Mount Sinai in New York and the Center for Reproducible Biomedical Modeling with assistance from the contributors listed here.
Contributing to BioSimulators utils
We enthusiastically welcome contributions to BioSimulators utils! Please see the guide to contributing and the developer's code of conduct.
Funding
This work was supported by National Institutes of Health award P41EB023912.
Questions and comments
Please contact the BioSimulators Team with any questions or comments.
Owner
- Name: BioSimulators
- Login: biosimulators
- Kind: organization
- Email: info@biosimulators.org
- Location: USA
- Website: https://biosimulators.org
- Twitter: BioSimulators
- Repositories: 20
- Profile: https://github.com/biosimulators
Enabling more comprehensive and more predictive biological models through standardized simulation tools
GitHub Events
Total
- Issues event: 1
- Issue comment event: 4
- Push event: 4
- Pull request event: 4
- Create event: 2
Last Year
- Issues event: 1
- Issue comment event: 4
- Push event: 4
- Pull request event: 4
- Create event: 2
Committers
Last synced: about 2 years ago
Top Committers
| Name | Commits | |
|---|---|---|
| Jonathan Karr | j****r@g****m | 683 |
| biosimulatorsdaemon | b****n@g****m | 204 |
| Lucian Smith | l****h@u****u | 77 |
| spaceBearAmadeus (Alex) | a****e@g****m | 62 |
| Logan Drescher | 1****r | 19 |
| Logan Drescher | d****r@u****u | 15 |
| Eran | a****n@g****m | 15 |
| Bilal Shaikh | b****2@g****m | 9 |
| allcontributors[bot] | 4****] | 6 |
| Jim Schaff | s****m@g****m | 3 |
| TrellixVulnTeam | c****d@t****m | 1 |
| Brian Tao | b****o@b****u | 1 |
Committer Domains (Top 20 + Academic)
Issues and Pull Requests
Last synced: 8 months ago
All Time
- Total issues: 73
- Total pull requests: 51
- Average time to close issues: 26 days
- Average time to close pull requests: 8 days
- Total issue authors: 9
- Total pull request authors: 10
- Average comments per issue: 1.48
- Average comments per pull request: 2.53
- Merged pull requests: 36
- Bot issues: 0
- Bot pull requests: 7
Past Year
- Issues: 2
- Pull requests: 8
- Average time to close issues: N/A
- Average time to close pull requests: 1 day
- Issue authors: 2
- Pull request authors: 4
- Average comments per issue: 0.0
- Average comments per pull request: 1.75
- Merged pull requests: 4
- Bot issues: 0
- Bot pull requests: 4
Top Authors
Issue Authors
- jonrkarr (40)
- luciansmith (14)
- bilalshaikh42 (11)
- danv61 (2)
- CodeByDrescher (2)
- fbergmann (1)
- eagmon (1)
- jcschaff (1)
- stellaprins (1)
Pull Request Authors
- luciansmith (19)
- bilalshaikh42 (9)
- AlexPatrie (7)
- dependabot[bot] (7)
- jcschaff (6)
- CodeByDrescher (3)
- allcontributors[bot] (3)
- eagmon (2)
- b-tao (1)
- TrellixVulnTeam (1)
Top Labels
Issue Labels
Pull Request Labels
Packages
- Total packages: 1
-
Total downloads:
- pypi 2,894 last-month
- Total dependent packages: 4
- Total dependent repositories: 4
- Total versions: 184
- Total maintainers: 2
pypi.org: biosimulators-utils
description
- Homepage: https://github.com/biosimulators/Biosimulators_utils
- Documentation: https://biosimulators-utils.readthedocs.io/
- License: MIT
-
Latest release: 0.2.3
published over 1 year ago
Rankings
Maintainers (2)
Dependencies
- pydata-sphinx-theme *
- sphinx >=1.8
- sphinxprettysearchresults *
- bezier *
- bionetgen >=0.7.2
- capturer *
- docker >=4.4
- libcellml *
- libneuroml *
- pint *
- pylems *
- pyneuroml >=0.5.18
- pyneuroml *
- python_libsbml *
- smoldyn >=2.66
- appdirs *
- biopython *
- cement *
- evalidate *
- h5py *
- kisao >=2.29
- lxml *
- matplotlib *
- mpmath *
- natsort *
- networkx >=2.6
- numpy *
- openpyxl *
- pandas *
- pronto >=2.4
- pyomexmeta >=1.2.13
- python_dateutil *
- python_libcombine >=0.2.11
- python_libsedml >=2.0.16
- pyyaml *
- rdflib *
- regex *
- requests *
- setuptools *
- simplejson *
- termcolor *
- uritools *
- yamldown *
- capturer * test
- flaky * test
- jsonschema * test
- GabrielBB/xvfb-action v1 composite
- actions/cache v2 composite
- actions/checkout v2 composite
- actions/create-release v1 composite
- actions/setup-java v2 composite
- actions/setup-python v2 composite
- ad-m/github-push-action master composite
- codecov/codecov-action v2 composite
- eWaterCycle/setup-singularity v5 composite