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.9.6.tar.gz (917.8 kB view details)

Uploaded Source

Built Distribution

memote-0.9.6-py2.py3-none-any.whl (962.8 kB view details)

Uploaded Python 2 Python 3

File details

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

File metadata

  • Download URL: memote-0.9.6.tar.gz
  • Upload date:
  • Size: 917.8 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/1.13.0 pkginfo/1.5.0.1 requests/2.21.0 setuptools/40.8.0 requests-toolbelt/0.9.1 tqdm/4.31.1 CPython/3.6.3

File hashes

Hashes for memote-0.9.6.tar.gz
Algorithm Hash digest
SHA256 fde83ca5e93b419194dab7c0cf1343603213b9b5b0c95beab0fc4cb8be4850e1
MD5 c37e5421fe71d746050214afaf2f9633
BLAKE2b-256 50a6bcbf1cadb05a4e142f50cb8e2f9d4cd079bdaa80bb389d9b6123e7b40c58

See more details on using hashes here.

Provenance

File details

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

File metadata

  • Download URL: memote-0.9.6-py2.py3-none-any.whl
  • Upload date:
  • Size: 962.8 kB
  • Tags: Python 2, Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/1.13.0 pkginfo/1.5.0.1 requests/2.21.0 setuptools/40.8.0 requests-toolbelt/0.9.1 tqdm/4.31.1 CPython/3.6.3

File hashes

Hashes for memote-0.9.6-py2.py3-none-any.whl
Algorithm Hash digest
SHA256 da8b32f2c638fb3cb6bde0dfcc6e07eba36a950751cbb5fe29b2dc270cc2b9a5
MD5 787610ea51bda258e6f9324bf9697d6d
BLAKE2b-256 04fa4b323765d4499294d7c5629b7930c968d98d35f74d318850718705794b8c

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