Merge pull request #40 from sedos-project/develop

Merge pull request #38 and #39 from sedos-project/develop
sedos-project · Oct 18, 2024 · 0bdd3d9 · 0bdd3d9
2 parents 272f30c + 7d6e5fa
commit 0bdd3d9
Show file tree

Hide file tree

Showing 28 changed files with 1,877 additions and 182 deletions.
diff --git a/.idea/.gitignore b/.idea/.gitignore
diff --git a/docs/data_requirements/nomenclature.md b/docs/data_requirements/nomenclature.md
diff --git a/docs/data_preface.md → docs/developer/data_preface.md b/docs/data_preface.md → docs/developer/data_preface.md
diff --git a/docs/data_requirements/input_data.md → ...developer/data_requirements/input_data.md b/docs/data_requirements/input_data.md → ...developer/data_requirements/input_data.md
diff --git a/docs/data_requirements/licensing.md → .../developer/data_requirements/licensing.md b/docs/data_requirements/licensing.md → .../developer/data_requirements/licensing.md
diff --git a/docs/data_requirements/metadata.md → docs/developer/data_requirements/metadata.md b/docs/data_requirements/metadata.md → docs/developer/data_requirements/metadata.md
diff --git a/docs/data_requirements/ontology.md → docs/developer/data_requirements/ontology.md b/docs/data_requirements/ontology.md → docs/developer/data_requirements/ontology.md
diff --git a/docs/data_requirements/overview.md → docs/developer/data_requirements/overview.md b/docs/data_requirements/overview.md → docs/developer/data_requirements/overview.md
@@ -26,6 +26,6 @@ A generalized representation of a datapackage is shown in the figure below. A da
 * **metadata** - describing the structure of the datamodel, and providing context to the data. 
 
 
-![datapackage](../graphics/datapackage.jpg)
+![datapackage](../../graphics/datapackage.jpg)
 
 
diff --git a/docs/faq.md → docs/developer/faq.md b/docs/faq.md → docs/developer/faq.md
@@ -91,7 +91,7 @@ This section centers around the data model usage.
 1. ??? question "In which form should the sources be entered in the CSV tables?"
 
         **Answer:** Please set your bibtexkey as the following pattern: <br><br>
-         **[AP-number][author][year]** <br><br>
+         **(AP-number)(author)(year)** <br><br>
          ```
          {'capacity_e_inst': '8Kraft2021b, 8ADAC2023', 'capacity_tra_connection_flex_max': '8Kraft2021b, 8ADAC2023', 'capacity_tra_vehicles_inst': '8S&PG2023', 'cost_fix_tra': '8Kraft2023, 8ADAC2023, 8ADAC2023b', 'cost_inv_tra': '8Kraft2021b, 8ADAC2023', 'cost_var': '8Kraft2023, 8ADAC2023, 8ADAC2023b', 'efficiency_sto_in': '8Keil2017', 'efficiency_sto_out': '8Keil2017', 'efficiency_tra_electrical': '8Kraft2021b, 8ADAC2023', 'efficiency_tra_g2v': '8RuckeSchoe2022', 'efficiency_tra_v2g': '8RuckeSchoe2022', 'lifetime': '8Kraft2011', 'mileage': '8BaumeHautz2014, 8Progn2021', 'occupancy_rate': '8infas2018, 8AdolfBalze2014', 'sto_init': 'ownAssumption', 'sto_self_discharge': '8XuBehre2023'}
          ```

diff --git a/docs/how_to_contribute_data.md → docs/developer/how_to_contribute_data.md b/docs/how_to_contribute_data.md → docs/developer/how_to_contribute_data.md
diff --git a/docs/graphics/emission_concept.jpg b/docs/graphics/emission_concept.jpg
diff --git a/docs/index.md b/docs/index.md
@@ -1,20 +1,28 @@
 # SEDOS Documentation
 
 Welcome to the documentation of the SEDOS project!
+We developed an open-source model structure taking into account the relevant future technologies 
+for electricity, heat, other conversions, transport and industry in a sector-coupled energy world. 
+We set a strong focus on a streamlined data management process that fosters the transparency and reproducibility of the 
+open source structure. 
 
-The documentation gives an overview of the tools in SEDOS, as well as important conventions for their usage.
-In the project, we aim to establish a streamlined data management process with as much automation as practical.
+The documentation is structured in the following four main parts 
 
-The documentation is structured in two main parts 
+1. [Model Structure](visitor/structure/model_frame.md)
+2. [Reference Dataset](./visitor/data_requirements/input_data.md)
+3. [Model Application](./visitor/data_requirements/input_data.md)
+4. [Developer Instructions](./developer/how_to_contribute_data.md)
 
-1. [SEDOS-specific data requirements](./data_requirements/input_data.md) 
-2. [Instructions on how to contribute data](./how_to_contribute_data.md)
 
-
-!!! question "Just here for the data?" 
+??? question "Just here for the data?" 
 
     Find the SEDOS Reference Dataset on the **[Databus](https://databus.openenergyplatform.org/sedos-project/collections/sedos-project)** or the **[OpenEnergyPlatform](https://openenergy-platform.org/dataedit/view/model_draft?query=sedos&tags=246)**
 
+??? info "How to cite our work?"
+
+    In case you use our model structure and the related data in a scientific publication we kindly ask you to cite our 
+    publications listed in the [Further Reading](publications.md) section.
+[//]: # (    TODO: Ergänzen mit Info zu gesamten Datensatz wie zitieren? Metadaten zu den Metadaten &#40;siehe Mail Christoph an Jonas RLI&#41;)
 
 ??? info "Latest documentation version"
 

diff --git a/docs/publications.md b/docs/publications.md
@@ -0,0 +1,6 @@
+# Further Reading
+
+In case you use our model structure and the related data in a scientific publication we kindly request you to cite our open-access publication:
+
+- Reveron Baecker, Beneharo, et al. "Comprehensive and open model structure for the design of future energy systems with sector coupling." 
+Renewable and Sustainable Energy Transition (2024): 100094. DOI: [https://doi.org/10.1016/j.rset.2024.100094](https://doi.org/10.1016/j.rset.2024.100094)
diff --git a/docs/results.md b/docs/results.md
diff --git a/docs/scenarios.md b/docs/scenarios.md
Original file line number	Diff line number	Diff line change
Expand Up		@@ -26,6 +26,6 @@ A generalized representation of a datapackage is shown in the figure below. A da
		* metadata - describing the structure of the datamodel, and providing context to the data.


		![datapackage](../graphics/datapackage.jpg)
		![datapackage](../../graphics/datapackage.jpg)