Merge pull request #21 from OpenDataManchester/release/1.0.12

Release/1.0.12
OpenDataManchester · Jan 20, 2023 · c6bcd6b · c6bcd6b
2 parents 8d812a5 + 9fa5e24
commit c6bcd6b
Show file tree

Hide file tree

Showing 18 changed files with 503 additions and 56 deletions.
diff --git a/.github/workflows/ci.yml b/.github/workflows/ci.yml
@@ -2,7 +2,7 @@ name: ci
 on:
   push:
     branches:
-      - main
+      - develop
 permissions:
   contents: write
 jobs:
@@ -13,5 +13,6 @@ jobs:
       - uses: actions/setup-python@v4
         with:
           python-version: 3.x
-      - run: pip install mkdocs-material 
+      - run: pip install mkdocs-material
+      - run: pip install mermaid
       - run: mkdocs gh-deploy --force
diff --git a/docs/1_Start_Here/1_4_Data_Schema.md b/docs/1_Start_Here/1_4_Data_Schema.md
@@ -5,7 +5,20 @@ description: The current data schema of the Open3P open data standard for the pl
 
 # Data Schema
 
+<!-- ``` mermaid
+erDiagram
+  MATERIALS_CATALOGUE }o--o{ MATERIAL : within
+  MATERIAL }o--o{ COMPONENT_CATALOGUE : within
+  COMPONENT_CATALOGUE }o--o{ COMPLETE_PACKAGING : within
+  COMPLETE_PACKAGING }o..o{ MULTIPACK : within
+  COMPONENT_CATALOGUE }o..o{ MULTIPACK : within
+  MULTIPACK }o..o{ LOAD_CATALOGUE : within
+  COMPLETE_PACKAGING }o--o{ LOAD_CATALOGUE : within
+  COMPONENT_CATALOGUE }o--o{ LOAD_CATALOGUE : within
+  LOAD_CATALOGUE }o--o{ LOAD : within
+``` -->
+
 <figure markdown>
