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 zenhub

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.

Please cite https://doi.org/10.1021/acssynbio.7b00423 if you’ve used cameo in a scientific publication.

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.11.11.tar.gz (13.7 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.11.11-py2.py3-none-any.whl (14.0 MB view details)

Uploaded Python 2Python 3

File details

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

File metadata

  • Download URL: cameo-0.11.11.tar.gz
  • Upload date:
  • Size: 13.7 MB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/1.12.1 pkginfo/1.5.0.1 requests/2.21.0 setuptools/40.8.0 requests-toolbelt/0.9.1 tqdm/4.30.0 CPython/3.5.6

File hashes

Hashes for cameo-0.11.11.tar.gz
Algorithm Hash digest
SHA256 1c43ce44263d61cf0899f97fc44477f49472c0d6ba958b01c2e85b6efa645ee9
MD5 a5d673e180e9b81591abc3c04d7130db
BLAKE2b-256 eb4b03c25c95dfce7658a44b82b3cd13135714511a4050a42f4611545466e765

See more details on using hashes here.

File details

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

File metadata

  • Download URL: cameo-0.11.11-py2.py3-none-any.whl
  • Upload date:
  • Size: 14.0 MB
  • Tags: Python 2, Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/1.12.1 pkginfo/1.5.0.1 requests/2.21.0 setuptools/40.8.0 requests-toolbelt/0.9.1 tqdm/4.30.0 CPython/3.5.6

File hashes

Hashes for cameo-0.11.11-py2.py3-none-any.whl
Algorithm Hash digest
SHA256 6e20e4cde5a0c53c31bf233cc01a436e8f031db90f570f8cd6be9c563e9c5abf
MD5 28a249909a7a7db2e6ed654ba01f260b
BLAKE2b-256 14f2d1db06d43e0d574422be457ad0d2795d01892e3fc6b78b65fca046b8f103

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