Merge pull request #4 from OpenDataManchester/3.0

0.1-alpha init

Author: DsposalTom

LICENCE.md

@@ -1,5 +1,5 @@
 
-                    Copyright (c) 2021-23 Open Data Manchester CIC
+                    Copyright (c) 2021 Open Data Manchester CIC
         Licensed under the Apache License, Version 2.0 (the "License");
                                  Apache License
                            Version 2.0, January 2004
@@ -176,29 +176,4 @@
       incurred by, or claims asserted against, such Contributor by reason
       of your accepting any such warranty or additional liability.
 
-   END OF TERMS AND CONDITIONS
-
-   APPENDIX: How to apply the Apache License to your work.
-
-      To apply the Apache License to your work, attach the following
-      boilerplate notice, with the fields enclosed by brackets "[]"
-      replaced with your own identifying information. (Don't include
-      the brackets!)  The text should be enclosed in the appropriate
-      comment syntax for the file format. We also recommend that a
-      file or class name and description of purpose be included on the
-      same "printed page" as the copyright notice for easier
-      identification within third-party archives.
-
-   Copyright [yyyy] [name of copyright owner]
-
-   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.
+   END OF TERMS AND CONDITIONS

docs/10_Licence/10_01_Licence.md

@@ -2,11 +2,9 @@
 title: Licence
 description: The Open 3P standard is (c) copyright of Open Data Manchester CIC and released under the Apache License, Version 2.0.
 ---
-
-
 # Licence
 
-                    Copyright (c) 2021-23 Open Data Manchester CIC
+                    Copyright (c) 2021 Open Data Manchester CIC
         Licensed under the Apache License, Version 2.0 (the "License");
                                  Apache License
                            Version 2.0, January 2004
@@ -183,29 +181,4 @@ description: The Open 3P standard is (c) copyright of Open Data Manchester CIC a
       incurred by, or claims asserted against, such Contributor by reason
       of your accepting any such warranty or additional liability.
 
-   END OF TERMS AND CONDITIONS
-
-   APPENDIX: How to apply the Apache License to your work.
-
-      To apply the Apache License to your work, attach the following
-      boilerplate notice, with the fields enclosed by brackets "[]"
-      replaced with your own identifying information. (Don't include
-      the brackets!)  The text should be enclosed in the appropriate
-      comment syntax for the file format. We also recommend that a
-      file or class name and description of purpose be included on the
-      same "printed page" as the copyright notice for easier
-      identification within third-party archives.
-
-   Copyright [yyyy] [name of copyright owner]
-
-   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.
+   END OF TERMS AND CONDITIONS

docs/3_Data_Specification/3_1_Base_Materials.md

@@ -1,6 +1,7 @@
 ---
 title: Base Materials
 description: Base materials are the building blocks of Open 3P.
+status: updated
 ---
 
 # Base Materials
@@ -20,6 +21,7 @@ The base materials schema contains information regarding the materials at the ve
 |type|`optional`|String|What type of base material is this? The entry here should be drawn from the [Material Type Controlled List](../5_Controlled_Lists/5_001_Material_Type.md).|
 |materialChemCID|`optional`|String|The PubChem CID for the exact base material used. The PubChem CID is PubChem's compound identifier, which is a non-zero integer for a unique chemical structure. PubChem CID can be found using their [search](https://pubchem.ncbi.nlm.nih.gov/){target=_blank}. If for some reason the PubChem CID cannot be located, consider contributing to PubChem and create the compound identifier. However, if this cannot be done, please enter `Unknown`.|
 |externalIdentifiers|`optional`|Dictionary|A dictionary of identifiers that might be used to identify the base material in other systems. For example: manufacturer's own internal identifier, bar codes or global trade item number (gtin). To provide external identifiers please follow this format. `{'externalIdentifierName1': 'identifier1', 'externalIdentifierName2': 'identifier2'}`|
+|measurements :fontawesome-solid-square-plus:{ title="Added to this version" .addition }|`optional`|List|The information regarding the measurements of the base material. The entries should be from the [Measurements Relationship List](../6_Relationship_Lists/6_012_Measurements.md).|
 |certification|`optional`|Boolean|Does the base material have a certificate (e.g. FSC, REACH, FSA etc.)? Answer as: `TRUE` for yes and `FALSE` for no.|
 |certificationClaims|`optional`|List|The information regarding the certification. The entries should be the [Certification Claims Relationship List](../6_Relationship_Lists/6_005_Certification_Claims.md) identifiers.|
 |manufacturers|`optional`|List|The information regarding the manufacturer(s). The entries should be the [Organisations Relationship List](../6_Relationship_Lists/6_010_Organisations.md) identifiers.|
@@ -36,6 +38,7 @@ erDiagram
     type String
     materialChemCID String
     externalIdentifiers Dictionary
+    measurements List
     certification Boolean
     certificationClaims List
     manufacturers List
