Skip to content

Commit

Permalink
Update README.md
Browse files Browse the repository at this point in the history
  • Loading branch information
camiloramirezgo authored Sep 17, 2019
1 parent 1d3024e commit 3de384f
Showing 1 changed file with 3 additions and 3 deletions.
6 changes: 3 additions & 3 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -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:
Expand All @@ -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.

0 comments on commit 3de384f

Please sign in to comment.