Skip to content
Snippets Groups Projects
Commit f205defd authored by Chris Hough's avatar Chris Hough
Browse files

OSDU Standard Records M25.3 DD schema repo commit 6d09f7a15ea18ce1e90e63953941bcc0e26f340a

parent 4bbe0fb3
No related branches found
No related tags found
1 merge request!48Issue #96 "Publish DD-M25.3 (v0.28.3)"
Hide whitespace changes
Inline Side-by-side
OsduStandardRecords/ActivityTemplates/Subsurface.Geology-Petrophysics/VolumeOfShaleCalculation-GR.1.json 0 → 100644
+ 155
− 0
View file @ f205defd
{
"id": "{{NAMESPACE}}:master-data--ActivityTemplate:Subsurface.GeologyPetrophysics--VolumeOfShaleCalculation-GR.1",
"kind": "osdu:wks:master-data--ActivityTemplate:1.1.0",
"version": 1,
"acl": {
"owners": [
"{{DATA_OWNERS_GROUP}}"
],
"viewers": [
"{{DATA_VIEWERS_GROUP}}"
]
},
"legal": {
"legaltags": [
"{{LEGAL_TAG}}"
],
"otherRelevantDataCountries": [
"{{ISO_3166_ALPHA_2_CODE}}"
]
},
"meta": [],
"data": {
"Name": "Volume of shale from gamma ray",
"Description": "An Activity Template for a basic volume of shale (Vsh) calculation process from gamma ray (GR) measurements.",
"Source": "OSDU Forum",
"VersionCreationReason": "Standardised Activity Template delivered by the OSDU Forum",
"Parameters": [
{
"Title": "WellLog Set",
"AllowedParameterKind": "{{NAMESPACE}}:reference-data--ParameterKind:DataObject:",
"IsInput": true,
"IsOutput": false,
"DataObjectContentType": [
"work-product-component--WellLog"
],
"MaxOccurs": -1,
"MinOccurs": 1
},
{
"Title": "Curve ID",
"AllowedParameterKind": "{{NAMESPACE}}:reference-data--ParameterKind:String:",
"IsInput": true,
"IsOutput": false,
"MaxOccurs": -1,
"MinOccurs": 1,
"DefaultValue": {
"Title": "Curve ID",
"StringParameter": "GR",
"Selection": "Default Curve ID value of 'GR'. Users can select and input another Curve ID value as required",
"ParameterKindID": "{{NAMESPACE}}:reference-data--ParameterKind:String:"
}
},
{
"Title": "Lower Percentile Distribution",
"AllowedParameterKind": "{{NAMESPACE}}:reference-data--ParameterKind:Double:",
"IsInput": true,
"IsOutput": false,
"MaxOccurs": -1,
"MinOccurs": 1,
"UnitQuantityID": "{{NAMESPACE}}:reference-data--UnitQuantity:1:"
},
{
"Title": "Upper Percentile Distribution",
"AllowedParameterKind": "{{NAMESPACE}}:reference-data--ParameterKind:Double:",
"IsInput": true,
"IsOutput": false,
"MaxOccurs": -1,
"MinOccurs": 1,
"UnitQuantityID": "{{NAMESPACE}}:reference-data--UnitQuantity:1:"
},
{
"Title": "Minimum Gamma Ray",
"AllowedParameterKind": "{{NAMESPACE}}:reference-data--ParameterKind:Double:",
"IsInput": true,
"IsOutput": false,
"MaxOccurs": -1,
"MinOccurs": 1,
"PropertyType": {
"PropertyTypeID": "{{NAMESPACE}}:reference-data--PropertyType:26c54ec7-76a0-4fae-966a-c3bae13c81e0:",
"Name": "gamma ray"
}
},
{
"Title": "Maximum Gamma Ray",
"AllowedParameterKind": "{{NAMESPACE}}:reference-data--ParameterKind:Double:",
"IsInput": true,
"IsOutput": false,
"MaxOccurs": -1,
"MinOccurs": 1,
"PropertyType": {
"PropertyTypeID": "{{NAMESPACE}}:reference-data--PropertyType:f63d1e2b-6578-4c2a-8aee-72904478ce3f:",
"Name": "max gamma ray"
}
},
{
"Title": "IsClipped",
"AllowedParameterKind": "{{NAMESPACE}}:reference-data--ParameterKind:Boolean:",
"IsInput": true,
"IsOutput": false,
"MaxOccurs": -1,
"MinOccurs": 1,
"DefaultValue": {
"Title": "IsClipped",
"BooleanParameter": true,
"Selection": "Default Is Clipped value of 'true'. Users can select and input another Boolean value e.g. 'false' as required",
"ParameterKindID": "{{NAMESPACE}}:reference-data--ParameterKind:Boolean:"
}
},
{
"Title": "Calculation Model",
"AllowedParameterKind": "{{NAMESPACE}}:reference-data--ParameterKind:DataObject:",
"IsInput": true,
"IsOutput": false,
"MaxOccurs": 1,
"MinOccurs": 1,
"DataObjectContentType": [
"reference-data--VshCalculationModel"
],
"DefaultValue": {
"Title": "Model for Vsh calculation from gamma ray curve",
"Selection": "Default Calculation Model value of 'Linear'. Users can select and input another Calculation Model method value as required",
"DataObjectParameter": "{{NAMESPACE}}:reference-data--VshCalculationModel:Linear:",
"ParameterKindID": "{{NAMESPACE}}:reference-data--ParameterKind:DataObject:"
}
},
{
"Title": "Output WellLog Set",
"AllowedParameterKind": "{{NAMESPACE}}:reference-data--ParameterKind:DataObject:",
"IsInput": false,
"IsOutput": true,
"DataObjectContentType": [
"work-product-component--WellLog:"
],
"MaxOccurs": -1,
"MinOccurs": 1
},
{
"Title": "Output Vsh Curve ID",
"AllowedParameterKind": "{{NAMESPACE}}:reference-data--ParameterKind:String:",
"IsInput": false,
"IsOutput": true,
"MaxOccurs": -1,
"MinOccurs": 1,
"DefaultValue": {
"Title": "Curve ID",
"Selection": "Default Curve ID value of 'Vsh'. Users can select and input another Curve ID value as required",
"StringParameter": "Vsh",
"ParameterKindID": "{{NAMESPACE}}:reference-data--ParameterKind:String:"
},
"UnitQuantityID": "{{NAMESPACE}}:reference-data--UnitQuantity:1:"
}
],
"ExtensionProperties": {}
}
}
\ No newline at end of file
OsduStandardRecords/ActivityTemplates/Subsurface.Geology-Petrophysics/VolumeOfShaleCalculation-GR.1.md 0 → 100644
+ 194
− 0
View file @ f205defd
<a name="TOC"></a>
### Table of Contents
[[_TOC_]]
# Volume of Shale (Vsh) Calculation from Gamma ray (GR) Measurements <br> [Status: Accepted]
The Volume of Shale Activity Template defines a structured process for calculating Vsh using GR measurements from selected OSDU Data Platform WellLog sets. It includes clearly defined input and output parameters, along with suggested default values to ensure accurate and consistent calculations. This enables repeatable results, with full data lineage, and facilitates ensembles and sensitivity analysis.
* Record ID: `{{NAMESPACE}}:master-data--ActivityTemplate:GeologyPetrophysics--VolumeOfShaleCalculation-GR.1`
* Record Version: `1`
* Status: `PUBLISHED`
* First deployed with milestone M25, tag v0.28.3
* Governance Authorities: OSDU
* Schema Kind: `osdu:wks:master-data--ActivityTemplate:1.1.0`
* Link to &rarr; [Authoring Schema ActivityTemplate.1.1.0.json](../../../Authoring/master-data/ActivityTemplate.1.1.0.json)
* Link to &rarr; [Generated Schema ActivityTemplate.1.1.0.json](../../../Generated/master-data/ActivityTemplate.1.1.0.json)
* Link to &rarr; [Community Schema Registration Resource ActivityTemplate.1.1.0.json](https://community.opengroup.org/osdu/data/data-definitions/-/blob/master/SchemaRegistrationResources/shared-schemas/osdu/master-data/ActivityTemplate.1.1.0.json?ref_type=heads)
* Link to &rarr; [Example Record VolumeOfShaleCalculation-GR.1.json](../../../Examples/WorkedExamples/OsduStandardActivityExamples/Subsurface.Geology-Petrophysics/VolumeOfShaleCalculation-GR_Example.1.json)
[Back to Overview README](../../../E-R/README.md) --- [Back to TOC](#TOC)
---
# Overview Diagram of this Activity Template
![overview diagram](../_diagrams/Subsurface.Geology-Petrophysics/VolumeOfShaleCalculation-GR.1.png)
**Note:** This diagram is for informational purposes only. For complete details, please refer to the [tables below](#input-and-output-parameters-and-default-values-of-this-activity-template) and the [Activity Template documentation](https://community.opengroup.org/osdu/data/data-definitions/-/blob/master/Examples/WorkedExamples/Activity/README.md). Where arrays of parameters are permitted, the number (or length) of parameter arrays (e.g., index or indices: 0, 1, 2) **must match**. Refer to [Parameter Array Index and Indices Usage](#parameter-array-index-and-indices-usage).
[Back to Overview README](../../../E-R/README.md) --- [Back to TOC](#TOC)
---
# Input and Output Parameters, and Default values of this Activity Template
Notes:
* Default values can be overwritten by the user
* Minimum Occurrence of `1` is a required property. Infinity is represented by a `-1`
* Parameters can have either a `UnitQuantity` or a PWLS `PropertyType`
## 1. Table of Input Parameters
| Parameter Name | Parameter Kind | Description | Default Value | Data Object Content Type | Unit Quantity | PWLS Property Name | Minimum Occurrence [Required] | Maximum Occurrence |
|---------------------------------|----------------|--------------------------------------------------------------------------------------------------------------------|---------------|---------------------------------------|---------------|--------------------|-------------------------------|--------------------|
| `WellLog Set` | DataObject | A user selects the 'WellLog' data set that contains the required Curve ID | | `work-product-component--WellLog` | | | 1 | Infinity |
| `Curve ID` | String | A user selected the relevent Curve ID from the OSDU `WellLog` | `GR` | | | | 1 | Infinity |
| `Lower Percentile Distribution` | Double | A user enter section of the lower bounds of input measurement distribution, for example a value of 5% | | | Dimensionless | | 1 | Infinity |
| `Upper Percentile Distribution` | Double | A user enter section of the upper or higher bounds of input measurement distribution, for example a value of 95% | | | Dimensionless | | 1 | Infinity |
| `Minimum Gamma Ray` | Double | A user enter section of the minimum gamma ray value from the distribution | | | | gamma ray | 1 | Infinity |
| `Maximum Gamma Ray` | Double | A user enter section of the maximum gamma ray value from the distribution | | | | max gamma ray | 1 | Infinity |
| `IsClipped` | Boolean | A user enter section to indicate if the distribution of input values i.e. GR have been clipped | `true` | | | | 1 | Infinity |
| `Calculation Model` | DataObject | The model used to generate the Vsh values. This is an OSDU reference value list `VshCalculationModel` | `Linear` | `reference-data--VshCalculationModel` | | | 1 | 1 |
[Back to Overview README](../../../E-R/README.md) --- [Back to TOC](#TOC)
---
## 2. Table of Output Parameters
| Parameter Name | Parameter Kind | Description | Default Value | Data Object Content Type | Unit Quantity | PWLS Property Name | Minimum Occurrence [Required] | Maximum Occurrence |
|-----------------------|----------------|---------------------------------------------------------------------------------|---------------|-----------------------------------|---------------|--------------------|-------------------------------|--------------------|
| `Output WellLog Set` | DataObject | Reference to the 'WellLog' data set that contains the calculated `Vsh` Curve ID | | `work-product-component--WellLog` | | | 1 | Infinity |
| `Output Vsh Curve ID` | String | The `CurveID` identifier of the resulting calculated Vsh | `Vsh` | | | Dimensionless | 1 | Infinity |
[Back to Overview README](../../../E-R/README.md) --- [Back to TOC](#TOC)
---
# Activity Template Usage
This specialised Activity Template, developed by the OSDU Forum, supports and facilitates standardised processes and workflows across organisations. Activity Templates enhance the OSDU Data Platform’s Lineage capability, supporting complex workflows and derived data sets.
The `ExtensionProperties` block is not included with this Activity Template record. Should an organisation choose to customise or extend this provided Activity Template, it is recommended that they create a new record version with a unique and recognisable record `ID`, and register it within their own OSDU Data Platform environment.
The Activity Template record `ID` follows the pattern:`master-data--ActivityTemplate:<OSDU Level 1 Domain>.<OSDU Level 2 Domain>--<Template Name>`. For example: `master-data--ActivityTemplate:Subsurface.GeologyPetrophysics--VolumeOfShaleCalculation-GR`.
Record variables are represented using double curly brackets, e.g., `{{VARIABLE}}`, following the pattern of OSDU Data Platform reference value manifests.
---
### Parameter Array Index and Indices Usage
When working with parameter arrays in this Activity Template, it is essential to maintain consistency in the **number** (or **length**) of arrays across all parameters. Each **index** (or collectively, **indices**) within the arrays represents a specific "sub-activity" or data mapping (e.g., `Index 0` aligns parameters across all arrays for one sub-activity, `Index 1` for the next, and so on). An example of matching array parameters can be seen below:
<details>
<summary markdown="span">Input parameter object <code>WellLog Set</code> for Index 0 (assuming to belong to Wellbore WB1)</summary>
<OsduImportJSON>[Example Activity record, full record](../../../Examples/WorkedExamples/OsduStandardActivityExamples/Subsurface.Geology-Petrophysics/VolumeOfShaleCalculation-GR_Example.1.json#only.data.Parameters[0])</OsduImportJSON>
```json
{
"data": {
"Parameters": [
{
"Title": "WellLog Set",
"Index": 0,
"Selection": "Selected by end-user, Wellbore WB1",
"DataObjectParameter": "namespace:work-product-component--WellLog:4ed87e4f-9919-4011-aa39-499953051cce:",
"ParameterKindID": "namespace:reference-data--ParameterKind:DataObject:",
"ParameterRoleID": "namespace:reference-data--ParameterRole:Input:"
}
]
}
}
```
</details>
<details>
<summary markdown="span">Input parameter object <code>WellLog Set</code> for Index 1 (assuming to belong to Wellbore WB2)</summary>
<OsduImportJSON>[Example Activity record, full record](../../../Examples/WorkedExamples/OsduStandardActivityExamples/Subsurface.Geology-Petrophysics/VolumeOfShaleCalculation-GR_Example.1.json#only.data.Parameters[1])</OsduImportJSON>
```json
{
"data": {
"Parameters": [
{
"Title": "WellLog Set",
"Index": 1,
"Selection": "Selected by end-user, Wellbore WB2",
"DataObjectParameter": "namespace:work-product-component--WellLog:5e12a983-c20d-40ed-bc9a-cf04c2ac7cfb:",
"ParameterKindID": "namespace:reference-data--ParameterKind:DataObject:",
"ParameterRoleID": "namespace:reference-data--ParameterRole:Input:"
}
]
}
}
```
</details>
<details>
<summary markdown="span">Input parameter object <code>Curve ID</code> for Index 0</summary>
<OsduImportJSON>[Example Activity record, full record](../../../Examples/WorkedExamples/OsduStandardActivityExamples/Subsurface.Geology-Petrophysics/VolumeOfShaleCalculation-GR_Example.1.json#only.data.Parameters[2])</OsduImportJSON>
```json
{
"data": {
"Parameters": [
{
"Title": "Curve ID",
"Index": 0,
"Selection": "Default",
"StringParameter": "GR",
"ParameterKindID": "namespace:reference-data--ParameterKind:String:",
"ParameterRoleID": "namespace:reference-data--ParameterRole:Input:"
}
]
}
}
```
</details>
<details>
<summary markdown="span">Input parameter object <code>Curve ID</code> for Index 1</summary>
<OsduImportJSON>[Example Activity record, full record](../../../Examples/WorkedExamples/OsduStandardActivityExamples/Subsurface.Geology-Petrophysics/VolumeOfShaleCalculation-GR_Example.1.json#only.data.Parameters[3])</OsduImportJSON>
```json
{
"data": {
"Parameters": [
{
"Title": "Curve ID",
"Index": 1,
"Selection": "Selected by end-user. Corrected Gamma secondary input to calculation",
"StringParameter": "CGR",
"ParameterKindID": "namespace:reference-data--ParameterKind:String:",
"ParameterRoleID": "namespace:reference-data--ParameterRole:Input:"
}
]
}
}
```
</details>
[Back to Overview README](../../../E-R/README.md) --- [Back to TOC](#TOC)
---
# Copyright Notice
_**Copyright 2025, The Open Group**_ <br/>
_Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at http://www.apache.org/licenses/LICENSE-2.0 . Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License._
\ No newline at end of file
0% or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment