From 50527ed4d9202eb97fd2437671788a216555df91 Mon Sep 17 00:00:00 2001 From: Will Usher Date: Fri, 30 Aug 2019 15:58:03 +0200 Subject: [PATCH] Updated readme --- README.md | 9 +++++---- 1 file changed, 5 insertions(+), 4 deletions(-) diff --git a/README.md b/README.md index a51e8b4..d4ed0fc 100644 --- a/README.md +++ b/README.md @@ -1,15 +1,16 @@ # JRC TEMBA Analysis -To reproduce the results, run `bash run_analysis.sh` +You can view the source code for this workflow in the [repository](https://github.com/KTH-dESA/jrc_temba) This repository contains all the scripts and data necessary to reproduce the work for JRC TEMBA project. ## Setup and Installation -To run this analysis you need to install GLPK and one of CBC or CPLEX +To run this analysis you need to install GLPK and a solver such as CBC, CPLEX or Gurobi -You should also have Python >=3.6 environment setup with the following dependencies: +You should also have Python >=3.6 environment setup with the following dependencies ideally +using miniconda so that snakemake can manage custom environments for each of the workflow tasks: - `pandas` - `xlrd` @@ -25,7 +26,7 @@ number of threads to use e.g. `snakemake -j 8`. ## Folder structure - Input data are stored in `.xlsx` Excel files in the `input_data` folder -- The OSeMOSYS model file is stored in `model` folder +- A modified OSeMOSYS model file is stored in `model` folder - Temporary output data is stored in the `output_data` folder - Final results are stored in `results` - All the scripts for intermediate processing are stored in the `scripts` folder