Merge pull request #80 from OpenEnergyPlatform/feature-74-factsheet-docs

OEKG & scenario bundle docs

.gitignore

@@ -2,4 +2,6 @@
 /env
 
 # mkdocs build
-/site
+/site
+
+.DS_Store

compendium/family_members/knowledge-representation/oekg.md

@@ -1,4 +1,15 @@
 # Open Energy Knowledge Graph (OEKG)
 
 The Open Energy Knowledge Graph (OEKG) is a network of entities, their semantic types, properties, and relationships for the energy system analysis domain. It is based on the RDF standard and uses the Turtle format.
-Fundamentally, the development is according to the Open Energy Ontology (OEO).
+Fundamentally, the development is according to the Open Energy Ontology (OEO).
+
+## Structure
+
+The structure of the OEKG is based on graph of nodes and relations that are stored in a database. While the Open Energy Ontology offers a **comprehensive understanding** of the energy domain and a structured framework of interconnected concepts. Furthermore, the open energy knowledge graph has been carefully designed to effectively present **detailed information about specific instances** and also store these specific instances.
+
+The following  illustrates a generic model of the [scenario bundles](../templates-and-specification/scenario-bundles.md) which is the main instance available in the OEKG.
+
+<figure markdown>
+  ![Image title](../../img/OEKG_Schema_Vertical_Layout.png)
+  <figcaption>The connection between Open Energy Ontology (OEO) and the Open Energy Knowledge Graph (OEKG)</figcaption>
+</figure>

compendium/family_members/software-architecture/open-energy-platform.md

@@ -28,8 +28,10 @@ In addition to Django apps, there are other components that serve specific funct
 | theming                 | Configures the global design using Bootstrap5 and provides design components that are imported into the software components listed above. This is where the user-friendly and aesthetic presentation of the web application is configured.                                |
 | oedb_datamodels         | Implements database migration schemas used for migrating changes to the database (OEDB). These schemas are utilized by an imported software tool to manage all changes to the Open Energy Database from within the Django application.                             |
 
