From 3de384f64666e8d7c36cef0829d9e83000d32e05 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Camilo=20Ram=C3=ADrez?= Date: Tue, 17 Sep 2019 13:40:21 +0200 Subject: [PATCH] Update README.md --- README.md | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) diff --git a/README.md b/README.md index 7c4eaa3..76c27de 100644 --- a/README.md +++ b/README.md @@ -20,10 +20,10 @@ Run the workflow in parallel: `snakemake --use-conda --cores 3` Plot the graph of the workflow: `snakemake --use-conda --cores 3 plot_dag` -# Dashboard instructions +## Dashboard instructions A companion dashboard to visualize the results from the OSeMOSYS model is provided in the `dashboard` folder. Instructions for its installation and how to run it are presented below. -## Installation instructions: +### Installation instructions: 1. You should have installed a distribution of python 3.x in your computer. 2. If you are using the Anaconda distribution of Python, install all python packages required listed in the `requirements.txt` file using the `conda install -c conda-forge --file requirements.txt` command in your computer bash or anaconda prompt. Alternatively, you can create a virtual environment using venv and install all required packages there using pip: @@ -34,7 +34,7 @@ virtualenv -p python venv source venv/Scripts/activate pip install -r requirements.txt ``` -## Running the dashboard: +### Running the dashboard: After installing all required packages, the dashboard can be run locally by running `python app.py` in your bash or anaconda prompt. A local host URL will be displayed as: http://127.0.0.1:8050/ copy it and paste it in your browser. To exit the app, type CTRL + C a couple of times in your bash.