https://github.com/thibaultlatrille/codonsimulations
https://github.com/thibaultlatrille/codonsimulations
Last synced: 8 months ago
JSON representation
- Host: GitHub
- URL: https://github.com/thibaultlatrille/codonsimulations
- Owner: ThibaultLatrille
- Created: 2021-02-01T15:34:25.000Z (over 4 years ago)
- Default Branch: master
- Last Pushed: 2021-02-17T15:17:33.000Z (over 4 years ago)
- Last Synced: 2025-01-22T22:56:51.550Z (9 months ago)
- Language: Python
- Size: 31.3 KB
- Stars: 0
- Watchers: 2
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# Genotype-Phenotype-FitnessModel
This repository is meant to provide the necessary scripts and data to reproduce the figures shown in the manuscript.
The experiments can either run on a local computer or in a cluster configuration (slurm).
The experiments are meant to run on Linux/Unix/MacOS operating systems.
If problems and/or questions are encountered, feel free to [open issues](https://github.com/ThibaultLatrille/CodonSimulations/issues).
## 0. Local copy
Clone the repository and cd to the dir.
```
git clone https://github.com/ThibaultLatrille/CodonSimulations
cd CodonSimulations
```
## 1. Installation
### Installation on debian
Install the compiling toolchains:
```
sudo apt install -qq -y make cmake clang
```
Clone and compile the C++ code for *SimuEvol*
```
git clone https://github.com/ThibaultLatrille/SimuEvol && cd SimuEvol && git checkout v1.0 && make release && cd ..
```
Install python3 packages
```
sudo apt install -qq -y python3-dev python3-pip screen
pip3 install snakemake numpy matplotlib pandas ete3 --user
```
## 2. Run the simulation and reproduce the figures
To reproduce a figures of the manuscript, one can use the config files of the simulations (.yaml).
```
python3 ./scripts/simulated_experiment.py --config config.yaml --name Simulations -j 4
```
The script _simulated_experiment.py_ also contains options to run the simulations on a cluster (slurm).
## 3. Add features or debug in the python scripts
You made modifications to one of the python script, a notebook, this README.md, or you added new features.
You wish this work benefits to all (futur) users of this repository?
Please, feel free to open a [pull-request](https://github.com/ThibaultLatrille/CodonSimulations/pulls)
## 4. Add features or debug in *SimuEvol*
You made modifications to the C++ code of the simulation framework *SimuEvol*.
You wish this changes benefit to all users of these software?
Please, feel free to open pull-requests in the respective GitHub repository:
* https://github.com/ThibaultLatrille/SimuEvol
## Licence
The MIT License (MIT)
Copyright (c) 2019 Thibault Latrille
Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:
The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.