Skip to content

beatrizgj/FLYCOP

master
Switch branches/tags

Name already in use

A tag already exists with the provided branch name. Many Git commands accept both tag and branch names, so creating this branch may cause unexpected behavior. Are you sure you want to create this branch?
Code

Latest commit

 

Git stats

Files

Permalink
Failed to load latest commit information.
Type
Name
Latest commit message
Commit time
 
 
 
 
 
 
 
 
 
 
title author
FLYCOP
Beatriz García-Jiménez

FLYCOP

FLYCOP (FLexible sYnthetic Consortium OPtimization) is a framework that improves the understanding of the metabolic behaviour of microbial consortia and to automatize the modeling of those communities, by designing and optimizing enginered microbial consortia given a particular goal.

FLYCOP contributes with multiple and assorted applications, such as simulating different scenarios before in-vivo experiments; defining medium composition and detecting limiting nutrients; discovering the biological metric optimized in an evolutionary process; optimizing cross-feeding relationships; optimizing strain ratios in the consortium; etc.

Citation: This repository contains the code and configuration files reproducing the study cases described in (please, cite us if you use FLYCOP in your work):

Beatriz García-Jiménez, José Luis García, Juan Nogales; FLYCOP: metabolic modeling-based analysis and engineering microbial communities, Bioinformatics, Volume 34, Issue 17, 1 September 2018, Pages i954–i963, doi: 10.1093/bioinformatics/bty561

So far, FLYCOP has been applied to design and optimize 3 different microbial consortia:

  • Co-growth 4 auxotrophic E. coli [coGrowth4Ecoli]
  • Describing microbial community evolution, in E. coli polimorphism [ecoliLongTerm]
  • S. elongatus-P. putida synthetic consortium producing bio-plastic (polyhydroxyalkanoate, PHA) [synKtPHA]

Installation

FLYCOP software run in LINUX OS. FLYCOP can be run in (a) a docker container (recommended) or (b) installing the pre-requisites individual software by yourself.

(a) Docker container (recommended):

Once you have the docker daemon running, download the docker-flycop container from the cloud:

docker pull beatrizgj/docker-flycop

And run the FLYCOP container:

docker run -it beatrizgj/docker-flycop

Or you could use additional parameters (-it,-env,-volume) to have an interactive bash shell, exporting the display, and sharing a folder between the local host (/home/user/DockerOutput/) and the container (/home/host/) to allow moving files easily.

xhost +local:root
docker run -it --env="DISPLAY" --env="QT_X11_NO_MITSHM=1" --volume="/tmp/.X11-unix:/tmp/.X11-unix:rw" --volume="/home/user/DockerOutput/:/home/host/:rw" beatrizgj/docker-flycop
xhost -local:root

Define the location of your personal gurobi solver license (required by COMETS) in the container (for example, <path_to_gurobi_license>=/home/user):

GRB_LICENSE_FILE=<path_to_gurobi_license>/gurobi.lic

Move to the FLYCOP software directory:

cd FLYCOP

(b) Your-self installation: basic pre-requisites

FLYCOP pipeline uses some software (and all their dependencies), which must be installed before:

  • COBRApy: python package (checked with v0.5.11)
  • COMETS (v2.0.3) (faster with gurobi solver)
  • SMAC (in Java, v2.10.03)
    Additionally, R software is required.

Input and output description

After required software installation, you can run FLYCOP for the 3 microbial consortia where FLYCOP was applied with the files provided in this site. If you want to apply FLYCOP to design and optimize a new consortium, you could take as template the available files from one of the optimized consortia, and then to code the following required inputs to FLYCOP, described here:

