First round MIME:

1. Simulate sequence variants in pool of a wild type sequence (random mutagenesis 1)
2. Prove ground-truth or randomly assign fitness values for each position-wise mutation and pairwise epistatic effects
3. Derive species frequencies in equilibrium
4. Add statistical noise
5. Output positionwise mutant counts, sequences and the groundtruth

Second round MIME:

6. Read in results from first round of MIME
7. Simulate sequence variants in unbound pool of first round experiment (random mutagenesis 2)
8. Derive species frequencies in equilibrium
9. Add statistical noise
10. Output positionwise mutant counts, sequences and the groundtruth

Detailed explanation will be added

Go into the MIMESim directory and create a build directory and cmake and make from there.

cd /path/to/MIMESim
mkdir build
cd build
cmake ..
make

This will create the binary file .../MIMESim/build/bin/MIMESim_prog

Running the program with an optional parameter, giving the path to the result directory. If no parameter is given, the output will be written to the newly created directory ../results.

/path/to/MIMESim_prog

First round simulation. Program will create dir ./results and write outputs and (default) params to this folder.

/path/to/MIMESim_prog --working-dir path/to/read/and/write

First round simulation. Program will use parameters.txt from working-dir if available.

/path/to/MIMESim_prog [--working-dir path/to/read/and/write] --read-gt

First round simulation. Program will use ground truth files (single_kds.txt, pairwise_epistasis.txt) from working-dir (default=.../results). Exits with error if files are not available.

/path/to/MIMESim_prog [--working-dir path/to/read/and/write] --previous-dir path/to/results/first/round/exp 

Second round simulation. Program will use the outputs from a previous first-round simulation stored in previous-path as starting point of a second round.

If you want to set the simulation parameters, create the parameters.txt file in the desired result directory and add the following parameter names and values (tab separated):

Comments:

1. Right now, kd_wt is always 1, but this can be easily adjusted in the code.
2. Epistasis values (strength of interaction) are sampled from a standard log normal distribution.
3. Possible values for epi_restrict are 0,1,2:

• 0=unrestricted, all possible pairs of functional mutations mut1=(pos1, symbol1), mut2=(pos2, symb2) with pos1!=pos2, kd_mut1!=kd_wt and kd_mut2!=kd_wt are assigned an epistasis value with probability p_epistasis.
• 1=semi-restricted, each mutation can only be in an epistatic interaction with one other mutation. From all functional mutations mut=(pos, symbol), Mf, Mf/2 pairs are assigned an epistasis value with probability p_epistasis.
• 2=restricted, same as 1, only now positions themselves are mutually exclusive: each position can only be in an epistatic interaction with one other position.

• 1d counts (with noise)
• 2d counts (with noise)
• full-length sequences (with noise)
• species (sequence variants without sequencing noise)
• amount of free protein in equilibrium, per binding experiment
• ground truth Kds (position and pairwise) and epistasis values

result_directory1
├── 1d
│   ├── 1.txt
│   ├── 2.txt
│   ├── 3.txt
│   └── 4.txt
├── 2d
│   ├── 1.txt
│   ├── 2.txt
│   ├── 3.txt
│   └── 4.txt
├── free_protein_1_2.txt
├── free_protein_3_4.txt
├── pairwise_epistasis.txt
├── pairwise_kds.txt
├── parameters.txt
├── sequences
│   ├── 1.txt
│   ├── 2.txt
│   ├── 3.txt
│   └── 4.txt
├── single_kds.txt
└── species
    ├── 1.txt
    ├── 2.txt
    ├── 3.txt
    └── 4.txt

results_directory2
├── 1d
│   ├── 5.txt
│   ├── 6.txt
│   ├── 7.txt
│   └── 8.txt
├── 2d
│   ├── 5.txt
│   ├── 6.txt
│   ├── 7.txt
│   └── 8.txt
├── free_protein_5_6.txt
├── free_protein_7_8.txt
├── pairwise_epistasis.txt
├── pairwise_kds.txt
├── parameters.txt
├── sequences
│   ├── 5.txt
│   ├── 6.txt
│   ├── 7.txt
│   └── 8.txt
├── single_kds.txt
└── species
    ├── 5.txt
    ├── 6.txt
    ├── 7.txt
    └── 8.txt

• 1 = wt_bound,
• 2 = wt_unbound,
• 3 = mut_bound,
• 4 = mut_unbound,
• 5 = mut_bound_bound,
• 6 = mut_bound_unbound,
• 7 = mut_unbound_bound,
• 8 = mut_unbound_unbound,

Test should be run from within the main directory /path/to/MIMESim, for example:

cd /path/to/MIMESim
./build/bin/all_tests