Skip to content
memote – the genome-scale metabolic model test suite
HTML Python TypeScript CSS Makefile JavaScript
Branch: develop
Clone or download
Midnighter Merge pull request #668 from opencobra/chore-upgrade
chore: upgrade structure and configuration
Latest commit 709563d Jun 24, 2019
Permalink
Type Name Latest commit message Commit time
Failed to load latest commit information.
.github fix: replace broken link in contributing.rst (#343) Feb 8, 2018
ci/travis feat: improve the automated pipelines (#261) Oct 31, 2017
docs Bump version: 0.9.11 → 0.9.12 May 20, 2019
memote-report-app fix: replace vega-lib with taucharts (#644) Apr 11, 2019
scripts Feat: Enable appveyor and ensure windows compatibility Apr 12, 2019
src/memote chore: introduce src directory Jun 24, 2019
tests fix: pin to cobra<=0.14.2 Apr 23, 2019
.coveragerc chore: move coverage config back Jun 24, 2019
.editorconfig refactor: externalize version dependencies (#431) May 15, 2018
.gitignore chore: ignore new packaging directory Mar 6, 2019
.travis.yml
AUTHORS.rst docs: revise and spellcheck docstrings and test titles Jun 29, 2018
HISTORY.rst doc: update release info Apr 23, 2019
LICENSE enter bumped version in history Feb 9, 2017
MANIFEST.in fix: remove pip dependency issue and refactor CI (#412) Apr 25, 2018
Makefile chore: update path Jun 24, 2019
README.rst doc: add appveyor badge Apr 12, 2019
appveyor.yml chore: remove path Jun 21, 2019
pyproject.toml chore: introduce src directory Jun 24, 2019
requirements_dev.in feat: add thermodynamics testing of reaction directionality Nov 21, 2018
setup.cfg chore: introduce src directory Jun 24, 2019
setup.py Bump version: 0.9.11 → 0.9.12 May 20, 2019
tox.ini chore: move coverage config back Jun 24, 2019

README.rst

memote - the genome-scale metabolic model test suite

https://ci.appveyor.com/api/projects/status/github/opencobra/memote?branch=develop&svg=true 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

Before installing memote, make sure that you have correctly installed the latest version of git.

Moreover, 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.

Copyright

  • Copyright (c) 2017, Novo Nordisk Foundation Center for Biosustainability, Technical University of Denmark.
  • Free software: Apache Software License 2.0

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
You can’t perform that action at this time.