Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Rework modular file structure #1592

Closed
5 tasks
stap-m opened this issue Jun 20, 2023 · 14 comments
Closed
5 tasks

Rework modular file structure #1592

stap-m opened this issue Jun 20, 2023 · 14 comments
Assignees
Labels
[B] restructure Restructuring existing parts of the ontology enhancement New feature or request meta issue Issue that collects information about topics and will be closed after detailled issues are solved. oeo dev meeting Discuss issue at oeo dev meeting ontology infrastructure

Comments

@stap-m
Copy link
Contributor

stap-m commented Jun 20, 2023

Description of the issue

We decided on a modular structure for the OEO to allow the usage of single modules that focus on a sub-topic of the domain and to avoid merge conflicts.
However, our shared-module, which was initially created for the interaction of the modules, grew a lot and became the largest module of oeo recently. This counteracts the original idea of the modular structure.

Therefore, the file structure should be rethought to keep the advantages of the modules.

Ideas of solution

One idea is a new module, that contains only axioms across modules, called oeo-shared-axioms for now.

grafik

I also included possible future modules as examples in the drawing: one for sectors and one for the composition of existing classes.

A restructuring like this might call for a version 2.0

Workflow checklist

  • I discussed the issue with someone else than me before working on a solution
  • I already read the latest version of the workflow for this repository
  • The goal of this ontology is clear to me

I am aware that

  • every entry in the ontology should have a definition
  • classes should arise from concepts rather than from words
@stap-m stap-m added [B] restructure Restructuring existing parts of the ontology To do Issues that haven't got discussed yet labels Jun 20, 2023
@stap-m stap-m self-assigned this Jun 20, 2023
@stap-m stap-m added enhancement New feature or request oeo dev meeting Discuss issue at oeo dev meeting ontology infrastructure labels Jul 31, 2023
@stap-m
Copy link
Contributor Author

stap-m commented Jul 31, 2023

@jannahastings answered to this via e-mail:

Achieving genuine modularity has always been somewhat challenging in OWL given the need for axioms that cross modules to interconnect and build the overall structure. I think your proposal looks good and this will surely be an improvement on having an increasingly large 'shared' module. One risk I see is that the tools support for finding and working with the axioms in just those specific modules might be insufficient as Protege's options may be limited for showing axiom-only content where classes are primarily defined elsewhere. However, I don't know of any tools that offer a solution to this challenge.

@stap-m
Copy link
Contributor Author

stap-m commented Jul 31, 2023

We try this out with a mini-ontology first, to see whether protege errors occur and if they can be fixed.

@stap-m stap-m added this to the oeo-release-1.17.0 milestone Jul 31, 2023
@stap-m
Copy link
Contributor Author

stap-m commented Aug 8, 2023

grafik

While testing with a mini-ontology, I found out that this is a helpful setting for the axioms.

@github-actions github-actions bot removed the To do Issues that haven't got discussed yet label Aug 8, 2023
stap-m added a commit that referenced this issue Sep 6, 2023
stap-m added a commit that referenced this issue Sep 6, 2023
stap-m added a commit that referenced this issue Sep 6, 2023
stap-m added a commit that referenced this issue Sep 6, 2023
stap-m added a commit that referenced this issue Sep 6, 2023
stap-m added a commit that referenced this issue Sep 6, 2023
stap-m added a commit that referenced this issue Sep 8, 2023
@stap-m stap-m mentioned this issue Sep 11, 2023
5 tasks
@carstenhoyerklick
Copy link
Contributor

carstenhoyerklick commented Sep 11, 2023

Google table for removing classes to original modules
https://docs.google.com/spreadsheets/d/18Cr2rnsFlZvZuDOEiBFEkjVd5SEvD1gt6qg0VnPpd3Q/edit?usp=sharing

@stap-m
Copy link
Contributor Author

stap-m commented Sep 11, 2023

How to move a class:

  1. Delete from oeo-shared and move everything to respective thematic module (via text editor, notepad, ect)
  2. Check axioms whether it belongs to thematic module or to shared-axioms (protege)
  3. Remove all doubled annotations (protege)
  4. term tracker at thematic module
rework module structure 
issue: https://github.com/OpenEnergyPlatform/ontology/issues/1592
pull request: https://github.com/OpenEnergyPlatform/ontology/pull/1652
  1. indicate in spreadsheet, which classes are done

Workflow:

  • branch from feature-1592-move-classes-to-original-modules and push there, not directly into dev!
  • a couple of classes per PR
  • responsibility, see google spreadsheet (@l-emele and @nelekoehler oeo-physical, @areleu oeo-social, @stap-m oeo-model, @chrwm oeo-shared)
  • deadline: September 22
  • CHANGELOG.md will be updated when everything is finished

stap-m added a commit that referenced this issue Sep 28, 2023
stap-m added a commit that referenced this issue Sep 28, 2023
stap-m added a commit that referenced this issue Sep 28, 2023
stap-m added a commit that referenced this issue Sep 28, 2023
stap-m added a commit that referenced this issue Sep 28, 2023
stap-m added a commit that referenced this issue Sep 28, 2023
stap-m added a commit that referenced this issue Sep 28, 2023
stap-m added a commit that referenced this issue Sep 28, 2023
stap-m added a commit that referenced this issue Sep 28, 2023
l-emele added a commit that referenced this issue Sep 28, 2023
@stap-m stap-m added the meta issue Issue that collects information about topics and will be closed after detailled issues are solved. label Oct 12, 2023
@l-emele
Copy link
Contributor

l-emele commented Oct 13, 2023

We should update the wiki article on the OEO structure: https://github.com/OpenEnergyPlatform/ontology/wiki/modules-of-the-oeo

Maybe it would be also nice to have the structure diagram in README.md (without oeo-composed and without the blue colour of the new modules).

@stap-m
Copy link
Contributor Author

stap-m commented Oct 16, 2023

We should update the wiki article on the OEO structure: https://github.com/OpenEnergyPlatform/ontology/wiki/modules-of-the-oeo

Maybe it would be also nice to have the structure diagram in README.md (without oeo-composed and without the blue colour of the new modules).

@nelekoehler can you take care of the documentation and as well the README please? Here is the updated figure.:

grafik

@nelekoehler
Copy link
Contributor

We should update the wiki article on the OEO structure: https://github.com/OpenEnergyPlatform/ontology/wiki/modules-of-the-oeo
Maybe it would be also nice to have the structure diagram in README.md (without oeo-composed and without the blue colour of the new modules).

@nelekoehler can you take care of the documentation and as well the README please? Here is the updated figure.:

grafik

Yes, I can do that.

@l-emele
Copy link
Contributor

l-emele commented Oct 24, 2023

I close this now as we will be releasing the new structure in a few minutes.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
[B] restructure Restructuring existing parts of the ontology enhancement New feature or request meta issue Issue that collects information about topics and will be closed after detailled issues are solved. oeo dev meeting Discuss issue at oeo dev meeting ontology infrastructure
Projects
Status: Done
Development

No branches or pull requests

6 participants