Merge pull request #9 from drifter089/devcontainer

dev containers

.devcontainer/devcontainer.json

@@ -4,5 +4,6 @@
   "image": "ghcr.io/drifter089/pypsa-eur:latest",
   "workspaceMount": "source=${localWorkspaceFolder},target=/workspaces,type=bind,consistency=cached",
   "initializeCommand": "docker pull ghcr.io/drifter089/pypsa-eur:latest",
-  "workspaceFolder": "/workspaces"
+  "workspaceFolder": "/workspaces",
+  "postAttachCommand": "bash .devcontainer/setup.sh"
 }

.devcontainer/setup.sh

@@ -3,4 +3,4 @@
 cp --recursive ../pypsa-eur/* ./ 
 echo 'solved tutorial files are copied to workspace'
 
-cp .devcontainer/welcome-message.txt /usr/local/etc/vscode-dev-containers/first-run-notice.txt
+cat .devcontainer/welcome-message.txt 

.devcontainer/welcome-message.txt

@@ -1,3 +1,5 @@
+
+
 👋 Welcome to pypsa-eur contribution in a dev container! 
      Works in VS Code, or in docker using the devcontainer cli
 
@@ -8,4 +10,4 @@ For details about dev containers see https://containers.dev
 
 The configuration for the dev container is in the .github/.devcontainer folder.
 
-🔍 To explore VS Code to its fullest, search using the Command Palette (Cmd/Ctrl + Shift + P or F1).
+🔍 To explore VS Code to its fullest, search using the Command Palette (Cmd/Ctrl + Shift + P or F1).+

README.md

@@ -13,85 +13,30 @@ SPDX-License-Identifier: CC-BY-4.0
 [![REUSE status](https://api.reuse.software/badge/github.com/pypsa/pypsa-eur)](https://api.reuse.software/info/github.com/pypsa/pypsa-eur)
 [![Stack Exchange questions](https://img.shields.io/stackexchange/stackoverflow/t/pypsa)](https://stackoverflow.com/questions/tagged/pypsa)
 
+
 # PyPSA-Eur: A Sector-Coupled Open Optimisation Model of the European Energy System
 
-PyPSA-Eur is an open model dataset of the European energy system at the
-transmission network level that covers the full ENTSO-E area. The model is suitable both for operational studies and generation and transmission expansion planning studies.
-The continental scope and highly resolved spatial scale enables a proper description of the long-range
-smoothing effects for renewable power generation and their varying resource availability.
+The model is described in the [documentation](https://pypsa-eur.readthedocs.io)
+and in the paper
+[PyPSA](https://github.com/PyPSA/PyPSA).
 
 
+# Devcontainers
 
+https://containers.dev/guide/prebuild
+https://github.com/craiglpeters/kubernetes-devcontainer
 
-The model is described in the [documentation](https://pypsa-eur.readthedocs.io)
-and in the paper
-[PyPSA-Eur: An Open Optimisation Model of the European Transmission
-System](https://arxiv.org/abs/1806.01613), 2018,
-[arXiv:1806.01613](https://arxiv.org/abs/1806.01613).
-The model building routines are defined through a snakemake workflow.
-Please see the [documentation](https://pypsa-eur.readthedocs.io/)
-for installation instructions and other useful information about the snakemake workflow.
-The model is designed to be imported into the open toolbox
-[PyPSA](https://github.com/PyPSA/PyPSA).
+https://github.com/drifter089/pypsa-eur/pkgs/container/pypsa-eur
+
+For details about dev containers see https://containers.dev
+
+
+# Debug
+
+
+https://stackoverflow.com/questions/78677266/how-to-debug-scripts-for-pypsa-eur
+https://code.visualstudio.com/docs/python/debugging#_example
 
-**WARNING**: PyPSA-Eur is under active development and has several
-[limitations](https://pypsa-eur.readthedocs.io/en/latest/limitations.html) which
-you should understand before using the model. The github repository
-[issues](https://github.com/PyPSA/pypsa-eur/issues) collect known topics we are
-working on (please feel free to help or make suggestions). The
-[documentation](https://pypsa-eur.readthedocs.io/) remains somewhat patchy. You
-can find showcases of the model's capabilities in the Joule paper [The potential
-role of a hydrogen network in
-Europe](https://doi.org/10.1016/j.joule.2023.06.016), another [paper in Joule
-with a description of the industry
-sector](https://doi.org/10.1016/j.joule.2022.04.016), or in [a 2021 presentation
-at EMP-E](https://nworbmot.org/energy/brown-empe.pdf). We do not recommend to
-use the full resolution network model for simulations. At high granularity the
-assignment of loads and generators to the nearest network node may not be a
-correct assumption, depending on the topology of the underlying distribution
-grid, and local grid bottlenecks may cause unrealistic load-shedding or
-generator curtailment. We recommend to cluster the network to a couple of
-hundred nodes to remove these local inconsistencies. See the discussion in
-Section 3.4 "Model validation" of the paper.
-
-
-![PyPSA-Eur Grid Model](doc/img/elec.png)
-
-The dataset consists of:
-
-- A grid model based on a modified [GridKit](https://github.com/bdw/GridKit)
-  extraction of the [ENTSO-E Transmission System
-  Map](https://www.entsoe.eu/data/map/). The grid model contains 7072 lines
-  (alternating current lines at and above 220kV voltage level and all high
-  voltage direct current lines) and 3803 substations.
-- The open power plant database
-  [powerplantmatching](https://github.com/FRESNA/powerplantmatching).
-- Electrical demand time series from the
-  [OPSD project](https://open-power-system-data.org/).
-- Renewable time series based on ERA5 and SARAH, assembled using the [atlite tool](https://github.com/FRESNA/atlite).
-- Geographical potentials for wind and solar generators based on land use (CORINE) and excluding nature reserves (Natura2000) are computed with the [atlite library](https://github.com/PyPSA/atlite).
-
-A sector-coupled extension adds demand
-and supply for the following sectors: transport, space and water
-heating, biomass, industry and industrial feedstocks, agriculture,
-forestry and fishing. This completes the energy system and includes
-all greenhouse gas emitters except waste management and land use.
-
-This diagram gives an overview of the sectors and the links between
-them:
-
-![sector diagram](doc/img/multisector_figure.png)
-
-Each of these sectors is built up on the transmission network nodes
-from [PyPSA-Eur](https://github.com/PyPSA/pypsa-eur):
-
-![network diagram](https://github.com/PyPSA/pypsa-eur/blob/master/doc/img/base.png?raw=true)
-
-For computational reasons the model is usually clustered down
-to 50-200 nodes.
-
-Already-built versions of the model can be found in the accompanying [Zenodo
-repository](https://doi.org/10.5281/zenodo.3601881).
 
 # Contributing and Support
 We strongly welcome anyone interested in contributing to this project. If you have any ideas, suggestions or encounter problems, feel invited to file issues or make pull requests on GitHub.