Skip to main content

the genome-scale metabolic model test suite

Project description

https://img.shields.io/pypi/v/memote.svg https://img.shields.io/travis/opencobra/memote.svg Documentation Status Coverage Gitter

Our goal in promoting this tool is to achieve two major shifts in the metabolic model building community:

  1. Models should be version-controlled such that changes can be tracked and if necessary reverted. Ideally, they should be available through a public repository such as GitHub that will allow other researchers to inspect, share, and contribute to the model.

  2. Models should, for the benefit of the community and for research gain, live up to certain standards and minimal functionality.

The memote tool therefore performs four subfunctions:

  1. Create a skeleton git repository for the model.

  2. Run the current model through a test suite that represents the community standard.

  3. Generate an informative report which details the results of the test suite in a visually appealing manner.

  4. (Re-)compute test statistics for an existing version controlled history of a metabolic model.

And in order to make this process as easy as possible the generated repository can easily be integrated with continuous integration testing providers such as Travis CI, which means that anytime you push a model change to GitHub, the test suite will be run automatically and a report will be available for you to look at via GitHub pages for your repository.

Installation

We highly recommend creating a Python virtualenv for your model testing purposes.

To install memote, run this command in your terminal:

$ pip install memote

This is the preferred method to install memote, as it will always install the most recent stable release.

Contact

For comments and questions get in touch via

Are you excited about this project? Consider contributing by adding novel tests, reporting or fixing bugs, and generally help us make this a better software for everyone.

Credits

This package was created with Cookiecutter and the audreyr/cookiecutter-pypackage project template.

Memote relies on click for the command line interface, pytest for unit and model tests, gitpython for interacting with git repositories, pandas for tabular datastructures and data input, jinja2 for interacting with HTML templates, cobrapy for analysing genome-scale metabolic models, python_libsbml for reading and writing Systems Biology Markup Language (SBML), ruamel for handling YAML generation, travispy and travis-encrypt for interacting with Travis CI, pygithub for access to the Github API, sympy for matrix calculations, sqlalchemy for managing history results, numpydoc for beautifully formatted doc strings using sphinx, pylru for caching, goodtables for validation of tabular data, depinfo for pretty printing our dependencies, six and future for backward and forward compatibility.

The Memote Report App user interface is built with Angular 5, Angular Flex-Layout, and Angular Material. We rely on Vega for plotting results.

The initial development of memote has received funding from:

https://upload.wikimedia.org/wikipedia/commons/d/d5/Novo_nordisk_foundation_Logo.png https://innovationsfonden.dk/sites/all/themes/novigo/logo.png http://dd-decaf.eu/images/decaf-logo-md.svg

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

memote-0.8.5.tar.gz (624.5 kB view details)

Uploaded Source

Built Distribution

memote-0.8.5-py2.py3-none-any.whl (662.7 kB view details)

Uploaded Python 2 Python 3

File details

Details for the file memote-0.8.5.tar.gz.

File metadata

  • Download URL: memote-0.8.5.tar.gz
  • Upload date:
  • Size: 624.5 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/1.11.0 pkginfo/1.4.2 requests/2.19.1 setuptools/40.2.0 requests-toolbelt/0.8.0 tqdm/4.26.0 CPython/3.6.3

File hashes

Hashes for memote-0.8.5.tar.gz
Algorithm Hash digest
SHA256 5a487213b8fc49ae9e76bc5115baeab8488b73e58fcfeaabe11dc31bd8ab6839
MD5 9a17d968f67ef79915a26c0e3a2b3669
BLAKE2b-256 bb823ef36e4b56e38500dd5d25625bcb6af2e34886ae68569da3617f7c89c881

See more details on using hashes here.

Provenance

File details

Details for the file memote-0.8.5-py2.py3-none-any.whl.

File metadata

  • Download URL: memote-0.8.5-py2.py3-none-any.whl
  • Upload date:
  • Size: 662.7 kB
  • Tags: Python 2, Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/1.11.0 pkginfo/1.4.2 requests/2.19.1 setuptools/40.2.0 requests-toolbelt/0.8.0 tqdm/4.26.0 CPython/3.6.3

File hashes

Hashes for memote-0.8.5-py2.py3-none-any.whl
Algorithm Hash digest
SHA256 879b779374c5c2c034ad6e454a454d80162275539d92a34cfdcd2d823e26d647
MD5 6eabe651409972f360335ad088254fb6
BLAKE2b-256 96eda97f02ef2df71f02ed09fff3976ee9b187f64ab8793ce2d8214e3d3397f1

See more details on using hashes here.

Provenance

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