Skip to main content

cameo - computer aided metabolic engineering & optimziation

Project description

Documentation Status 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 methods, strain design methods, access to models, that targets developers that want custom analysis workflows.

Computationally heavy methods have been parallelized and can be run on a clusters using the IPython parallelization framework (see example and documentation for more details). The default fallback is python’s multiprocessing library.

Furthermore, it exposes a high-level API to users that just want to compute promising strain designs.

You got curious? Head over to try.cameo.bio and give it a try.

Installation

Use pip to install Cameo from PyPI (we recommend doing this inside a virtual environment).

pip install cameo

We highly recommend updating pip beforehand (pip install pip --upgrade).

In case you downloaded the source code, run

pip install -e .  # recommended

while you are in the top level directory. You might need to run these commands with administrative privileges if you’re not using a virtual environment (using sudo for example).

Examples

A number of examples are available as static (nbviewer.ipython.org) or executable Jupyter (née IPython) notebooks (try.cameo.bio).

High-level API (for users)

Compute strain engineering strategies for a desired product in a number of host organisms using the high-level interface.

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

Output

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

Dependencies

This library depends on:

  • cobrapy for constraint-based modeling

  • optlang for heuristic optimization and mathematical programming

Furthermore, the following dependencies are needed:

  • numpy and scipy for obvious reasons.

  • IPython is needed for parallel computations and notebook interface.

  • bokeh is needed for reporting progress and plotting in the IPython notebook interface.

  • pandas is needed because most functions returns results as pandas DataFrames.

  • inspyred for evolutionary computations.

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

cameo-0.4.9.tar.gz (13.0 MB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

cameo-0.4.9-py2.py3-none-any.whl (11.5 MB view details)

Uploaded Python 2Python 3

File details

Details for the file cameo-0.4.9.tar.gz.

File metadata

  • Download URL: cameo-0.4.9.tar.gz
  • Upload date:
  • Size: 13.0 MB
  • Tags: Source
  • Uploaded using Trusted Publishing? No

File hashes

Hashes for cameo-0.4.9.tar.gz
Algorithm Hash digest
SHA256 ebc270da0fa6cfff6b730e31688d8751d8f60bc0fa2df11e530037aa523fc53a
MD5 aa698f858fdaaf82b60256b2c5d1f5b2
BLAKE2b-256 b253a30819c58e28ec01d44ab86d76c3b7a1993043681dfc9c2e26711b9ce297

See more details on using hashes here.

File details

Details for the file cameo-0.4.9-py2.py3-none-any.whl.

File metadata

File hashes

Hashes for cameo-0.4.9-py2.py3-none-any.whl
Algorithm Hash digest
SHA256 0e7530489271f68f4c1ce2bf9cff53facef6123c7242b7a981999a7fd86184b2
MD5 c9a5c7ddde7daf3058be81781e311c8c
BLAKE2b-256 7a2526817f8cd99c95e66d135f9283a79d7f1b2394a3a72b62514531cd2ffecb

See more details on using hashes here.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page