Skip to content

Commit dacdf82

Browse files
DsposalTomDsposalTom
committed
Added downloads for templates and examples
1 parent 27f8fd2 commit dacdf82

7 files changed

Lines changed: 73 additions & 11 deletions

File tree

‎docs/3_Data_Specification/3_1_Material_Catalogue.md‎

Lines changed: 24 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -21,6 +21,25 @@ The materials catalogue schema contains information regarding the base material.
2121

2222
## Diagram
2323

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+
2443
<figure markdown>
2544
[![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}
2645
<figcaption>Data schema</figcaption>
@@ -32,7 +51,7 @@ Materials should be provided as a separate csv file, in tidy format. This means
3251

3352
The specification of this csv file is as follows:
3453

35-
[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}
54+
[Material_Catalogue_Template.csv](https://www.opendatamanchester.org.uk/wp-content/uploads/2023/01/7_1_7_Materials_Catalogue_Template.csv){target=_blank}
3655

3756
## Example
3857

@@ -63,6 +82,10 @@ The specification of this csv file is as follows:
6382
"updateDate": "01/08/2022",
6483
}
6584
```
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+
6689

6790
## Guide for how to take measurements
6891

‎docs/3_Data_Specification/3_2_Material.md‎

Lines changed: 4 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -29,7 +29,7 @@ Materials should be provided as a separate csv file, in tidy format. This means
2929

3030
The specification of this csv file is as follows:
3131

32-
[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}
32+
[Materials_Template.csv](https://www.opendatamanchester.org.uk/wp-content/uploads/2023/01/7_1_2_Materials_Template.csv){target=_blank}
3333

3434
## Example
3535

@@ -49,6 +49,9 @@ The specification of this csv file is as follows:
4949
"updateDate": "01/08/2022",
5050
}
5151
```
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}
5255

5356
## Guide for how to take measurements
5457

‎docs/3_Data_Specification/3_3_Component_Catalogue.md‎

Lines changed: 4 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -63,7 +63,7 @@ Components should be provided as a separate csv file, in tidy format. This means
6363

6464
The specification of this csv file is as follows:
6565