+The oeplatofrm Website-Project is actively developed on [GitHub](https://github.com/OpenEnergyPlatform/oeplatform).
 
 ## Users
+
 The user concept allows us to define specific user groups who will interact with the Open Energy Platform in unique ways. Our goal is to facilitate effective data management, simplifying processes such as sharing, reproducing, versioning, and publishing in the energy system research domain. We have identified three distinct user roles.
 
 In certain cases, the tasks that users need to perform may be complex and require a learning process. In such instances, it is essential for developers to contribute to these tasks until the community gains proficiency and expertise.
@@ -54,5 +56,3 @@ The Open Peer Review of the Open Energy Family is integrated into the Open Energ
   ![Image title](../../img/oep-use-case.png){ width="700" }
   <figcaption>Image caption</figcaption>
 </figure>
-
-

compendium/family_members/templates-and-specification/factsheets.md

@@ -1,10 +1,27 @@
 # Factsheets
 
+The Factsheets on the OEP are a standardized collection and presentation of
+information about frameworks, software, and scenarios used in climate and
+energy system modelling.
+The use of interactive fields and pre-defined responses is designed to make
+it easy to insert data and filter for existing entries.
+
 ## Framework Factsheet
 
+The Frameworks Factsheets are designed to show the different software frameworks
+used for modeling energy system and energy system analysis.
+These frameworks offer a systematic approach to simulate, analyze,
+and sometimes optimize energy systems comprising diverse energy sources,
+conversion technologies, transmission networks, and consumption patterns.
+The factsheets aim to provide insights into the methodologies and applications
+of these frameworks.
 
-## Model Factsheet
+!!! info "Access the Framework Factsheets"
+    [openenergyplatform.org/factsheets/frameworks/](https://openenergyplatform.org/factsheets/frameworks/)
 
+## Model Factsheet
 
-## Scenario Factsheet
+The [model factsheet](http://openenergy-platform.org/ontology/oeo/OEO_00000277) characterizes models used in energy system analysis in a structured way regarding important characteristics, such as their scope and [license](https://openenergy-platform.org/ontology/oeo/OEO_00020015) and their developing [institutions](https://openenergy-platform.org/ontology/oeo/OEO_00000238). You are developing a model? Then you can inform about its characteristics [here](https://openenergy-platform.org/ontology/oeo/OEO_00000238). The models available as a factsheet can be integrated as an element into a [scenario bundle](https://openenergy-platform.org/scenario-bundles/main) which weaves together important information about [scenarios](http://openenergy-platform.org/ontology/oeo/OEO_00000364), such as the model used for conducting a [scenario projection](https://openenergy-platform.org/ontology/oeo/OEO_00010262), [data](https://openenergy-platform.org/ontology/oeo/IAO_0000027) provided on the OEP, and [publications](https://openenergy-platform.org/ontology/oeo/OEO_00020012).
 
+!!! info "Access the Model Factsheets"
+    [openenergyplatform.org/factsheets/models/](https://openenergy-platform.org/factsheets/models/)

compendium/family_members/templates-and-specification/scenario-bundles.md

@@ -0,0 +1,46 @@
+# Scenario Bundles
+
+The Scenario Bundles provide a interface to store and present dedicated information about specific scenarios for which projection data is available on the OEP.
+They are based on the concepts available in the [Open Energy Ontology](../knowledge-representation/oeo.md) (OEO)
+and the [Open Energy Knowledge Graph](../knowledge-representation/oekg.md) (OEKG).
+This enables the OEP to include information on the scenario projection
+data available in the database, the corresponding frameworks and models applied (available as [factsheets](factsheets.md) on the OEP),and the study context.
+
+In detail we specify scenario bundles as:
+
+[Scenario bundles](http://openenergyplatform.org/ontology/oeo/OEO_00020227) weave together important information about one or more [scenarios](http://openenergyplatform.org/ontology/oeo/OEO_00000364). They inform about [studies](http://openenergyplatform.org/ontology/oeo/OEO_00020011) made based on a scenario, including publications (= [study report](http://openenergyplatform.org/ontology/oeo/OEO_00020012)).
+
+If there is quantitative [input data](http://openenergyplatform.org/ontology/oeo/OEO_00030029) and / or [output data](http://openenergy-platform.org/ontology/oeo/OEO_00020013) available on the OEP, the scenario bundles can link to that data, too. They can also inform about [models](http://openenergyplatform.org/ontology/oeo/OEO_00020353) (if available as a [model factsheet](https://openenergyplatform.org/factsheets/models/)) and frameworks (if available as a [framework factsheet](https://openenergyplatform.org/factsheets/frameworks/)) that were used to project a scenario into the future (= [scenario projection](http://openenergyplatform.org/ontology/oeo/OEO_00010262)).
+
+In a nutshell: A scenario bundle provides you with all relevant information to understand a scenario's context and to ease a potential re-use of quantitative data for your purposes.
+
+!!! info "Access the Scenario Bundles"
+    [openenergyplatform.org/scenario-bundles/main](https://openenergy-platform.org/scenario-bundles/main)
+
+## Scenario Bundles on the OpenEnergyPlatform
+
+The main page displays a list of bundles created by various users and organizations. Users can select a bundle to view it in detail or click the scenario badges to start a qualitative comparison.
+
+<figure markdown>
+  ![Image title](../../img/Bundles_main_page.png)
+  <figcaption>List of bundles</figcaption>
+</figure>
+
+Bundles can be accessed in two modes: view mode, which allows users to see the bundles. The edit mode enables users to make changes to the bundles.
+
+<figure markdown>
+  ![Image title](../../img/Bundles_View_Mode.png)
+  <figcaption>View a bundle</figcaption>
+</figure>
+
+<figure markdown>
+  ![Image title](../../img/Bundles_Edit_Mode.png)
+  <figcaption>Edit a bundle and add scenarios</figcaption>
+</figure>
+
+The comparison show scenarios from different bundles next to each other and displays similarities and differences for comparison.
+
+<figure markdown>
+  ![Image title](../../img/Bundles_Qualititative_Comparison.png)
+  <figcaption>An example of a qualititative comparison between bundles</figcaption>
+</figure>

mkdocs.yml

@@ -83,6 +83,7 @@ nav:
       - Software Tools: family_members/software-architecture/software-tools.md
     - Specification and Templates: 
       - family_members/templates-and-specification/index.md
+      - Scenario Bundles: family_members/templates-and-specification/scenario-bundles.md
       - Factsheets: family_members/templates-and-specification/factsheets.md
       - Open Energy Datamodel: family_members/templates-and-specification/open-energy-datamodel.md
       - Open Energy Metadata: family_members/templates-and-specification/open-energy-metadata.md