INPUT:

  1. FLYCOP pipeline ad-hoc for a specific microbial consortium [consortiumPrefixFLYCOP.py]: it means a python script to run a single configuration, including how to: 1) dynamically update single models and community parameters depending on the parametrized consortium configuration, 2) simulate that configured consortium in a dynamic way, and 3) evaluate the quality of the given consortium using a fitness function. This file also must include the method initialize_models() to update the original single strain genome scale metabolic models (GEMs) to use as base in the consortium optimization.
  2. ConsortiumPrefix_TemplateFolder [ConsortiumPrefix_TemplateOptimizeConsortiumV<A>]: a directory including a layout file with the culture medium definition, the original GEMs (in matlab format) and the consortium simulation configuration.
  3. Optimization configuration [consortiumPrefix_confFLYCOP_scenario_v<Y>.txt]: it defines the number of consortium configurations to evaluate (numberOfRunsLimit) and identifies the two files describing the consortium optimization:
    + Parameter values [consortiumPrefix_confFLYCOP_params_v<Z>.pcs]: it lists the range of values per parameter (in SMAC format), among those to choose by the Stochastic Local Search procedure.
    + Wrapper file [consortiumPrefix_wrapperFLYCOP_v<Y>.py]: to select the fitness function to optimize, to define the 'version identifier' for all results files, and to call the FLYCOP pipeline.

"ConsortiumPrefix_TemplateFolder" must be located in MicrobialCommunities/ directory, and the remaining input files in Scripts/ directory.

Genome-scale models

GEMs used by FLYCOP cases of study can be obtained from BiGG models database or from their respective publications (in matlab format):

OUTPUT:

FLYCOP provides different resources for robustness, sensitivity and data analysis support, being the most relevant the following ones:

  • Best configuration given the strains, media, fitness function and parameter configuration
  • Scatterplot showing explored values by each parameter
  • Correlation values and ellipse plots between different parameter and fitness values
  • Tab file with all configurations including parameter and fitness values, and some other interesting metrics (such as medium concentration of some relevant metabolites). This output would be important for further data analysis.
  • Growth curves of all explored consortium configurations

Running FLYCOP

After defining the required files for a specific microbial consortium design (see INPUT section below), you can search the best configuration with FLYCOP. This call includes an automatic data analysis of the resulting evaluated multiple consortium configurations.

sh FLYCOP.sh <consortiumPrefix> <Y> V<A> <fitnessFunction> <numberOfConfigurations>

For example (for a short run with only 10 configurations):

sh FLYCOP.sh 'ecoliLongTerm' 2 V0 'Yield' 10

Also, a particular consortium configuration can be simulated with:

cd MicrobialCommunities
cp -p -R ConsortiumPrefix_TemplateOptimizeConsortiumV<A> ConsortiumPrefix_Test<Y>
cd ConsortiumPrefix_Test<Y>
python3 ../../Scripts/consortiumPrefix_individualTestFLYCOP.py <arg1> ... <argN>

where:

  • consortiumPrefix could take value in {synKtPHA, coGrowth4Ecoli, ecoliLongTerm} for the already 3 FLYCOP designed consortia
  • <arg1> ... <argN> represents the user-given configuration values for this particular consortium which is going to be simulated and evaluated.

For example:

cd MicrobialCommunities
cp -p -R ecoliLongTerm_TemplateOptimizeConsortiumV0 ecoliLongTerm_Test2
cd ecoliLongTerm_Test2
python3 ../../Scripts/ecoliLongTerm_individualTestFLYCOP.py -10 -16 -11 -12 -6 -16 'Yield'

Several exploratory individual consortium simulations are recommended before running the complete FLYCOP pipeline.


Runtime

An individual configuration takes some minutes. However, a complete FLYCOP run usually take several hours, depending on several parameters. The main one is the number of different consortium configurations to evaluate, defined in 'consortiumPrefix_confFLYCOP_scenario_v<Y>.txt'. For 500 configurations, FLYCOP usually takes around 10-12 hours in a 16GB RAM computer. Other parameters with less influence on runtime are the number of cycles over the consortium configuration is simulated (defined in ConsortiumPrefix_TemplateOptimizeConsortiumV<A>/consortiumPrefix_layout_template.txt).


Releases

No releases published

Packages

No packages published