66-
[component_catalogue.csv](https://github.com/OpenDataManchester/PPP/blob/main/docs/7_Supporting_Files/7_1_1_Component_Catalogue_Template.csv){target=_blank}
66+
[Component_Catalogue_Template.csv](https://www.opendatamanchester.org.uk/wp-content/uploads/2023/01/7_1_1_Component_Catalogue_Template.csv){target=_blank}
6767

6868
## Example
6969

@@ -142,6 +142,9 @@ The specification of this csv file is as follows:
142142
"discontinueDate": ""
143143
}
144144
```
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}
145148

146149
## Guide for how to take measurements
147150

‎docs/3_Data_Specification/3_4_Complete_Packaging.md‎

Lines changed: 4 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -57,7 +57,7 @@ Complete packaging should be provided as a separate csv file, in tidy format. Th
5757

5858
The specification of this csv file is as follows:
5959

60-
[complete_packaging.csv ](https://github.com/OpenDataManchester/PPP/blob/main/docs/7_Supporting_Files/7_1_3_Complete_Packaging_Template.csv){target=_blank}
60+
[Complete_Packaging_Template.csv](https://www.opendatamanchester.org.uk/wp-content/uploads/2023/01/7_1_3_Complete_Packaging_Template.csv){target=_blank}
6161

6262
## Example
6363

@@ -128,6 +128,9 @@ The specification of this csv file is as follows:
128128
"discontinueDate": ""
129129
}
130130
```
131+
=== "CSV download"
132+
133+
* [Complete Packaging example download](https://www.opendatamanchester.org.uk/wp-content/uploads/2023/01/7_1_3_Complete_Packaging_Example.csv){target=_blank}
131134

132135
## Guide for how to take measurements
133136

‎docs/3_Data_Specification/3_5_Multipack.md‎

Lines changed: 27 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -6,6 +6,8 @@ title: Multipack
66

77
The multipack schema contains information regarding the multipacks that are used to create loads. These are created from a number of either identical or different complete packages from the complete packaging schema.
88

9+
**Note:** The multipack portion is optional (only applies to multipacks). If the complete packaging or component is *not* in a multipack, all of the fields below are optional.
10+
911
## Table
1012
|Column|<div style="width:90px">Status</div>|Format|Notes|
1113
|:-|:-|:-|:-|
@@ -23,20 +25,38 @@ The multipack schema contains information regarding the multipacks that are used
2325

2426
## Diagram
2527

28+
<!-- ``` mermaid
29+
erDiagram
30+
LOAD_CATATLOGUE }o..o{ MULTIPACK : part
31+
MULTIPACK {
32+
identifier String
33+
name String
34+
description String
35+
tags Dictionary
36+
multipackIdentifier String
37+
packagingItems String
38+
tier String
39+
identicalQuantity Numeric
40+
updateDate String
41+
releaseDate String
42+
discontinueDate String
43+
}
44+
MULTIPACK }o--o{ COMPLETE_PACKAGING : contains
45+
MULTIPACK }o--o{ COMPONENT_CATATLOGUE : contains
46+
``` -->
47+
2648
<figure markdown>
2749
[![Schema](../img/multipack-v1.0.0-22-12-20.png){ width="450" }](https://opendatamanchester.github.io/PPP/img/multipack-v1.0.0-22-12-20.png){target=_blank}
2850
<figcaption>Data schema</figcaption>
2951
</figure>
3052

3153
## Template
3254

33-
**Note:** The multipack portion is optional (only applies to multipacks). If the complete packaging or component is *not* in a multipack, all of the fields below are optional.
34-
3555
Multipack should be provided as a separate csv file, in tidy format. This means that each row of the csv file should be one multipack of a load. An example is provided.
3656

3757
The specification of this csv file is as follows:
3858

39-
[multipack.csv](https://github.com/OpenDataManchester/PPP/blob/main/docs/7_Supporting_Files/7_1_4_Multipack_Template.csv){target=_blank}
59+
[Multipack_Template.csv](https://www.opendatamanchester.org.uk/wp-content/uploads/2023/01/7_1_4_Multipack_Template.csv){target=_blank}
4060

4161
## Example
4262

@@ -58,4 +78,7 @@ The specification of this csv file is as follows:
5878
"releaseDate": "01/08/2022",
5979
"discontinueDate": "",
6080
}
61-
```
81+
```
82+
=== "CSV download"
83+
84+
* [Multipack example download](https://www.opendatamanchester.org.uk/wp-content/uploads/2023/01/7_1_4_Multipack_Example.csv){target=_blank}

‎docs/3_Data_Specification/3_6_Load_Catalogue.md‎

Lines changed: 4 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -32,7 +32,7 @@ Loads should be provided as a separate csv file, in tidy format. This means that
3232

3333
The specification of this csv file is as follows:
3434

35-
[load_Catalogue.csv](https://github.com/OpenDataManchester/PPP/blob/main/docs/7_Supporting_Files/7_1_5_Load_Catalogue_Template.csv){target=_blank}
35+
[Load_Catalogue_Template.csv](https://www.opendatamanchester.org.uk/wp-content/uploads/2023/01/7_1_5_Load_Catalogue_Template.csv){target=_blank}
3636

3737
## Example
3838

@@ -57,3 +57,6 @@ The specification of this csv file is as follows:
5757
"updateDate": "01/08/2022",
5858
}
5959
```
60+
=== "CSV download"
61+
62+
* [Load Catalogue example download](https://www.opendatamanchester.org.uk/wp-content/uploads/2023/01/7_1_5_Load_Catalogue_Example.csv){target=_blank}

‎docs/3_Data_Specification/3_7_Load.md‎

Lines changed: 6 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -36,7 +36,7 @@ Loads should be provided as a separate csv file, in tidy format. This means that
3636

3737
The specification of this csv file is as follows:
3838

39-
[load.csv](https://github.com/OpenDataManchester/PPP/blob/main/docs/7_Supporting_Files/7_1_6_Load_Template.csv){target=_blank}
39+
[Load_Template.csv](https://www.opendatamanchester.org.uk/wp-content/uploads/2023/01/7_1_6_Load_Template.csv){target=_blank}
4040

4141
## Example
4242

@@ -60,4 +60,8 @@ The specification of this csv file is as follows:
6060
"timesSent": "2",
6161
"updateDate": "01/08/2022",
6262
}
63-
```
63+
```
64+
=== "CSV download"
65+
66+
* [Load example download](https://www.opendatamanchester.org.uk/wp-content/uploads/2023/01/7_1_6_Load_Example.csv){target=_blank}
67+

0 commit comments

Comments
 (0)