cameo - computer aided metabolic engineering & optimization
Permalink
Failed to load latest commit information.
.travis fix: repair Travis builds (#208) May 22, 2018
cameo fix: repair Travis builds (#208) May 22, 2018
cli Feat/click cli (#160) May 2, 2017
data/metanetx fix: universal models in old cameo (#157) Apr 7, 2017
docs fix: rst docs Feb 6, 2018
release-notes release 0.11.3 Nov 22, 2017
scripts refactor: remove calls to removed add_demand Jul 27, 2017
tests fix: repair Travis builds (#208) May 22, 2018
.coveragerc fix: do not report coverage for visualization tasks Jun 16, 2016
.gitattributes use python-versioneer for awesome version management Sep 7, 2014
.gitignore fix: repair Travis builds (#208) May 22, 2018
.gitmodules Add cameo-notebooks as a git submodule to cameo/docs Jul 13, 2015
.tox_install.sh feat: fix tox setup May 29, 2017
.travis.yml fix: repair Travis builds (#208) May 22, 2018
CONTRIBUTING.rst Doc/contributing (#72) Oct 7, 2016
LICENSE Initial commit. Mar 26, 2014
MANIFEST.in fix: add ui/assets/loading_wave.gif to MANIFEST.in Feb 2, 2016
README.rst fix: add blank line after markup to avoid rst warning (#171) Jun 6, 2017
Vagrantfile Added ipython notebook command to Vagrantfile Feb 25, 2015
requirements.txt chore: DRY up requirements Jul 27, 2017
requirements_rtd.txt refactor: make SolverBasedModel cobra06 compat. Jul 27, 2017
setup.cfg feature: port all test to pytest (#135) Mar 17, 2017
setup.py Fix: publication fixes (#198) Feb 6, 2018
tox.ini 0.11.3 (#194) Nov 22, 2017
versioneer.py fix: versioneer upgrade Feb 27, 2017
wercker.yml Merge branch 'devel' into structural_analysis_2 May 12, 2016

README.rst

Cameo—Computer Aided Metabolic Engineering and Optimization

Join the chat at https://gitter.im/biosustain/cameo PyPI License Build Status Coverage Status DOI

What is cameo?

Cameo is a high-level python library developed to aid the strain design process in metabolic engineering projects. The library provides a modular framework of simulation and strain design methods that targets developers that want to develop new design algorithms and custom analysis workflows. Furthermore, it exposes a high-level API to users that just want to compute promising strain designs.

Curious? Head over to try.cameo.bio and give it a try.

Installation

Use pip to install cameo from PyPI.

$ pip install cameo

In case you downloaded or cloned the source code from GitHub or your own fork, you can run the following to install cameo for development.

$ pip install -e <path-to-cameo-repo>  # recommended

You might need to run these commands with administrative privileges if you're not using a virtual environment (using sudo for example). Please check the documentation for further details.

Documentation and Examples

Documentation is available on cameo.bio. Numerous Jupyter notebooks provide examples and tutorials and also form part of the documentation. They are also availabe in executable form on (try.cameo.bio). Furthermore, course materials for a two day cell factory engineering course are available here.

High-level API (for users)

Compute strain engineering strategies for a desired product in a number of host organisms using the high-level interface (runtime is on the order of hours).

from cameo.api import design
design(product='L-Serine')

Output

The high-level API can also be called from the command line.

$ cameo design --product vanillin

For more information run

$ cameo --help

Low-level API (for developers)

Find gene knockout targets using evolutionary computation.

from cameo import models
from cameo.strain_design.heuristic import GeneKnockoutOptimization
from cameo.strain_design.heuristic.objective_functions import biomass_product_coupled_yield

model = models.bigg.e_coli_core
obj = biomass_product_coupled_yield(
    model.reactions.Biomass_Ecoli_core_w_GAM,
    model.reactions.EX_succ_e,
    model.reactions.EX_glc_e)
ko = GeneKnockoutOptimization(model=model, objective_function=obj)
ko.run(max_evaluations=50000, n=1, mutation_rate=0.15, indel_rate=0.185)

Output

Predict heterologous pathways for a desired chemical.

from cameo.strain_design import pathway_prediction
predictor = pathway_prediction.PathwayPredictor(model)
pathways = predictor.run(product="vanillin")

Output

Contributions

..are very welcome! Please read the guideline for instructions how to contribute.