Skip to content

Commit

Permalink
Format markdown
Browse files Browse the repository at this point in the history
  • Loading branch information
fkleedorfer committed Dec 6, 2024
1 parent ad1e9ce commit c29347e
Show file tree
Hide file tree
Showing 11 changed files with 32 additions and 28 deletions.
2 changes: 1 addition & 1 deletion .github/CONTRIBUTING.md
Original file line number Diff line number Diff line change
@@ -1,2 +1,2 @@
Thanks for considering helping us in making QUDT better. Please review the Issues list for something that catches your interest, or
Thanks for considering helping us in making QUDT better. Please review the Issues list for something that catches your interest, or
see our <a href="https://github.com/qudt/qudt-public-repo/wiki"> Wiki</a> for detailed guidelines on adding content to the models.
3 changes: 2 additions & 1 deletion CHANGELOG.md
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,7 @@ and this project is in the process of adopting [Semantic Versioning](https://sem
### Added

- Add the qudt:altSymbol relation
- Add "mph" and "kph" as `qudt:altSymbol`
- Add "mph" and "kph" as `qudt:altSymbol`
- Added Coefficient of Performance to quantity kinds

### Changed
Expand Down Expand Up @@ -57,3 +57,4 @@ and this project is in the process of adopting [Semantic Versioning](https://sem

[Unreleased]: https://github.com/qudt/qudt-public-repo/compare/v2.1.45...HEAD
[2.1.45]: https://github.com/qudt/qudt-public-repo/compare/v2.1.44...v2.1.45

15 changes: 6 additions & 9 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,7 @@ QUDT - Quantities, Units, Dimensions and dataTypes - public repository
======================================================================

## Quick-Start Guide

There are three ways to bring the QUDT ontology into your environment.
1. Download the latest GitHub Release [here](https://github.com/qudt/qudt-public-repo/releases).
2. Use the resolved graph and instance URIs available [here](https://www.qudt.org/2.1/catalog/qudt-catalog.html).
Expand All @@ -14,7 +15,6 @@ This QUDT<sup>1</sup> public repository contains the schema and vocabulary sourc

DOI reference for citations: https://doi.org/10.25504/FAIRsharing.d3pqw7


Here is the core design pattern of the QUDT ontology:

![QUDT Triad Pattern](https://github.com/qudt/qudt-public-repo/wiki/Quantity_Triad_Pattern.png)
Expand All @@ -37,7 +37,7 @@ Installation instructions
[Installing QUDT for Contributors](https://github.com/qudt/qudt-public-repo/wiki/Installing-QUDT-for-Contributors)

Configuration instructions
-----------------------------------------
--------------------------

The QUDT ontology is provided in two forms: OWL and SHACL. By default, the vocabularies are configured to use the SHACL schema. To configure it to use the OWL schema instead, just make the following single change in the file schema/SDHEMA-FACADE_QUDT.ttl. You can see in the imports closure diagram above how all the vocabularies import this single "facade" file to make it easy to switch the ontology.

Expand Down Expand Up @@ -77,18 +77,20 @@ Change this line:
To:
# imports: http://qudt.org/2.1/collection/usertest
```

Currently, the tests in the usertest graph check for references to deprecated instances or properties and recommend the updated instance or property.

Protege Users
-----------------------------
-------------

The QUDT ontologies have been tested to load without error in Protege 5.6.4.

To load QUDT into Protege, choose "Open from URI" from the file menu, and enter http://qudt.org/2.1/vocab/unit

(The "facade" file that is resolvable on the web (http://qudt.org/2.1/schema/facade/qudt) is already configured to load the OWL schema rather than the SHACL schema, so Protege users will be in the OWL world using this method.)

Ontology libraries
-----------------------------
------------------

Please note that various libraries exhibit different behaviors when importing the QUDT ontology, see this [discussion](https://github.com/qudt/qudt-public-repo/issues/842#issuecomment-1879114604).

Expand All @@ -97,18 +99,13 @@ Status

Please see the [New Features and Releases](https://github.com/qudt/qudt-public-repo/discussions/315) topic in the Discussions section for status updates.



<hr/>
<p style="font-size:xx-small;"><sup>1</sup> QUDT.org is a 501(c)(3) not-for-profit organization founded to provide semantic specifications for units of measure, quantity kind, dimensions and data types. QUDT is an advocate for the development and implementation of standards to quantify data expressed in RDF and JSON. Our mission is to improve interoperability of data and the specification of information structures through industry standards for Units of Measure, Quantity Kinds, Dimensions and Data Types. <a href="https://github.com/sponsors/qudt">Sponsorships</a> are greatly appreciated!

QUDT.org is a member of the World Wide Web Consortium (W3C)



<hr/>


Last updated by: Steve Ray (steve.ray@qudt.org)

Last updated: November 14, 2024
6 changes: 6 additions & 0 deletions pom.xml
Original file line number Diff line number Diff line change
Expand Up @@ -329,6 +329,12 @@
</turtle>
</format>
</rdf>
<markdown>
<includes>
<include>**/*.md</include>
</includes>
<flexmark />
</markdown>

<formats>
<!--
Expand Down
3 changes: 1 addition & 2 deletions src/build/release/release-body-footer.md
Original file line number Diff line number Diff line change
@@ -1,2 +1 @@

And as always, a big thank-you to all of you for bringing many of these issues to our attention, and even better, for providing submissions to extend the coverage and capabilities of QUDT!
And as always, a big thank-you to all of you for bringing many of these issues to our attention, and even better, for providing submissions to extend the coverage and capabilities of QUDT!
3 changes: 2 additions & 1 deletion src/build/release/release-body-header.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,6 @@
# Breaking Changes
With this Release, we have migrated to an automated release mechanism.

With this Release, we have migrated to an automated release mechanism.
This includes reorganizing our directory structure.
Please read our updated README.md file (scroll to the bottom) for many of the details.

Expand Down
3 changes: 1 addition & 2 deletions src/build/snapshot-release/release-body-header.md
Original file line number Diff line number Diff line change
@@ -1,7 +1,6 @@
# Snapshot Release

This release and the corresponding git tag are updated every time a PR is merged to `main`.
This release and the corresponding git tag are updated every time a PR is merged to `main`.
Use it to access the latest state of the repository without having to build it yourself. Expect further
changes before the upcoming release.


3 changes: 2 additions & 1 deletion src/main/rdf/community/README.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
# Community Submissions
Community submissions go in this folder, organized in the following way. If you create a new folder, please create a README.md in that folder including a description of the contents and contact information, so that people know who to ask for additions, usage, etc.

Community submissions go in this folder, organized in the following way. If you create a new folder, please create a README.md in that folder including a description of the contents and contact information, so that people know who to ask for additions, usage, etc.

- applications
- case studies
Expand All @@ -15,3 +15,4 @@ Community submissions go in this folder, organized in the following way. If you
- SSSOM
- IFC
- SHACL

7 changes: 3 additions & 4 deletions src/main/rdf/community/extensions/loop3d/README.md
Original file line number Diff line number Diff line change
@@ -1,13 +1,13 @@
# Loop3D Community

This folder contains a _profile_ of QUDT which is a part view of the whole created for the [Loop3D](https://loop3d.org/) community.
This folder contains a _profile_ of QUDT which is a part view of the whole created for the [Loop3D](https://loop3d.org/) community.

The _profile_ is a specification formulated according to [the W3C's Profiles Vocabulary](https://w3c.github.io/dx-prof/prof/) which contains potentially many parts. This particular profile only contains one part currently: a vocbaulary of units used by the Loop3D cmmunity. In the future, this profile may be expanded, perhaps with more vocabularies (e.g. of QuantityKinds) or perhaps with supporting assets such as documentation (e.g. about appropriate use of QUDT for Looop3D purposed) or other things.

The current profile elements are stored as files in this repository folder but should be accessed or refered to by their QUDT web addresses (persistent identifiers):

* the Loop3D profile - <http://qudt.org/community/loop3d>
* the units vocabulary - <http://qudt.org/community/loop3d/voc>
* the units vocabulary - <http://qudt.org/community/loop3d/voc>

### Profile technical access

Expand All @@ -17,7 +17,6 @@ Those elements can be accessed in _Linked Data_ forms via their web addresses to
curl -L -H 'Accept: text/turtle' http://qudt.org/community/loop3d/voc
```


## Contact

The Loop3D community can be reached via the contributor of this profile:
Expand All @@ -26,4 +25,4 @@ The Loop3D community can be reached via the contributor of this profile:
*Data Systems Architect*
SURROUND Australia Pty Ltd
<nicholas.car@surroundaustralia.com>
GitHub: @nicholascar
GitHub: @nicholascar
10 changes: 5 additions & 5 deletions src/main/rdf/community/general/UCUM/README.md
Original file line number Diff line number Diff line change
@@ -1,11 +1,11 @@
# UCUM

The [UCUM project](https://unitsofmeasure.org/) appears to be no longer maintained.
The [UCUM specification](http://unitsofmeasure.org/ucum.html) was last updated 2017-11-21 and the issue tracker is dormant.
Nevertheless, UCUM has a useful legacy of resources.
A selection of these have been archived in this repository in case they are needed.
The [UCUM project](https://unitsofmeasure.org/) appears to be no longer maintained.
The [UCUM specification](http://unitsofmeasure.org/ucum.html) was last updated 2017-11-21 and the issue tracker is dormant.
Nevertheless, UCUM has a useful legacy of resources.
A selection of these have been archived in this repository in case they are needed.

- [UCUM essence](./ucum-essence.xml) (terminals)
- [UCUM Specification](https://raw.githack.com/qudt/qudt-public-repo/master/community/UCUM/ucum-page.html)

A [list of UCUM implementations](https://unitsofmeasure.org/trac#ImplementationSupport) is available.
A [list of UCUM implementations](https://unitsofmeasure.org/trac#ImplementationSupport) is available.
5 changes: 3 additions & 2 deletions src/main/rdf/community/mappings/SSSOM/IFC/README.md
Original file line number Diff line number Diff line change
@@ -1,14 +1,15 @@
# QUDT-IFC Mapping

## Description

`qudt-ifc-mapping.tsv` and `qudt-ifc-metadata.yml` together contain a mapping between QUDT and IFC. QUDT QuantityKinds and Units are mapped to IFC Units and Measures. The mapping is provided in according to the [SSSOM Specification](https://mapping-commons.github.io/sssom/spec/).

## Versions

This mapping depends on

* Subsequent version of [QUDT $$QUDT_VERSION$$](https://github.com/qudt/qudt-public-repo/releases/tag/v$$QUDT_VERSION$$)
* [IFC 4.0.2.1](https://standards.buildingsmart.org/IFC/DEV/IFC4/ADD2_TC1/OWL/ontology.ttl) (In case you need it: [overview of IFC version specs](https://technical.buildingsmart.org/standards/ifc/ifc-schema-specifications/))
* Subsequent version of [QUDT $$QUDT_VERSION$$](https://github.com/qudt/qudt-public-repo/releases/tag/v$$QUDT_VERSION$$)
* [IFC 4.0.2.1](https://standards.buildingsmart.org/IFC/DEV/IFC4/ADD2_TC1/OWL/ontology.ttl) (In case you need it: [overview of IFC version specs](https://technical.buildingsmart.org/standards/ifc/ifc-schema-specifications/))

## Contact

Expand Down

0 comments on commit c29347e

Please sign in to comment.