Skip to content

Commit

Permalink
Updated readme
Browse files Browse the repository at this point in the history
  • Loading branch information
willu47 committed Aug 30, 2019
1 parent 599fd8d commit 50527ed
Showing 1 changed file with 5 additions and 4 deletions.
9 changes: 5 additions & 4 deletions README.md
Original file line number Diff line number Diff line change
@@ -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`
Expand All @@ -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

0 comments on commit 50527ed

Please sign in to comment.