Skip to content

Commit c6bcd6b

Browse files
DsposalTomDsposalTom
authored
Merge pull request #21 from OpenDataManchester/release/1.0.12
Release/1.0.12
2 parents 8d812a5 + 9fa5e24 commit c6bcd6b

18 files changed

Lines changed: 503 additions & 56 deletions

‎.github/workflows/ci.yml‎

Lines changed: 3 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@ name: ci
22
on:
33
push:
44
branches:
5-
- main
5+
- develop
66
permissions:
77
contents: write
88
jobs:
@@ -13,5 +13,6 @@ jobs:
1313
- uses: actions/setup-python@v4
1414
with:
1515
python-version: 3.x
16-
- run: pip install mkdocs-material
16+
- run: pip install mkdocs-material
17+
- run: pip install mermaid
1718
- run: mkdocs gh-deploy --force

‎docs/1_Start_Here/1_4_Data_Schema.md‎

Lines changed: 14 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -5,7 +5,20 @@ description: The current data schema of the Open3P open data standard for the pl
55

66
# Data Schema
77

8+
<!-- ``` mermaid
9+
erDiagram
10+
MATERIALS_CATALOGUE }o--o{ MATERIAL : within
11+
MATERIAL }o--o{ COMPONENT_CATALOGUE : within
12+
COMPONENT_CATALOGUE }o--o{ COMPLETE_PACKAGING : within
13+
COMPLETE_PACKAGING }o..o{ MULTIPACK : within
14+
COMPONENT_CATALOGUE }o..o{ MULTIPACK : within
15+
MULTIPACK }o..o{ LOAD_CATALOGUE : within
16+
COMPLETE_PACKAGING }o--o{ LOAD_CATALOGUE : within
17+
COMPONENT_CATALOGUE }o--o{ LOAD_CATALOGUE : within
18+
LOAD_CATALOGUE }o--o{ LOAD : within
19+
``` -->
20+
821
<figure markdown>
9-
![Schema](../img/schema-v1.1-2022-12-20.jpg)
22+
[![Schema](../img/schema-v1.1-2022-12-20.jpg)](https://opendatamanchester.github.io/PPP/img/schema-v1.1-2022-12-20.jpg){target=_blank}
1023
<figcaption>Data schema</figcaption>
1124
</figure>

‎docs/3_Data_Specification/3_1_Material_Catalogue.md‎

Lines changed: 71 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -4,12 +4,9 @@ title: Materials Catalogue
44

55
# Materials Catalogue
66

7-
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.
8-
9-
The specification of this csv file is as follows:
10-
11-
[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}
7+
The materials catalogue schema contains information regarding the base material. These are then combined together within the materials table.
128

9+
## Table
1310
|Column|<div style="width:90px">Status</div>|Format|Notes|
1411
|:-|:-|:-|:-|
1512
|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:
1815
|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.|
1916
|materialCategory|`required`|String|The category this material row relates to. The entry here should be drawn from the material category controlled list.|
2017
|materialName|`required`|String|The name of the material this row relates to. `e.g., Polypropylene or Titanium Dioxide`|
21-
|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`.|
18+
|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`.|
2219
|virginMaterial|`recommended`|numeric|The maximum allowable percent of the material that was newly created for the component.|
2320
|updateDate|`required`|String|The date that the material was provided/last updated. Use the format `dd/mm/yyyy`.|
2421

22+
## Diagram
23+
24+
<!-- ``` mermaid
25+
erDiagram
26+
MATERIAL_TYPE }o..o{ MATERIALS_CATALOGUE : atritube
27+
MATERIAL_PURPOSE }o..o{ MATERIALS_CATALOGUE : atritube
28+
MATERIAL_CATEGORY }o--o{ MATERIALS_CATALOGUE : atritube
29+
MATERIALS_CATALOGUE {
30+
identifier String
31+
materialVolume numeric
32+
materialType String
33+
materialPurpose String
34+
materialCategory String
35+
materialName String
36+
materialChemCID String
37+
virginMaterial numeric
38+
updateDate String
39+
}
40+
MATERIALS_CATALOGUE }o--o{ MATERIALS : within
41+
``` -->
42+
43+
<figure markdown>
44+
[![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}
45+
<figcaption>Data schema</figcaption>
46+
</figure>
47+
48+
## Template
49+
50+
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.
51+
52+
The specification of this csv file is as follows:
53+
54+
[Material_Catalogue_Template.csv](https://www.opendatamanchester.org.uk/wp-content/uploads/2023/01/7_1_7_Materials_Catalogue_Template.csv){target=_blank}
55+
56+
## Example
57+
58+
=== "JSON"
59+
60+
``` json linenums="1"
61+
{
62+
"identifier": "A4BAE07C-1847-CD8E-C933-6FD30478423B",
63+
"materialVolume": "1000",
64+
"materialType": {
65+
"identifier":"material-component-catalogue-type-0002",
66+
"category":"synthetic",
67+
"detailed":"derived from crude oil, natural gas or coal."
68+
},
69+
"materialPurpose": {
70+
"identifier":"material-component-catalogue-purpose-0015",
71+
"category":"structure",
72+
"detailed":""
73+
},
74+
"materialCategory": {
75+
"identifier":"material-component-catalogue-category-0007",
76+
"category":"plastic",
77+
"detailed":""
78+
},
79+
"materialName": "PET",
80+
"materialChemCID": "223961227",
81+
"virginMaterial": "20",
82+
"updateDate": "01/08/2022",
83+
}
84+
```
85+
=== "CSV download"
86+
87+
* [Material Catalogue example download](https://www.opendatamanchester.org.uk/wp-content/uploads/2023/01/7_1_7_Materials_Catalogue_Example.csv){target=_blank}
88+
89+
2590
## Guide for how to take measurements
2691

2792
### Units

‎docs/3_Data_Specification/3_2_Material.md‎

Lines changed: 38 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -4,17 +4,9 @@ title: Materials
44

55
# Materials
66

7-
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.
8-
9-
<figure markdown>
10-
![Schema](../img/materials-v1.0-2022-12-20.png){ width="450" }
11-
<figcaption>Data schema</figcaption>
12-
</figure>
13-
14-
The specification of this csv file is as follows:
15-
16-
[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}
7+
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.
178

9+
## Table
1810
|Column|<div style="width:90px">Status</div>|Format|Notes|
1911
|:-|:-|:-|:-|
2012
|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:
2517
|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.|
2618
|updateDate|`required`|String|The date that the material was provided/last updated. Use the format `dd/mm/yyyy`.|
2719

20+
## Diagram
21+
22+
<figure markdown>
23+
[![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}
24+
<figcaption>Data schema</figcaption>
25+
</figure>
26+
27+
## Template
28+
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.
29+
30+
The specification of this csv file is as follows:
31+
32+
[Materials_Template.csv](https://www.opendatamanchester.org.uk/wp-content/uploads/2023/01/7_1_2_Materials_Template.csv){target=_blank}
33+
34+
## Example
35+
36+
=== "JSON"
37+
38+
``` json linenums="1"
39+
{
40+
"identifier": "DCEE1F88-A83B-5BBC-D2D9-6A862B344977",
41+
"materialIdentifier": "278EFE8A-720A-06C1-A411-CB94878AD3E2",
42+
"materialCatalogue": "A4BAE07C-1847-CD8E-C933-6FD30478423B",
43+
"layer": "1",
44+
"materialWeight": "100",
45+
"combinationPurpose": {
46+
"identifier":"material-component-catalogue-purpose-0015",
47+
"category":"structure",
48+
},
49+
"updateDate": "01/08/2022",
50+
}
51+
```
52+
=== "CSV download"
53+
54+
* [Materials example download](https://www.opendatamanchester.org.uk/wp-content/uploads/2023/01/7_1_2_Materials_Example.csv){target=_blank}
55+
2856
## Guide for how to take measurements
2957

3058
### Units

‎docs/3_Data_Specification/3_3_Component_Catalogue.md‎

Lines changed: 98 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -4,13 +4,9 @@ title: Component Catalogue
44

55
# Component Catalogue
66

7-
## Standard Spreadsheet Format
8-
9-
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.
10-
11-
[component_catalogue.csv](https://github.com/OpenDataManchester/PPP/blob/main/docs/7_Supporting_Files/7_1_1_Component_Catalogue_Template.csv){target=_blank}
12-
7+
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.
138

9+
## Table
1410
|Column|<div style="width:90px">Status</div>|Format|Notes|
1511
|:-|:-|:-|:-|
1612
|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
5450
|releaseDate|`recommended`|String|The date that the component will be available to use. Use the format `dd/mm/yyyy`.|
5551
|discontinueDate|`recommended`|String|The date that the component will no longer be available to use. Use the format `dd/mm/yyyy`.|
5652

53+
## Diagram
54+
55+
<figure markdown>
56+
[![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}
57+
<figcaption>Data schema</figcaption>
58+
</figure>
59+
60+
## Template
61+
62+
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.
63+
64+
The specification of this csv file is as follows:
65+
66+
[Component_Catalogue_Template.csv](https://www.opendatamanchester.org.uk/wp-content/uploads/2023/01/7_1_1_Component_Catalogue_Template.csv){target=_blank}
67+
68+
## Example
69+
70+
=== "JSON"
71+
72+
``` json linenums="1"
73+
{
74+
"identifier": "278EFE8A-720A-06C1-A411-CB94878AD3E2",
75+
"name": "Guacamole Dip Pot",
76+
"description": "Clear PET pot for the Guacamole Dip",
77+
"tags": {
78+
"GTIN":"00123456789012",
79+
},
80+
"imageURL": "",
81+
"LOWcode": "15 01 02",
82+
"materialIdentifier":"278EFE8A-720A-06C1-A411-CB94878AD3E2",
83+
"height": 46,
84+
"heightDate": "01/08/2022",
85+
"width": 101,
86+
"widthDate": "01/08/2022",
87+
"depth": 101,
88+
"depthDate": "01/08/2022",
89+
"volume": "",
90+
"volumeDate": "",
91+
"weight": 6.85,
92+
"weightTolerance": "4.38%",
93+
"weightDate": "01/08/2022",
94+
"shape": {
95+
"identifier":"component-catalogue-shape-0005",
96+
"category":"cylinder",
97+
"detailed":"3D shape with 2 parallel circular bases connected by a curved surface"
98+
},
99+
"function": {
100+
"identifier":"component-catalogue-function-0030",
101+
"category":"pot",
102+
"detailed":""
103+
},
104+
"flexibility": {
105+
"identifier": "component-catalogue-flexibility-0002",
106+
"category": "Rigid",
107+
"detailed": ""
108+
},
109+
"branding": "FALSE",
110+
"componentRecyclingDisruptors": "",
111+
"colour": "",
112+
"opacity": {
113+
"identifier": "component-catalogue-opacity-0003",
114+
"category": "transparent",
115+
"detailed": "allows light to pass through so that objects behind can be distinctly seen; no colour/ clear"
116+
},
117+
"loaned": "FALSE",
118+
"reuseSystem": "",
119+
"manufacturedCountry": {
120+
"Country": "United Kingdom of Great Britain and Northern Ireland (the)",
121+
"Numeric": 826
122+
},
123+
"recycledContent": 90,
124+
"recycledContentEvidenceType": {
125+
"identifier":"component-catalogue-recycled-evidence-0001",
126+
"category":"certificate",
127+
"detailed":""
128+
},
129+
"recycledContentEvidenceReference": "EXA-123-MPL-4-E",
130+
"recyclability": "TRUE",
131+
"recyclabilitySource": {
132+
"identifier":"complete-packaging-recyclability-source-0001",
133+
"category":"OPRL",
134+
"detailed":""
135+
},
136+
"recyclabilityDate": "01/08/2022",
137+
"partOfMultipack": "TRUE",
138+
"previouslyAssembledComponent": "FALSE",
139+
"componentLink": "NA",
140+
"updateDate": "01/08/2022",
141+
"releaseDate": "01/08/2022",
142+
"discontinueDate": ""
143+
}
144+
```
145+
=== "CSV download"
146+
147+
* [Component Catalogue example download](https://www.opendatamanchester.org.uk/wp-content/uploads/2023/01/7_1_1_Component_Catalogue_Example.csv){target=_blank}
148+
57149
## Guide for how to take measurements
58150

59151
### Units

0 commit comments

Comments
 (0)