Merge pull request #11 from OpenDataManchester/new_materials

separate out materials

docs/3_Data_Specification/3_2_Component_Catalogue_Materials.md → docs/3_Data_Specification/3_1_Material_Catalogue.md

@@ -1,6 +1,6 @@
 # Component Catalogue 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.
+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:
 
@@ -9,15 +9,24 @@ The specification of this csv file is as follows:
 |Column|Status|Format|Notes|
 |:-|:-|:-|:-|
 |identifier|`required`|String|A globally unique identifier. See identifiers section for information on how to construct this identifier|
-|componentCatalogue|`required`|String|The unique identifier of the component that this row relates to. There must be an equivalent record in the `component_Catalogue` data|
-|layer|`recommended`|integer|The layer associated with the component. The inner most layer (the layer closest to the product) denoted as 1, and the outermost layer is the biggest number.|
-|materialWeight|`recommended`|numeric|The percentage of the total materials making-up the component. For every unique componentCatalogue, weightMaterial should add to 100%.|
+|materialVolume|`recommended`|numeric|The amount of material used given in `ml` (See 'Guide for how to take measurements' below).|
 |materialType|`recommended`|String|Is the material 'synthetic' or 'biobased'? Use the identifier of the material type that this row relates to. The entry here should be drawn from the material type controlled list.|
-|materialPurpose|`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.|
+|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`.|
-|materialOther|`recommended`|String|If the materialChemCID is `Unknown`, please enter the unique material here.|
-|materialPrivacy|`required`|Boolean|Is the unique materialChemCID or materialOther anonymous/ privately protected?|
 |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`.|
+
+## Guide for how to take measurements
+
+### Units
+
+All measurements should be given using the metric system.
+
+- Volume: millilitre (ml)
+
+Numbers should be entered with a decimal place. Use the decimal / full stop / period character as a separator. Do not exceed 3 decimal places. When rounding, use convential rounding methods: for 5 and above round up, 4 and below round down. For example: volume = 0.67952 rounded to 0.68. 
+
+**Important**: When converting between systems of measurement, perform the conversion first and then apply the convential rounding. This will give more accuracy and consistency.
+

docs/3_Data_Specification/3_2_Material.md

@@ -0,0 +1,17 @@
+# Component Catalogue 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.
+
+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}
+
+|Column|Status|Format|Notes|
+|:-|:-|:-|:-|
+|identifier|`required`|String|A globally unique identifier. See identifiers section for information on how to construct this identifier|
+|materialIdentifier|`required`|String|The unique identifier of the created materials. See identifiers section for information on how to construct this identifier.|
+|materialCatalogue|`required`|String|The unique identifier of the material that this row relates to. There must be an equivalent record in the `material_Catalogue` data|
+|layer|`recommended`|integer|The layer associated with the component. The inner most layer (the layer closest to the product) denoted as 1, and the outermost layer is the biggest number.|
+|materialWeight|`recommended`|numeric|The percentage of the total materials making-up the component. For every unique componentCatalogue, weightMaterial should add to 100%.|
+|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`.|

docs/3_Data_Specification/3_1_Component_Catalogue.md → docs/3_Data_Specification/3_3_Component_Catalogue.md

@@ -15,6 +15,7 @@ The following table lists the column headings that should be used. When providin
 |tags|`recommended`|Dictionary|A dictionary of identifiers that might be used to identify the component in other systems. For example: bar codes or global trade item number (gtin). To provide tags please follow this format. `{'tagName1': 'identifier1', 'tagName2': 'identifier2'}`|
 |imageURL|`recommended`|URL|A URL that links to a picture of the component. Please see the guidelines below on how to capture the image and name the URL.|
 |LOWcode|`recommended`|String|The list of waste code for **only** the component, by itself. LOW code is synonymous with European Waste Catelogue Code (EWC). For example: an empty bottle would have a LOWcode of `15 01 02`. Please use [Dsposal](https://dsposal.uk/browse/ewc){target=_blank} or [legislation.gov](https://www.legislation.gov.uk/uksi/2005/895/schedule/1/made){target=_blank} to find the LOWcode. **Note**: The LOWcode can based on its combination with other components and the actual product contained in the completePackaging. Be sure to only include the component LOWcode. If you cannot find the code or are uncertain please enter `Uncertain`.|
+|materialIdentifier|`required`|String|The unique identifier of the materials that this component is made of. There must be an equivalent record in the `materials` data.|
 |height|`recommended`|Numeric|The height of the component. Please see the guidelines below on how to properly measure and report the height.|
 |heightDate|`recommended`|String|The date that the height was last verified/measured. Use the format `dd/mm/yyyy`.|
 |width|`recommended`|Numeric|The width of the component. Please see the guidelines below on how to properly measure and report the width.|

docs/7_Supporting_Files/7_1_1_Material_Component_Template.csv

@@ -0,0 +1 @@
+identifier,materialVolume,materialType,materialPurpose,materialCategory,materialName,materialChemCID,virginMaterial,updateDate

docs/7_Supporting_Files/7_1_2_Material_Template.csv

@@ -0,0 +1 @@
+identifier,materialIdentifier,materialCatalogue,layer,materialWeight,combinationPurpose,updateDate

docs/8_Change_Log/8_1_Change_Log.md

@@ -1,5 +1,12 @@
 # Latest Updates
 A document that contains all the changes made to the standard.
+## December 20, 2022
+### Model
+- separate out materials and material catalogue -> move to the front of the process
+
+### Data Fields
+- Component Catalogue: add identifier to link materials
+
 ## November 25, 2022
 ### Documentation
 - Add definitions of recycling and reuse