@@ -51,6 +54,7 @@ erDiagram
   RELATIONSHIP_LISTS {
     certificationClaims optional
     organisations optional
+    measurements optional
   }
 ```
 

docs/3_Data_Specification/3_2_Materials.md

@@ -1,6 +1,7 @@
 ---
 title: Materials
 description: Materials are a combination of base materials within Open 3P.
+status: updated
 ---
 
 # Materials
@@ -15,11 +16,7 @@ The materials schema contains information regarding the materials that are used
 |externalIdentifiers|`optional`|Dictionary|A dictionary of identifiers that might be used to identify the material in other systems. For example: manufacturer's own internal identifier, bar codes or global trade item number (gtin). To provide external identifiers please follow this format. `{'externalIdentifierName1': 'identifier1', 'externalIdentifierName2': 'identifier2'}`|
 |materialConstituents|`mandatory`|List|The information regarding the consituents that are combined to create this material. The entries should be from the [Material Constituents Relationship List](../6_Relationship_Lists/6_001_Material_Constituents.md) identifier.|
 |combinationPurpose|`optional`|String|Why is this material being used? Use the identifier of the function that this row relates to. The entry here should be drawn from the [Function Controlled List](../5_Controlled_Lists/5_004_Function.md).|
-|areaDensity|`optional`|Decimal|The area density of the material. Where area density is the measure of how much mass is packed into a given area of a two-dimensional object. Provided in grams per square metre (gsm).|
-|areaDensityUnit|`optional`|String|Either `gsm` or `m^2/kg` to describe the area density unit of measure.|
-|areaDensityTolerance|`optional`|Decimal|The threshold of area density that the material can vary by. This is given as a +/- value.|
-|areaDensityToleranceType|`optional`|String|Either `unit` or `percentage` based on the value provided in `areaDensityTolerance`. Where `unit` is equal to the value provided in `areaDensityUnit`.|
-|areaDensityDate|`optional`|Date|The date that the area density was last verified/measured. Use the format `yyyy-mm-dd` adhering to the [ISO 8601 dateTime standard](https://www.iso.org/iso-8601-date-and-time-format.html).|
+|measurements fontawesome-solid-square-plus:{ title="Added to this version" .addition }|`optional`|List|The information regarding the measurements of the material. The entries should be from the [Measurements Relationship List](../6_Relationship_Lists/6_012_Measurements.md).|
 |certification|`optional`|Boolean|Does the material have a certificate (e.g. FSC, REACH, FSA etc.)? Answer as: `TRUE` for yes and `FALSE` for no.|
 |certificationClaims|`optional`|List|The information regarding the certification. The entries should be the [Certification Claims Relationship List](../6_Relationship_Lists/6_005_Certification_Claims.md) identifiers.|
 |manufacturers|`optional`|List|The information regarding the manufacturer(s). The entries should be the [Organisations Relationship List](../6_Relationship_Lists/6_010_Organisations.md) identifiers.|
@@ -37,11 +34,7 @@ BASE_MATERIALS }o--o{ MATERIALS : material_constituents
     externalIdentifiers Dictionary
     materialConstituents List "*"
     combinationPurpose String
-    areaDensity Decimal
-    areaDensityUnit String
-    areaDensityTolerance Decimal
-    areaDensityToleranceType String
-    areaDensityDate Date
+    measurements List
     certification Boolean
     certificationClaims List
     manufacturers List
@@ -57,6 +50,7 @@ BASE_MATERIALS }o--o{ MATERIALS : material_constituents
         RELATIONSHIP_LISTS {
     certificationClaims optional
     organisations optional
+    measurements optional
       }
 ```
 
@@ -80,11 +74,6 @@ BASE_MATERIALS }o--o{ MATERIALS : material_constituents
             }
           ],
         "combinationPurpose": "function-0048",
-        "areaDensity": "300",
-        "areaDensityUnit": "gsm",
-        "areaDensityTolerance": "3.3",
-        "areaDensityToleranceType": "percentage",
-        "areaDensityDate": "2023-12-07",
         "certification": true,
         "certificationClaims": ["307801c3-f6f7-4ca6-8553-6f367b37fd1e"],
         "manufacturers": ["GB-COH-10906273"],
@@ -145,11 +134,6 @@ BASE_MATERIALS }o--o{ MATERIALS : material_constituents
         <materialCombinationIdentifier>222494f7-6703-49bc-a993-8dd2675709fb</materialCombinationIdentifier>
       </materialConstituents>
       <combinationPurpose>function-0048</combinationPurpose>
-      <areaDensity>300</areaDensity>
-      <areaDensityUnit>gsm</areaDensityUnit>
-      <areaDensityTolerance>3.3</areaDensityTolerance>
-      <areaDensityToleranceType>percentage</areaDensityToleranceType>
-      <areaDensityDate>2023-12-07</areaDensityDate>
       <certification>true</certification>
       <certificationClaims>307801c3-f6f7-4ca6-8553-6f367b37fd1e</certificationClaims>
       <manufacturers>GB-COH-10906273</manufacturers>