oeplatform icon indicating copy to clipboard operation
oeplatform copied to clipboard

Suggestions for improved text: Ontology overview page

Open han-f opened this issue 1 year ago • 2 comments

Description of the issue

https://openenergyplatform.org/ontology/ The text could be improved for readability. Below are some suggestions, derived with chatgpt with further editing by me. I could do this from a users perspective for any page on the oep that has a certain amount of floating text.

Ideas of solution

The Open Energy Ontology (OEO) is a dynamic domain ontology for energy system modeling, updated regularly following a to a release cycle. Access the latest version 2.3.0 here.

An ontology is a structured collection of terms and their relationships, providing clear definitions and logical interpretation. The OEO aims to create a common language for energy system modeling, bridging various disciplines.

Ontologies have diverse applications:

  • Standardising Terminology: Provides a controlled vocabulary with clear definitions, disambiguating terms.
  • Data Annotation and Integration: Enhances data integration, aggregation, and search functions
  • Templates for Data Capture: Ensures uniform and detailed reporting structures
  • Visualisation: Makes complex knowledge comprehensible through various visual formats
  • Text and Data Mining: Automates searches across resources, aiding discovery, data synthesis, and meta-analysis.

The OEO is developed within the scope of the Open Energy Family, but aims to serve the entire energy system modeling community. We encourage its use in various contexts and use cases beyond its initial scope.

Where and how can I contribute?

We welcome everyone to contribute to OEO development, a community-driven project hosted on GitHub. Explore our guidelines and wiki for detailed instructions. If you have questions, reach out via the OEP contact form, and we’ll connect you with the right person.

Further information

OEO development began with the "SzenarienDB" project and is enhanced by "LOD_GEOSS" and "SIROP". The OEO was introduced in an open access peer-reviewed paper: Introducing the Open Energy Ontology: Enhancing data interpretation and interfacing in energy systems analysis.

The OEO steering committee was established in autumn 2019.

Workflow checklist

han-f avatar Jun 11 '24 06:06 han-f

There is also a related issue https://github.com/OpenEnergyPlatform/oeplatform/issues/1496.

This issue here is not duplicated, but offers a great ‘concrete’ suggestion on how to improve the oeo pages content.

Especially this https://github.com/OpenEnergyPlatform/oeplatform/issues/1496#issuecomment-1916338211 is related here because it would be good to combine the overview and module pages. -> Further, we should explain in a sentence there, what oeo-full-owl and oeo-closure are.

jh-RLI avatar Jun 11 '24 09:06 jh-RLI

In general, I think it's a good idea to do this moderation work for any site with a lot of text.

A bit offtopic, but related: I would also suggest that we add a few bullet points to the front page of the OEP. There we should explain the main features/services we offer https://github.com/OpenEnergyPlatform/oeplatform/issues/1708

jh-RLI avatar Jun 11 '24 10:06 jh-RLI

TODO: Add oeox to overview page, too. I'll provide a short description here...

stap-m avatar Aug 29 '24 09:08 stap-m

Where and how can I contribute?

We welcome everyone to contribute to OEO development, a community-driven project hosted on GitHub. Explore our guidelines and wiki for detailed instructions. If you have questions, reach out via the OEP contact form, and we’ll connect you with the right person.

About this part, I think we should first link to the ontology course on OEA and then to the "guidelines", not the wiki. The wiki and the contributing file are also linked in the course.

stap-m avatar Aug 29 '24 12:08 stap-m

Further information

OEO development began with the "SzenarienDB" project and is enhanced by "LOD_GEOSS" and "SIROP". The OEO was introduced in an open access peer-reviewed paper: Introducing the Open Energy Ontology: Enhancing data interpretation and interfacing in energy systems analysis.

The projects SEDOS and Stadt-Land-Energie should also be mentioned.

stap-m avatar Aug 29 '24 12:08 stap-m

Do you happen to have links to the project pages? @stap-m

Further information OEO development began with the "SzenarienDB" project and is enhanced by "LOD_GEOSS" and "SIROP". The OEO was introduced in an open access peer-reviewed paper: Introducing the Open Energy Ontology: Enhancing data interpretation and interfacing in energy systems analysis.

The projects SEDOS and Stadt-Land-Energie should also be mentioned.

jh-RLI avatar Aug 29 '24 12:08 jh-RLI

We might have links on the RLI´s website.

EDIT: enargus is better i guess :)

jh-RLI avatar Aug 29 '24 12:08 jh-RLI

TODO: Add oeox to overview page, too. I'll provide a short description here...

OEO Extended (OEOX) To increase the usability of OEO and react to user requirements, we introduced a post-coordination extension to OEO, the Open Energy Ontology Extended (OEOX). We created OEOX as an ontology for specific energy- related terms with a high complexity that go beyond the level of detail of the standard OEO class hierarchy.

Once the JOWO paper is finally published, we should cite it here.

stap-m avatar Aug 29 '24 12:08 stap-m

@jh-RLI as already mentioned in the meeting today, please consider this issue: https://github.com/OpenEnergyPlatform/ontology/issues/1847

stap-m avatar Aug 29 '24 12:08 stap-m

This is how it currently looks. I will now add the glossary also and try to add the oeox in the sidebar ontology list.

image

jh-RLI avatar Aug 29 '24 13:08 jh-RLI

As simple description for the oeo-full.owl and oeo-closure.owl files I would suggest something like:

oeo-full.owl This file contains the complete version of the Open Energy Ontology (OEO) as an OWL file in XML/RDF format. It encompasses all classes, properties, and relationships defined within the OEO framework. You can download the full ontology using the following URLs: http://127.0.0.1:8000/ontology/oeo/ or http://127.0.0.1:8000/ontology/oeo/releases/oeo-full.owl to get this file.

oeo-closure.owl This file represents the Open Energy Ontology (OEO) with the logical closure of all axioms included. It is provided as an OWL file in XML/RDF format, ensuring that all inferred relationships and properties are fully realized. You can download the closure file using the following URLs: http://127.0.0.1:8000/ontology/oeo/releases/oeo-closure.owl to get the file.

jh-RLI avatar Aug 29 '24 13:08 jh-RLI

This is how it currently looks. I will now add the glossary also and try to add the oeox in the sidebar ontology list.

Looks good already, thanks! Please consider my comment on the Where and how can I contribute? section.

URLs: http://127.0.0.1:8000/ontology/oeo/ or http://127.0.0.1:8000/ontology/oeo/releases/oeo-full.owl to get this file.

The URLs should be updated to https://openenergyplatform.org/ontology/...... 😄

stap-m avatar Aug 30 '24 11:08 stap-m

:D sure i updated it ... I think soon i can put this on the TOEP.

jh-RLI avatar Aug 30 '24 12:08 jh-RLI

regaridng the Where and how can I contribute? it reads now:

image

We welcome everyone to contribute to OEO development, a community-driven project hosted on GitHub. Explore our ontology course and have a look at our contribution guidelines If you have questions, reach out via the OEP contact form, and we'll connect you with the right person.

jh-RLI avatar Aug 30 '24 12:08 jh-RLI

Perfect!

stap-m avatar Aug 30 '24 12:08 stap-m