-![Schema](../img/schema-v1.1-2022-12-20.jpg)
+[![Schema](../img/schema-v1.1-2022-12-20.jpg)](https://opendatamanchester.github.io/PPP/img/schema-v1.1-2022-12-20.jpg){target=_blank}
   <figcaption>Data schema</figcaption>
 </figure>
diff --git a/docs/3_Data_Specification/3_1_Material_Catalogue.md b/docs/3_Data_Specification/3_1_Material_Catalogue.md
@@ -4,12 +4,9 @@ title: Materials Catalogue
 
 # Materials Catalogue
 
-Materials should be provided as a separate csv file, in tidy format. This means that each row of the csv file should be one material that is combined in the materials csv to create combinations. An example is provided.
-
-The specification of this csv file is as follows:
-
-[component_catalogue_material.csv](https://github.com/OpenDataManchester/PPP/blob/main/docs/7_Supporting_Files/7_1_2_Component_Catalogue_Material_Template.csv){target=_blank}
+The materials catalogue schema contains information regarding the base material. These are then combined together within the materials table.
 
+## Table
 |Column|<div style="width:90px">Status</div>|Format|Notes|
 |:-|:-|:-|:-|
 |identifier|`required`|String|A globally unique identifier. See identifiers section for information on how to construct this identifier|
@@ -18,10 +15,78 @@ The specification of this csv file is as follows:
 |materialPurpose|`recommended`|String|Why is this material being used? Use the identifier of the material purpose that this row relates to. The entry here should be drawn from the material purpose controlled list.|
 |materialCategory|`required`|String|The category this material row relates to. The entry here should be drawn from the material category controlled list.|
 |materialName|`required`|String|The name of the material this row relates to. `e.g., Polypropylene or Titanium Dioxide`|
-|materialChemCID|`recommnded`|String|The PubChem CID for the exact 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`.|
+|materialChemCID|`recommended`|String|The PubChem CID for the exact 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`.|
 |virginMaterial|`recommended`|numeric|The maximum allowable percent of the material that was newly created for the component.|
 |updateDate|`required`|String|The date that the material was provided/last updated. Use the format `dd/mm/yyyy`.|
 
+## Diagram
+
+<!-- ``` mermaid
+erDiagram
+  MATERIAL_TYPE }o..o{ MATERIALS_CATALOGUE : atritube
+  MATERIAL_PURPOSE }o..o{ MATERIALS_CATALOGUE : atritube
+  MATERIAL_CATEGORY }o--o{ MATERIALS_CATALOGUE : atritube
+  MATERIALS_CATALOGUE {
+    identifier String
+    materialVolume numeric
+    materialType String
+    materialPurpose String
+    materialCategory String
+    materialName String
+    materialChemCID String
+    virginMaterial numeric
+    updateDate String
+  }
+  MATERIALS_CATALOGUE }o--o{ MATERIALS : within
+``` -->
+
+<figure markdown>
+[![Schema](../img/material_catalogue-v1.0.0-22-12-20.png){ width="450" }](https://opendatamanchester.github.io/PPP/img/material_catalogue-v1.0.0-22-12-20.png){target=_blank}
+  <figcaption>Data schema</figcaption>
+</figure>
+
+## Template
+
+Materials should be provided as a separate csv file, in tidy format. This means that each row of the csv file should be one material that is combined in the materials csv to create combinations. An example is provided.
+
+The specification of this csv file is as follows:
+
+[Material_Catalogue_Template.csv](https://www.opendatamanchester.org.uk/wp-content/uploads/2023/01/7_1_7_Materials_Catalogue_Template.csv){target=_blank}
+
+## Example
+
+=== "JSON"
+
+    ``` json linenums="1"
+    {
+      "identifier": "A4BAE07C-1847-CD8E-C933-6FD30478423B",
+      "materialVolume": "1000",
+      "materialType": {
+        "identifier":"material-component-catalogue-type-0002",
+        "category":"synthetic",
+        "detailed":"derived from crude oil, natural gas or coal."
+      },
+      "materialPurpose": {
+        "identifier":"material-component-catalogue-purpose-0015",
+        "category":"structure",
+        "detailed":""
+      },
+      "materialCategory": {
+        "identifier":"material-component-catalogue-category-0007",
+        "category":"plastic",
+        "detailed":""
+      },
+      "materialName": "PET",
+      "materialChemCID": "223961227",
+      "virginMaterial": "20",
+      "updateDate": "01/08/2022",
+    }
+    ```
+=== "CSV download"
+
+    * [Material Catalogue example download](https://www.opendatamanchester.org.uk/wp-content/uploads/2023/01/7_1_7_Materials_Catalogue_Example.csv){target=_blank}
+
+
 ## Guide for how to take measurements
 
 ### Units

diff --git a/docs/3_Data_Specification/3_2_Material.md b/docs/3_Data_Specification/3_2_Material.md
@@ -4,17 +4,9 @@ title: Materials
 
 # Materials
 
-Materials should be provided as a separate csv file, in tidy format. This means that each row of the csv file should be one material for a component. An example is provided.
-
-<figure markdown>
-![Schema](../img/materials-v1.0-2022-12-20.png){ width="450" }
-  <figcaption>Data schema</figcaption>
-</figure>
-
-The specification of this csv file is as follows:
-
-[component_catalogue_material.csv](https://github.com/OpenDataManchester/PPP/blob/main/docs/7_Supporting_Files/7_1_2_Component_Catalogue_Material_Template.csv){target=_blank}
+The materials schema contains information regarding the materials that are used within components. These maybe a single base material from the materials catalogue and a combination of materials.
 
+## Table
 |Column|<div style="width:90px">Status</div>|Format|Notes|
 |:-|:-|:-|:-|
 |identifier|`required`|String|A globally unique identifier. See identifiers section for information on how to construct this identifier|
@@ -25,6 +17,42 @@ The specification of this csv file is as follows:
 |combinationPurpose|`recommended`|String|Why is this material being used? Use the identifier of the material function that this row relates to. The entry here should be drawn from the material function controlled list.|
 |updateDate|`required`|String|The date that the material was provided/last updated. Use the format `dd/mm/yyyy`.|
 
+## Diagram
+
+<figure markdown>
+[![Schema](../img/materials-v1.0-2022-12-20.png){ width="450" }](https://opendatamanchester.github.io/PPP/img/materials-v1.0-2022-12-20.png){target=_blank}
+  <figcaption>Data schema</figcaption>
+</figure>
+
+## Template
+Materials should be provided as a separate csv file, in tidy format. This means that each row of the csv file should be one material for a component. An example is provided.
+
+The specification of this csv file is as follows:
+
+[Materials_Template.csv](https://www.opendatamanchester.org.uk/wp-content/uploads/2023/01/7_1_2_Materials_Template.csv){target=_blank}
+
+## Example
+
+=== "JSON"
+
+    ``` json linenums="1"
+    {
+      "identifier": "DCEE1F88-A83B-5BBC-D2D9-6A862B344977",
+      "materialIdentifier": "278EFE8A-720A-06C1-A411-CB94878AD3E2",
+      "materialCatalogue": "A4BAE07C-1847-CD8E-C933-6FD30478423B",
+      "layer": "1",
+      "materialWeight": "100",
+      "combinationPurpose": {
+        "identifier":"material-component-catalogue-purpose-0015",
+        "category":"structure",
+        },
+      "updateDate": "01/08/2022",
+    }
+    ```
+=== "CSV download"
+
+    * [Materials example download](https://www.opendatamanchester.org.uk/wp-content/uploads/2023/01/7_1_2_Materials_Example.csv){target=_blank}
+
 ## Guide for how to take measurements
 
 ### Units

diff --git a/docs/3_Data_Specification/3_3_Component_Catalogue.md b/docs/3_Data_Specification/3_3_Component_Catalogue.md
@@ -4,13 +4,9 @@ title: Component Catalogue
 
 # Component Catalogue
 
-## Standard Spreadsheet Format
-
-The following table lists the column headings that should be used. When providing this information, you can either build your spreadsheet from scratch, or use the template provided.
-
-[component_catalogue.csv](https://github.com/OpenDataManchester/PPP/blob/main/docs/7_Supporting_Files/7_1_1_Component_Catalogue_Template.csv){target=_blank}
-
+The component catalogue schema contains information regarding the components that are used to create complete packages. These maybe created from a single material or a combination of materials from the materials schema.
 
+## Table
 |Column|<div style="width:90px">Status</div>|Format|Notes|
 |:-|:-|:-|:-|
 |identifier|`required`|String|A globally unique identifier. See identifiers section for information on how to construct this identifier|
@@ -54,6 +50,102 @@ The following table lists the column headings that should be used. When providin
 |releaseDate|`recommended`|String|The date that the component will be available to use. Use the format `dd/mm/yyyy`.|
 |discontinueDate|`recommended`|String|The date that the component will no longer be available to use. Use the format `dd/mm/yyyy`.|
 
+## Diagram
+
+<figure markdown>
+[![Schema](../img/component-catalogue-v1.0.0-22-12-20.png){ width="800" }](https://opendatamanchester.github.io/PPP/img/component-catalogue-v1.0.0-22-12-20.png){target=_blank}
+  <figcaption>Data schema</figcaption>
+</figure>
+
+## Template
+
+Components should be provided as a separate csv file, in tidy format. This means that each row of the csv file should be one component of a complete package. An example is provided.
+
+The specification of this csv file is as follows:
+
+[Component_Catalogue_Template.csv](https://www.opendatamanchester.org.uk/wp-content/uploads/2023/01/7_1_1_Component_Catalogue_Template.csv){target=_blank}
+
+## Example
+
+=== "JSON"
+
+    ``` json linenums="1"
+    {
+      "identifier": "278EFE8A-720A-06C1-A411-CB94878AD3E2",
+      "name": "Guacamole Dip Pot",
+      "description": "Clear PET pot for the Guacamole Dip",
+      "tags": {
+        "GTIN":"00123456789012",
+        },
+      "imageURL": "",
+      "LOWcode": "15 01 02",
+      "materialIdentifier":"278EFE8A-720A-06C1-A411-CB94878AD3E2",
+      "height": 46,
+      "heightDate": "01/08/2022",
+      "width": 101,
+      "widthDate": "01/08/2022",
+      "depth": 101,
+      "depthDate": "01/08/2022",
+      "volume": "",
+      "volumeDate": "",
+      "weight": 6.85,
+      "weightTolerance": "4.38%",
+      "weightDate": "01/08/2022",
+      "shape": {
+        "identifier":"component-catalogue-shape-0005",
+        "category":"cylinder",
+        "detailed":"3D shape with 2 parallel circular bases connected by a curved surface"
+      },
+      "function": {
+        "identifier":"component-catalogue-function-0030",
+        "category":"pot",
+        "detailed":""
+      },
+      "flexibility": {
+        "identifier": "component-catalogue-flexibility-0002",
+        "category": "Rigid",
+        "detailed": ""
+      },
+      "branding": "FALSE",
+      "componentRecyclingDisruptors": "",
+      "colour": "",
+      "opacity": {
+        "identifier": "component-catalogue-opacity-0003",
+        "category": "transparent",
+        "detailed": "allows light to pass through so that objects behind can be distinctly seen; no colour/ clear"
+      },
+      "loaned": "FALSE",
+      "reuseSystem": "",
+      "manufacturedCountry": {
+        "Country": "United Kingdom of Great Britain and Northern Ireland (the)",
+        "Numeric": 826
+      },
+      "recycledContent": 90,
+      "recycledContentEvidenceType": {
+        "identifier":"component-catalogue-recycled-evidence-0001",
+        "category":"certificate",
+        "detailed":""
+      },
+      "recycledContentEvidenceReference": "EXA-123-MPL-4-E",
+      "recyclability": "TRUE",
+      "recyclabilitySource": {
+        "identifier":"complete-packaging-recyclability-source-0001",
+        "category":"OPRL",
+        "detailed":""
+      },
+      "recyclabilityDate": "01/08/2022",
+      "partOfMultipack": "TRUE",
+      "previouslyAssembledComponent": "FALSE",
+      "componentLink": "NA",
+      "updateDate": "01/08/2022",
+      "releaseDate": "01/08/2022",
+      "discontinueDate": ""
+    }
+    ```
+=== "CSV download"
+
+    * [Component Catalogue example download](https://www.opendatamanchester.org.uk/wp-content/uploads/2023/01/7_1_1_Component_Catalogue_Example.csv){target=_blank}
+
 ## Guide for how to take measurements
 
 ### Units