From b30789d95f2efeb17e15bf04abc62b8a6e4dcbf0 Mon Sep 17 00:00:00 2001 From: Franziska Wegner <57569315+franziska-wegner@users.noreply.github.com> Date: Sat, 2 Dec 2023 10:11:35 -0800 Subject: [PATCH] Update README.md Datasets/Benchmark cases download Description that the CMake file downloads certain benchmark cases/ test cases automatically and incorporates them in the framework in a seamless way. --- README.md | 15 +++++++++++++++ 1 file changed, 15 insertions(+) diff --git a/README.md b/README.md index 32737418..733aff71 100644 --- a/README.md +++ b/README.md @@ -164,6 +164,21 @@ For the purpose of code documentation, the Doxy to compile and generate the repository's documentation. The `DoxyfileConfig.in` can be adapted and supports HTML (see `GENERATE_HTML`), LaTex (see `GENERATE_LATEX`), RTF (see `GENERATE_RTF`), MAN page (see `GENERATE_MAN`), XML (see `GENERATE_XML`), and DOCBOOK (see `GENERATE_DOCBOOK`) output of the documentation. Initially only html and latex is generated. The output directory is under`./documentation` and can be changed at `OUTPUT_DIRECTORY` if necessary. +

Data

+ +As mentioned in "CMake Parameter Overrides" the CMake file downloads a lot of test cases itself denoted by `EGOA_DOWNLOAD_`, which helps you to start your work faster. Each successful CMake run shows the downloaded dataset directories by + +``` +... +-- Download of data sets: +-- Download PyPSA Europe data from https://github.com/PyPSA/pypsa-eur.git into /Users/fwegner/Documents/Repositories/Public/EGOA/egoa/data/PowerGrids/PyPSA/pypsa-eur. +-- Download PyPSA ITI Collaboration data from https://git.scc.kit.edu/FN/iti-collaboration.git into /Users/fwegner/Documents/Repositories/Public/EGOA/egoa/data/PowerGrids/PyPSA/pypsa-iti-collaboration. +-- Download IEEE Power Grid data. +... +``` + +At the moment this is limited to PyPSA and the IEEE cases and will be extended eventually to other test cases. +

Summary

This repository is based on the PhD thesis "Combinatorial Problems in Energy Networks -- Graph Theoretic Models and Algorithms". The Git repository of the PhD thesis is available under Combinatorial_Problems_in_Energy_Networks.