Skip to content

Latest commit

 

History

History
62 lines (48 loc) · 3.33 KB

README.md

File metadata and controls

62 lines (48 loc) · 3.33 KB

A power modeler for Västra Götalandsregionen (VGR)

Version: WIP

This repo contains software for modelling expanded energy production in Västra Götalandsregionen (VGR) of Sweden.

  1. One or more scenarios can be built, run, and analyzed in jupyter notebooks using the helper functions in /library
  2. Data for a large set of scenarios can be generated with the scripts in /generator. This data can be accessed through files (and soon a simple API)
  3. The data from generator can be analyzed in the Streamlit dashboard in /dashboard

The overall purpose is to allow the user to build and tinker with a general model in a notebook, and then feed this model into a generator to run scenarios that can then be analyzed through an API or in our dashaboard.

Structure of the repo

  • dashboard: contains the code for the Streamlit dashboard
  • generator: contains the code to run all the scenarios and save results to files (will soon contain code to build the API)
  • input: contains all the input required for running one or more scenarios
  • library: contains general functions that can be used both by the generator and in notebooks
  • notebooks: contains an example notebook
  • api: empty at first, contains all the output data from running generator

Installation

PyPSA-VGR relies on a set of other Python packages to function. We recommend using the package manager mamba to install them and manage your environments. For instructions for your operating system follow the mamba installation guide. You can also use conda equivalently.

The package requirements are curated in the environment.yaml file. The environment can be installed and activated using

mamba env create -f environment.yaml
mamba activate pypsa-vgr

The equivalent commands for conda would be

conda env create -f environment.yaml
conda activate pypsa-vgr

Dev environment setup

To avoid Jupyter output to be included in commits, run following command:

git config filter.strip-notebook-output.clean jupyter "nbconvert --ClearOutputPreprocessor.enabled=True --to=notebook --stdin --stdout --log-level=ERROR"

Data used in scripts

GIS data