Skip to main content

cameo - computer aided metabolic engineering & optimization

Project description

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.

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.10.3.tar.gz (13.6 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.10.3-py2.py3-none-any.whl (13.9 MB view details)

Uploaded Python 2Python 3

File details

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

File metadata

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

File hashes

Hashes for cameo-0.10.3.tar.gz
Algorithm Hash digest
SHA256 3eb008cdb9c2f3716ec9e3d45bd553e430e8cc2e3ca085011fa192eeacf49c9f
MD5 833fe7deacfc92330b89c6378c626bf7
BLAKE2b-256 b41f70923348f0c20678b1ab3a98ab4aa42fbad4905aa8b33752b9cca7a523a8

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for cameo-0.10.3-py2.py3-none-any.whl
Algorithm Hash digest
SHA256 6b2dbfc68e9e00df9cace50eb75f50ae6aa526063e4fd0bd1fa19382919d3b37
MD5 308db6debadfad9b1ecfcd0f8c0b9267
BLAKE2b-256 a29e6afb2b0be914cacf5a95458010e1b5a323537674ea6d8bc52f5c0da6191e

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