|
1 | | -# application-ontology-template |
| 1 | +# BWMD Ontology |
2 | 2 |
|
3 | | -template repository for starting a PMDCo application ontology. iT comes preconfigured with github workflows using [ontology development kit](https://github.com/INCATools/ontology-development-kit). |
| 3 | +Description: PMD Core application ontology generated via ODK Template. |
4 | 4 |
|
5 | | -## How to use |
6 | 5 |
|
7 | | -1. Click use as Template Repository |
8 | | -2. Documentation of the application ontology is created via widoco and GitHub Pages when the docs workflow runs. |
| 6 | +More information can be found at http://obofoundry.org/ontology/bwmd |
9 | 7 |
|
10 | | - To enable the documentation, you have to activate GitHub Pages in the repository settings. Set it to GitHub Actions instead of branch; the doc action will upload the artifacts needed after each push to the repository. |
11 | | -3. You need to give GitHub Actions the permissions to read write and create pull requests (checkbox) in the repository settings at actions -> general |
12 | | -4. Run the seed workflow under GitHub Actions, and set the id and uribase_suffix. It will override the default values in [seed-template.yaml](./seed-template.yaml) |
13 | | - |
14 | | - Id and uribase_suffix are usually set to the same lowercase acronym that will be used with this ontology; examples are pmdco, tto, hto ... |
15 | | - Github org and repo name will be set automatically by the seed workflow. To run the workflow, switch to GitHub Actions, select the seed workflow, and dispatch the job manually. |
16 | | -5. Check the pull request created! If everything is fine, merge into main. |
17 | | -6. Put your ontology work into the \*-edit.owl file in the src folder; after pushing changes to the repository, the build will run and integrate your changes into the release types defined. |
| 8 | +## Versions |
| 9 | + |
| 10 | +### Stable release versions |
| 11 | + |
| 12 | +The latest version of the ontology can always be found at: |
| 13 | + |
| 14 | +https://w3id.org/pmd/bwmd.owl |
| 15 | + |
| 16 | +(note this will not show up until the request has been approved by obofoundry.org) |
| 17 | + |
| 18 | +### Editors' version |
| 19 | + |
| 20 | +Editors of this ontology should use the edit version, [src/ontology/bwmd-edit.owl](src/ontology/bwmd-edit.owl) |
| 21 | + |
| 22 | +## Contact |
| 23 | + |
| 24 | +Please use this GitHub repository's [Issue tracker](https://github.com/materialdigital/materialdigital/pmdco-bwmd/issues) to request new terms/classes or report errors or specific concerns related to the ontology. |
| 25 | + |
| 26 | +## Acknowledgements |
| 27 | + |
| 28 | +This ontology repository was created using the [Ontology Development Kit (ODK)](https://github.com/INCATools/ontology-development-kit). |
| 29 | +## Development |
| 30 | +This ontology is developed using OWL and managed with the [Ontology Development Kit (ODK)](https://github.com/INCATools/ontology-development-kit). To edit: |
| 31 | +- Open `bwmd-edit.owl` (located in `src/ontology/`) in [Protégé](https://protege.stanford.edu/) or your preferred OWL editor. |
| 32 | +- Create new entities (classes, properties) within the namespace `https://w3id.org/pmd/bwmd/`. |
| 33 | + - Example class ID: `https://w3id.org/pmd/bwmd/BWMD_0000001` (PREFIX is uppercase). |
| 34 | +- Use the `Makefile` for automation: |
| 35 | + - `make test`: Run quality control (OWL reasoner checks, syntax validation). |
| 36 | + - `make refresh-imports`: Update imported ontologies (e.g., PMD Core, LOGO) with SLME extraction. |
| 37 | + - `make release`: Build release artifacts (full, base, etc.) in TTL/OWL/JSON formats. |
| 38 | + - `make update_repo`: Sync changes to the repo structure. |
| 39 | +Quick start: After setup, edit in Protégé, commit, and push to trigger CI builds. |
| 40 | +## Repository Structure |
| 41 | +This repository provides the modular implementation of BWMD Ontology, developed and maintained using the [Ontology Development Kit (ODK)](https://github.com/INCATools/ontology-development-kit). |
| 42 | +### Top-level directories |
| 43 | +* **.github/:** GitHub configuration files, including CI workflows and templates. |
| 44 | +* **docs/:** Documentation sources for the ontology website and user guides (optional; add as needed). |
| 45 | +* **patterns/:** Logical patterns and SHACL shapes used to maintain consistent ontology design (optional). |
| 46 | +* **src/:** Main development folder generated and managed through ODK. |
| 47 | + * **ontology/components/:** – Modular ontology components (classes, properties, axioms). |
| 48 | + * **ontology/bwmd-edit.owl:** – Primary editable ontology file used during development (ontology editors' version). |
| 49 | + * **ontology/imports/:** Extracted terms from imported ontologies (via SLME). |
| 50 | +### Ontology versions (generated on release) |
| 51 | +* **bwmd-full.owl/ttl:** Complete ontology with all imports and full axiomatization. |
| 52 | +* **bwmd-base.owl/ttl:** Core entities without extended imports. |
| 53 | +* **bwmd-simple.owl/ttl:** Simplified version with basic subclass and existential axioms. |
| 54 | +* **bwmd-minimal.owl/ttl:** Lightweight minimal version for quick onboarding (recommended for beginners). |
| 55 | +* **bwmd.owl/ttl:** Main ontology file contains the full version. |
| 56 | +### Other files |
| 57 | +* README.md, LICENSE.txt, CONTRIBUTING.md – Project overview, license, and contribution guidelines. |
| 58 | +* imports.txt, components.txt, creators.txt – Configuration for setup (optional edits). |
| 59 | +## Contribution |
| 60 | +We welcome contributions to the BWMD Ontology ontology! |
| 61 | +To get involved: |
| 62 | +- Please use this GitHub repository's **[Issue tracker](https://github.com/materialdigital/pmdco-bwmd/issues)** to request new terms/classes or report errors or specific concerns related to the ontology. |
| 63 | +- For creation of application ontologies using PMD core ontologies, we advise using the **[application-ontology-template](https://github.com/materialdigital/application-ontology-template/)**. It applies the same framework used here and mirrors the pmdco with all its modules. |
| 64 | +- Write about your specific modeling concerns or any other discussable topics in the **[discussion forum](https://github.com/materialdigital/pmdco-bwmd/discussions)**. |
| 65 | +- Participate in our **PMD Playground Meetings**: Our Ontology Playground, organized online every second Friday from 1-2 pm (CET), is a great opportunity to connect with developers and our proactive community to shape the PMDco. Please register via our [mailing list](https://www.lists.kit.edu/sympa/subscribe/ontology-playground?previous_action=info). |
| 66 | +- If you need further information, please feel free to contact us via **[info@material-digital.de](mailto:info@material-digital.de)** |
0 commit comments