Update M24 Release Notes authored by Pierrick Gaudin's avatar Pierrick Gaudin
......@@ -29,6 +29,158 @@ TBA
### Data Definition
<details>
<summary>Details for M24.0</summary>
Detailed report of changes _after_ [2024-03-29](./_ChangeReports/ChangeReport-2024-03-29.md).
1. **Subsurface**
1. [reference-data--SampleAnalysisFamily](./reference-data/SampleAnalysisFamily.1.0.0.md): CoreDescription was added
2. [reference-data--SampleAnalysisType](./reference-data/SampleAnalysisType.1.0.0.md):
1. CoreDescription was added
2. Stratigraphy.CoreDescription was deprecated, superseded by CoreDescription
3. [work-product-component--SampleImage:1.0.0](./work-product-component/SampleImage.1.0.0.md) is intended to supersede
work-product-component--RockSample, however, still in development mode without schema upgrade support. It
associates to unified Sample(s) covering the needs of rock **and** fluid samples.
2. **Minor Changes**
1. correct broken hyperlinks in schema documentation for
[FileCollection.EPC:1.0.1](../Guides/MigrationGuides/M24.0/dataset--FileCollection.EPC.1.0.1.md) by creating a new
patch version `osdu:wks:dataset--FileCollection.EPC:1.0.2`.
2. Similarly, in
[reference-data--EncodingFormatType](../Guides/MigrationGuides/M24.0/reference-data--EncodingFormatType.1.0.0.md)
correct the description of `reference-data--EncodingFormatType:application%2Fx-epc%2Bzip`.
3. Correction of URL references to OSDU platform services. This includes the update of the descriptions in
[DiscoverabilityBySearch](../Guides/MigrationGuides/M24.0/reference-data--DiscoverabilityBySearch.1.0.0.md).
<details>
<summary>Details for M24.1</summary>
Detailed report of changes _after_ [2024-05-10](./_ChangeReports/ChangeReport-2024-05-10.md).
1. **Subsurface**
1. [master-data--ReservoirSegment:1.2.0](./master-data/ReservoirSegment.1.2.0.md) has
been [updated](../Guides/MigrationGuides/M24.1/master-data--ReservoirSegment.1.1.0.md). The use of the reference
value controlled property `ReservoirSegmentTypeID` has been deprecated in favour of a free
text `IntentPurposeUseDescription` property.
2. The use of [reference-data--ReservoirSegmentType](./reference-data/ReservoirSegmentType.1.0.1.md) (used
by `ReservoirSegmentTypeID`) has been deprecated as list together with all values,
see [details](../Guides/MigrationGuides/M24.1/reference-data--ReservoirSegmentType.1.0.0.md).
2. **Corrections**
1. Three schema fragments have been incorrectly tagged in review status _Pending_, which makes the fragments appear
as schema status `DEVELOPMENT`. This has been corrected in M24.1. The changes have no effect except correcting
the bootstrap resources to `PUBLISHED` state as originally intended. The corrected fragments are:
1. [AbstractPTCondition.1.0.0](./abstract/AbstractPTCondition.1.0.0.md) superseded by
2. [AbstractPTCondition.1.1.0](./abstract/AbstractPTCondition.1.1.0.md)
3. [AbstractSampleProperties.1.0.0](./abstract/AbstractSampleProperties.1.0.0.md) already superseded by
Accepted/`PUBLISHED` [AbstractSampleProperties.1.1.0](./abstract/AbstractSampleProperties.1.1.0.md).
<details>
<summary>Details for M24.2</summary>
Detailed report of changes _after_ [2024-06-17](./_ChangeReports/ChangeReport-2024-06-17.md).
1. **Generic**
1. A new fragment, [AbstractLocationUncertainty:1.0.0](./abstract/AbstractLocationUncertainty.1.0.0.md), has been added as
a simple, spherical 3D position uncertainty. It is intended to be used in conjunction with single point spatial
locations, like genericSite and Well.
2. The [AbstractColumnBasedTable:1.0.0](./abstract/AbstractColumnBasedTable.1.2.0.md) is extended with an optional
reference to
a [master-data--ColumnBasedTableTemplate:1.0.0](./master-data/ColumnBasedTableTemplate.1.0.0.md), keeping it
functionally equivalent
to [work-product-component--ColumnBasedTable:1.3.0](./work-product-component/ColumnBasedTable.1.3.0.md), see Subsurface
below.
3. [master-data--GenericSite:1.1.0](./master-data/GenericSite.1.1.0.md) is extended to include the
new [AbstractLocationUncertainty](./abstract/AbstractLocationUncertainty.1.0.0.md), [see changes in detail](../Guides/MigrationGuides/M24.2/master-data--GenericSite.1.0.0.md).
4. Supporting [Project and Workflow Services](https://community.opengroup.org/osdu/platform/system/project-and-workflow/-/tree/main/docs/docs?ref_type=heads),
the following entities have been added:
1. **New** [master-data--CollaborationProject](./master-data/CollaborationProject.1.0.0.md), the umbrella entity for an
instance of a "system of engagement".
2. **New** [work-product-component--CollaborationProjectCollection](./work-product-component/CollaborationProjectCollection.1.0.0.md),
a generic collection, however limited to usage in context of a CollaborationProject.
3. [reference-data--CollaborationProjectLifecycleStatus](./reference-data/CollaborationProjectLifecycleStatus.1.0.0.md)
to define the reference values for the collaboration lifecycle states.
2. **Connected Source/External Data Services**
1. [master-data--ConnectedSourceDataJob:1.6.0](./master-data/ConnectedSourceDataJob.1.6.0.md) is
[augmented with a flag](../Guides/MigrationGuides/M24.2/master-data--ConnectedSourceDataJob.1.5.0.md) to
control naturalization (creating content copies) in the target platform.
3. **Production**
1. [work-product-component--ProductionValues:1.1.0](./work-product-component/ProductionValues.1.1.0.md)
is [updated](../Guides/MigrationGuides/M24.2/work-product-component--ProductionValues.1.0.0.md).
to include the revised [AbstractColumnBasedTable:1.2.0](./abstract/AbstractColumnBasedTable.1.2.0.md) and enable shared
column metadata like ColumnBasedTable above. The usage will
be [similar to the example for ColumnBasedTable](../Examples/WorkedExamples/Reservoir%20Data/ColumnBasedTable/README.md#governance-via-columnbasedtabletemplate).
4. **Subsurface**
1. A **new** [master-data--ColumnBasedTableTemplate:1.0.0](./master-data/ColumnBasedTableTemplate.1.0.0.md) has been added,
which offers some governance
over [work-product-component--ColumnBasedTable:1.3.0](./work-product-component/ColumnBasedTable.1.3.0.md) and entities
including [AbstractColumnBasedTable:1.2.0](./abstract/AbstractColumnBasedTable.1.2.0.md). The template
defines the metadata for columns without the column values.
2. [work-product-component--ColumnBasedTable:1.3.0](./work-product-component/ColumnBasedTable.1.3.0.md) is extended with
an optional relationship to
a [master-data--ColumnBasedTableTemplate](./master-data/ColumnBasedTableTemplate.1.0.0.md), `ColumnBasedTableTemplateID`.
If populated, the table is expected to contain columns matching the template column by `ColumnName`. The change
is
indicated [here](../Guides/MigrationGuides/M24.2/work-product-component--ColumnBasedTable.1.2.0.md). [Worked examples are available](../Examples/WorkedExamples/Reservoir%20Data/ColumnBasedTable/README.md#governance-via-columnbasedtabletemplate),
which explain the mechanics in detail.
3. [work-product-component--ReservoirEstimatedVolumes:1.1.0](./work-product-component/ReservoirEstimatedVolumes.1.1.0.md)
is [updated](../Guides/MigrationGuides/M24.2/work-product-component--ReservoirEstimatedVolumes.1.0.0.md).
to include the revised [AbstractColumnBasedTable:1.2.0](./abstract/AbstractColumnBasedTable.1.2.0.md) and enable shared
column metadata like ColumnBasedTable above. The usage will
be [similar to the example for ColumnBasedTable](../Examples/WorkedExamples/Reservoir%20Data/ColumnBasedTable/README.md#governance-via-columnbasedtabletemplate).
4. [work-product-component--WellboreIntervalSet:1.3.0](./work-product-component/WellboreIntervalSet.1.3.0.md)
is [updated](../Guides/MigrationGuides/M24.2/work-product-component--WellboreIntervalSet.1.2.0.md).
to include the revised [AbstractColumnBasedTable:1.2.0](./abstract/AbstractColumnBasedTable.1.2.0.md) and enable shared
column metadata like ColumnBasedTable above. The usage will
be [similar to the example for ColumnBasedTable](../Examples/WorkedExamples/Reservoir%20Data/ColumnBasedTable/README.md#governance-via-columnbasedtabletemplate).
**_Note:_** the association between Intervals and IntervalProperties are done via `IntervalID` in a single key
column `data.IntervalProperties.ColumnValues[0].StringColumn[]`. The same rule applies to WellboreMarkerSet, see
below.
5. [work-product-component--WellboreMarkerSet:1.5.0](./work-product-component/WellboreMarkerSet.1.5.0.md) has undergone a
larger extension to align with the capabilities
of [WellboreIntervalSet:1.3.0](./work-product-component/WellboreIntervalSet.1.3.0.md), notably the inclusion of
the [AbstractColumnBasedTable:1.2.0](./abstract/AbstractColumnBasedTable.1.2.0.md) as `MarkerProperties`
and [AbstractTimeSeriesLink:1.0.0](./abstract/AbstractTimeSeriesLink.1.0.0.md). The changes are summarized in
the [migration guide](../Guides/MigrationGuides/M24.2/work-product-component--WellboreMarkerSet.1.4.0.md).
**_Note:_** the association between Markers and MarkerProperties are done via `MarkerID` in a single key
column `data.MarkerProperties.ColumnValues[0].StringColumn[]`. The same rule applies to WellboreIntervalSet, see
above.
A [worked example](../Examples/WorkedExamples/WellboreMarkerSet/README.md#overview-wellboremarkerset-with-embedded-properties)
is made available.
6. **Geophysics**
1. The legacy FaultSystem is deprecated in favour of the already
existing [UnsealedSurfaceFramework:1.3.1](./work-product-component/UnsealedSurfaceFramework.1.3.1.md)
or [PersistedCollection:1.2.0](./work-product-component/PersistedCollection.1.2.0.md)
aggregating [SeismicFaults:1.3.0](./work-product-component/SeismicFault.1.3.0.md).
2. As a consequence, [UnsealedSurfaceFramework:1.3.1](./work-product-component/UnsealedSurfaceFramework.1.3.1.md)
is [updated](../Guides/MigrationGuides/M24.2/work-product-component--UnsealedSurfaceFramework.1.3.0.md) to
discourage the use of FaultSystem (via `FaultSystemID`).
7. **Geology & Petrophyics**
1. A new [master-data--WellLogAcquisition](./master-data/WellLogAcquisition.1.0.0.md) master-data schema has been developed. The purpose of this schema is to capture the information related to a well logging activity, the logging tools run in hole and the details of the specific logging runs and passes. Several new supporting reference value schemas and lists have been developed.
2. As a consequence The [work-product-component--WellLog](./work-product-component/WellLog.1.5.0.md) schema has been revised. The revision includes references to the new [WellLogAcquisition](./master-data/WellLogAcquisition.1.0.0.md) (see above), revised property descriptions and the deprecation of several properties for clarity and a more streamlined catalogue schema.
8. [work-product-component--GeoLabelSet:1.1.0](./work-product-component/GeoLabelSet.1.1.0.md) got extended by an optional
time interval/period of validity. Changes are
listed [here](../Guides/MigrationGuides/M24.2/work-product-component--GeoLabelSet.1.0.0.md).
5. **Well**
1. **New** [master-data--WellSiteStructure](./master-data/WellSiteStructure.1.0.0.md) as surface facility, which can act as parent/reference for wells. It can contain individual slots, which can be referenced from wells. Both the site location and the slot locations can carry uncertainty via the new fragment [AbstractLocationUncertainty:1.0.0](./abstract/AbstractLocationUncertainty.1.0.0.md).
2. [master-data--Well:1.4.0](./master-data/Well.1.4.0.md) is augmented by including the new
fragment, [AbstractLocationUncertainty:1.0.0](./abstract/AbstractLocationUncertainty.1.0.0.md), adding
a `LocationUncertainty` object as well as an optional relationship to WellSiteStructure. The changes are
documented [here](../Guides/MigrationGuides/M24.2/master-data--Well.1.3.0.md).
3. [work-product-component--WellboreTrajectory:1.4.0](./work-product-component/WellboreTrajectory.1.4.0.md) was extended to record the geomagnetic and gravity model context, which was used during the processing. The WITSML footprint is extended and WITSML source references are added to the schema metadata. A number of descriptions were improved and examples added, which appear in the [auto-generated example](../Examples/work-product-component/WellboreTrajectory.1.4.0.json). The full list of modifications is presented in the [migration guide](../Guides/MigrationGuides/M24.2/work-product-component--WellboreTrajectory.1.3.0.md). The new reference value entities are listed under Reference Data below.
6. **Reference Data**
1. The reference value content for ReservoirType is now governed by PPDM
with [changes detailed in the migration page](../Guides/MigrationGuides/M24.2/reference-data--ReservoirType.1.0.0.md).
PPDM deprecated code `OilSandsDeposit`, however, with ambiguous supersession: Conventional, Unconventional or
Mineable.
2. Supporting WellboreTrajectory:
1. Additional values for [reference-data--TrajectoryStationPropertyType](../Guides/MigrationGuides/M24.2/reference-data--TrajectoryStationPropertyType.1.0.0.md)
2. New reference value list [reference-data--GeoMagneticModel:1.0.0](./reference-data/GeoMagneticModel.1.0.0.md), and
3. new reference value list [reference-data--GravityModel:1.0.0](./reference-data/GravityModel.1.0.0.md).
3. Supporting WellSiteStructure, [reference-data--WellSiteStructureType](./reference-data/WellSiteStructureType.1.0.0.md) has been added.
<details>
### Core and Helper Services
### Ingestion services
......
......