Skip to content

Commit

Permalink
updating to new Component Models structure
Browse files Browse the repository at this point in the history
  • Loading branch information
nicholascar committed Jul 4, 2024
1 parent 446281d commit 1e64e72
Show file tree
Hide file tree
Showing 17 changed files with 76 additions and 59 deletions.
2 changes: 1 addition & 1 deletion docs/background.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
# Background Models

Background Models are models that this Supermodel's [Backbone Model](backbone.md) and [Component Models](components.md) profile (inherit from).
Background Models are models that this Supermodel's [Backbone Model](backbone.md) and [Component Models](components/index) profile (inherit from).

Background Models may not be directly referred to by data created according to the Backbone or Component Models, however all data made to conform to this Supermodel _must_ conform to all the Background Models.

Expand Down
32 changes: 0 additions & 32 deletions docs/components.md

This file was deleted.

2 changes: 1 addition & 1 deletion docs/components/features-hierarchy.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,7 @@

## Purpose

This component model describes the overarching hierarchy of geospatial Features used by GSWA to position Mines, Sites, Cratons, Basins etc. This Component Model is the immediate parent model of the [Sites & Admin Features](sites-admin.md) and [Geological Features](geo-features.md) component models.
This component model describes the overarching hierarchy of geospatial Features used by GSWA to position Mines, Sites, Cratons, Basins etc. This Component Model is the immediate parent model of the [Sites & Admin Features](sites-admin.md) and [Geological Features](geofeature) component models.

## Model logic

Expand Down
File renamed without changes.
File renamed without changes.
32 changes: 32 additions & 0 deletions docs/components/index.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,32 @@
# Component Models

This section lists the various Component Models within this Supermodel.

All data created according to any of the Component Models, to be used in this Supermodel's context, _MUST_ also conform to this Supermodel's [Backbone Model](../backbone.md).

Note that useful data may be created that is valid according to individual Component Models and not this Supermodels' Backbone Model for use outside this Supermodel's context.

## Profiles

Many of the Component Models here are defined as a _profile_, by which we mean that it is a model that draws from other Standard's models and constrains and extends their elements, rather than creating its own elements.

Profiles are used to specialise general-purpose models while remaining conformant with them.

Formally, any data created according to a _profile_ _MUST_ conform to all the models it profiles, as per the [Profiles Vocabulary](../background.md#profiles-vocabulary-prof) rules.

Profiles may profile multiple Standards, bringing together all the parts needed for a particular task

## List of Component Models

Several of the Component Models within this Supermodel are full defined here. Others are defined elsewhere and just referred to from here. The table below lists the current Component Models.

| **Model** | **Domain(s)** | **Persistent Identifier** | **Notes** |
|---------------------------------------------------------------|------------------------------------------------------|---------------------------------------|------------------------------------------------------------------|
| [Features Hierarchy Model](features-hierarchy) | geospatial spatial features | `https://linked.data.gov.au/def/xxx` | Coming... |
| [Sites & Admin Features Model](sites-admin) | man-made & administrative spatial features | `https://linked.data.gov.au/def/xxx` | child model of [Features Hierarchy Model](features-hierarchy.md) |
| [Bore Model](bore) | bores, boreholes, wells etc | `https://linked.data.gov.au/def/bore` | child model of [Sites & Admin Features Model](sites-admin.md) |
| [Mine Model](mine) | mines | `https://linked.data.gov.au/def/mine` | child model of [Sites & Admin Features Model](sites-admin.md) |
| [Mining Authorisation Model](components/mining-authorisation) | tenements, permits, licenses etc., to do with mining | `https://linked.data.gov.au/def/xxx` | child model of [Sites & Admin Features Model](sites-admin.md) |
| [GeoFeatures](geofeature) | geospatial spatial features | `https://linked.data.gov.au/def/xxx` | child model of [Features Hierarchy Model](features-hierarchy.md) ||
| [Geosample Model](geosample) | samples, sampling | `https://linked.data.gov.au/def/xxx` | Coming... |
| [Resource Occurrence Model](resource-occurrence) | spatial position and values of resources | `https://linked.data.gov.au/def/xxx` | child model of [GeoFeatures Model](features-hierarchy.md) |
2 changes: 1 addition & 1 deletion docs/components/mine.md
Original file line number Diff line number Diff line change
Expand Up @@ -39,7 +39,7 @@ Agents relations - of Mines and Mine Projects to People and Organisations - foll

Authorities are licenses, permits etc. that give permission or exclusivity to own/operate Mines in designated areas.

Authority modelling itself is not directly handled in this model (see the [Authorities Component Model](../components/mining-authorities) for that) however common authorities associated with Mines and Projects are shown here.
Authority modelling itself is not directly handled in this model (see the [Authorities Component Model](../components/mining-authorisation) for that) however common authorities associated with Mines and Projects are shown here.

### Commodities

Expand Down
15 changes: 15 additions & 0 deletions docs/components/mining-authorisation.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,15 @@
# Mining Authorisation

## Overview

<a href="../../assets/authorities-Overview.svg">
<figure id="figure-bh" markdown>
![](../assets/authorities-Overview.svg)
<figcaption>Figure AO: Mining Authorisation Model overview</figcaption>
</figure>
</a>

This Mining Authorisation Model caters for legal and policy instruments that give permission or exclusivity to own/operate mining-related operations, usually in designated areas.

_This model has only just been started._

15 changes: 0 additions & 15 deletions docs/components/mining-authorities.md

This file was deleted.

4 changes: 2 additions & 2 deletions docs/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -23,9 +23,9 @@ Currently, as of May 2023, the following elements have been established:
* some aspects: this
* [Vocabularies](vocabularies.md)
* some aspects of the , and the
* [Component Models](components.md)
* [Component Models](components/index)
* [Boreholes Profile](components/boreholes.md) - developed
* [Samples Profile](components/sample) - started
* [Samples Profile](components/geosample) - started

## License & Rights

Expand Down
4 changes: 2 additions & 2 deletions docs/supermodel.md
Original file line number Diff line number Diff line change
Expand Up @@ -26,7 +26,7 @@ This Supermodel relates to several other Supermodels in existence. The table bel
Supermodel | Relationship
--- | ---
[Foundational Spatial Data Framework Supermodel](https://linked.data.gov.au/def/fsdf-supermodel) | The FSDF Supermodel was created by [Geoscience Australia](https://www.ga.gov.au) to integrate multiple foundational spatial datasets within Australia. It specifies both a structure for spatial data and particular fundamental objects to join datasets with, such as authoritative boundaries for Australia and the states.<br /><br />This supermodel adopts the FSDF Supermodel ways of working for spatial data
Geological Survey of Queensland's Supermodel (_not online yet_) | A Supermodel for a similar agency to GSWA. It implements many of the same Background Models, Vocabularies and some of the same Component Models, such as [Boreholes](components.md#boreholes-profile)
Geological Survey of Queensland's Supermodel (_not online yet_) | A Supermodel for a similar agency to GSWA. It implements many of the same Background Models, Vocabularies and some of the same Component Models, such as [Boreholes](components/index#boreholes-profile)

## Supermodel Structure

Expand All @@ -36,7 +36,7 @@ The structure of this Supermodel follows the conventions of the _Supermodel Mode

Each of the main parts of this Supermodel is listed on the left.

Individual data models - called _Component Models_ here - are given within the [Component Models Section](components.md).
Individual data models - called _Component Models_ here - are given within the [Component Models Section](components/index).

## Modelling Conventions

Expand Down
10 changes: 6 additions & 4 deletions mkdocs.yml
Original file line number Diff line number Diff line change
Expand Up @@ -17,22 +17,24 @@ theme:
palette:
scheme: youtube
logo: assets/classes-icon.svg
features:
- navigation.indexes
# custom_dir: overrides
nav:
- 'index.md'
- 'supermodel.md'
- 'background.md'
- 'backbone.md'
- 'Component Models':
- 'Overview': 'components.md'
- 'components/index.md'
- 'Features Hierarchy': 'components/features-hierarchy.md'
- 'Sites & Admin Features': 'components/sites-admin.md'
- 'Bore': 'components/bore.md'
- 'Mine': 'components/mine.md'
- 'Mining Authorities': 'components/mining-authorities.md'
- 'Geological Features': 'components/geo-features.md'
- 'Mining Authorisation': 'components/mining-authorisation.md'
- 'GeoFeatures': 'components/geofeature.md'
- 'Resource Occurrence': 'components/resource-occurrence.md'
- 'Samples': 'components/sample.md'
- 'Samples': 'components/geosample.md'

- 'vocabularies.md'
- 'validators.md'
Expand Down
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
PREFIX owl: <http://www.w3.org/2002/07/owl#>

<https://linked.data.gov.au/def/tenement>
<https://linked.data.gov.au/def/geofeature>
a owl:Ontology ;
.
5 changes: 5 additions & 0 deletions rdf/components/geosample.ttl
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
PREFIX owl: <http://www.w3.org/2002/07/owl#>

<https://linked.data.gov.au/def/mining-authorisation>
a owl:Ontology ;
.
5 changes: 5 additions & 0 deletions rdf/components/mining-authorisation.ttl
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
PREFIX owl: <http://www.w3.org/2002/07/owl#>

<https://linked.data.gov.au/def/mining-authorisation>
a owl:Ontology ;
.
5 changes: 5 additions & 0 deletions rdf/components/resource-occurence.ttl
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
PREFIX owl: <http://www.w3.org/2002/07/owl#>

<https://linked.data.gov.au/def/geofeature>
a owl:Ontology ;
.
Empty file added rdf/components/sites-admin.ttl
Empty file.

0 comments on commit 1e64e72

Please sign in to comment.