@tiangong-lca/tidas-sdk 0.3.0 → 0.4.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
@@ -1,5 +1,318 @@
1
1
  {
2
2
  "$schema": "http://json-schema.org/draft-07/schema#",
3
+ "$defs": {
4
+ "ProcessReview": {
5
+ "type": "object",
6
+ "description": "Type of review that has been performed regarding independency and type of review process.",
7
+ "properties": {
8
+ "@type": {
9
+ "type": "string",
10
+ "enum": [
11
+ "Dependent internal review",
12
+ "Independent internal review",
13
+ "Independent external review",
14
+ "Accredited third party review",
15
+ "Independent review panel",
16
+ "Not reviewed"
17
+ ]
18
+ },
19
+ "common:scope": {
20
+ "description": "Scope of review regarding which aspects and components of the data set was reviewed or verified. In case of aggregated e.g. LCI results also and on which level of detail (e.g. LCI results only, included unit processes, ...) the review / verification was performed.",
21
+ "anyOf": [
22
+ {
23
+ "type": "object",
24
+ "properties": {
25
+ "@name": {
26
+ "type": "string",
27
+ "enum": [
28
+ "Raw data",
29
+ "Unit process(es), single operation",
30
+ "Unit process(es), black box",
31
+ "LCI results or Partly terminated system",
32
+ "LCIA results",
33
+ "Documentation",
34
+ "Life cycle inventory methods",
35
+ "LCIA results calculation",
36
+ "Goal and scope definition"
37
+ ]
38
+ },
39
+ "common:method": {
40
+ "description": "Validation method(s) used in the respective \"Scope of review\".",
41
+ "anyOf": [
42
+ {
43
+ "type": "object",
44
+ "properties": {
45
+ "@name": {
46
+ "type": "string",
47
+ "enum": [
48
+ "Validation of data sources",
49
+ "Sample tests on calculations",
50
+ "Energy balance",
51
+ "Element balance",
52
+ "Cross-check with other source",
53
+ "Cross-check with other data set",
54
+ "Expert judgement",
55
+ "Mass balance",
56
+ "Compliance with legal limits",
57
+ "Compliance with ISO 14040 to 14044",
58
+ "Documentation",
59
+ "Evidence collection by means of plant visits and/or interviews"
60
+ ]
61
+ }
62
+ },
63
+ "required": [
64
+ "@name"
65
+ ]
66
+ },
67
+ {
68
+ "type": "array",
69
+ "items": {
70
+ "type": "object",
71
+ "properties": {
72
+ "@name": {
73
+ "type": "string",
74
+ "enum": [
75
+ "Validation of data sources",
76
+ "Sample tests on calculations",
77
+ "Energy balance",
78
+ "Element balance",
79
+ "Cross-check with other source",
80
+ "Cross-check with other data set",
81
+ "Expert judgement",
82
+ "Mass balance",
83
+ "Compliance with legal limits",
84
+ "Compliance with ISO 14040 to 14044",
85
+ "Documentation",
86
+ "Evidence collection by means of plant visits and/or interviews"
87
+ ]
88
+ }
89
+ },
90
+ "required": [
91
+ "@name"
92
+ ]
93
+ }
94
+ }
95
+ ]
96
+ }
97
+ },
98
+ "required": [
99
+ "@name",
100
+ "common:method"
101
+ ]
102
+ },
103
+ {
104
+ "type": "array",
105
+ "items": {
106
+ "type": "object",
107
+ "properties": {
108
+ "@name": {
109
+ "type": "string",
110
+ "enum": [
111
+ "Raw data",
112
+ "Unit process(es), single operation",
113
+ "Unit process(es), black box",
114
+ "LCI results or Partly terminated system",
115
+ "LCIA results",
116
+ "Documentation",
117
+ "Life cycle inventory methods",
118
+ "LCIA results calculation",
119
+ "Goal and scope definition"
120
+ ]
121
+ },
122
+ "common:method": {
123
+ "description": "Validation method(s) used in the respective \"Scope of review\".",
124
+ "anyOf": [
125
+ {
126
+ "type": "object",
127
+ "properties": {
128
+ "@name": {
129
+ "type": "string",
130
+ "enum": [
131
+ "Validation of data sources",
132
+ "Sample tests on calculations",
133
+ "Energy balance",
134
+ "Element balance",
135
+ "Cross-check with other source",
136
+ "Cross-check with other data set",
137
+ "Expert judgement",
138
+ "Mass balance",
139
+ "Compliance with legal limits",
140
+ "Compliance with ISO 14040 to 14044",
141
+ "Documentation",
142
+ "Evidence collection by means of plant visits and/or interviews"
143
+ ]
144
+ }
145
+ },
146
+ "required": [
147
+ "@name"
148
+ ]
149
+ },
150
+ {
151
+ "type": "array",
152
+ "items": {
153
+ "type": "object",
154
+ "properties": {
155
+ "@name": {
156
+ "type": "string",
157
+ "enum": [
158
+ "Validation of data sources",
159
+ "Sample tests on calculations",
160
+ "Energy balance",
161
+ "Element balance",
162
+ "Cross-check with other source",
163
+ "Cross-check with other data set",
164
+ "Expert judgement",
165
+ "Mass balance",
166
+ "Compliance with legal limits",
167
+ "Compliance with ISO 14040 to 14044",
168
+ "Documentation",
169
+ "Evidence collection by means of plant visits and/or interviews"
170
+ ]
171
+ }
172
+ },
173
+ "required": [
174
+ "@name"
175
+ ]
176
+ }
177
+ }
178
+ ]
179
+ }
180
+ },
181
+ "required": [
182
+ "@name",
183
+ "common:method"
184
+ ]
185
+ }
186
+ }
187
+ ]
188
+ },
189
+ "common:dataQualityIndicators": {
190
+ "type": "object",
191
+ "description": "Data quality indicators serve to provide the reviewed key information on the data set in a defined, computer-readable (and hence searchable) form. This serves to support LCA practitioners to identify/select the highest quality and most appropriate data sets.",
192
+ "properties": {
193
+ "common:dataQualityIndicator": {
194
+ "description": "Data quality indicators serve to provide the reviewed key information on the data set in a defined, computer-readable (and hence searchable) form. This serves to support LCA practitioners to identify/select the highest quality and most appropriate data sets.",
195
+ "anyOf": [
196
+ {
197
+ "type": "object",
198
+ "properties": {
199
+ "@name": {
200
+ "type": "string",
201
+ "enum": [
202
+ "Technological representativeness",
203
+ "Time representativeness",
204
+ "Geographical representativeness",
205
+ "Completeness",
206
+ "Precision",
207
+ "Methodological appropriateness and consistency",
208
+ "Overall quality"
209
+ ]
210
+ },
211
+ "@value": {
212
+ "type": "string",
213
+ "enum": [
214
+ "Very good",
215
+ "Good",
216
+ "Fair",
217
+ "Poor",
218
+ "Very poor",
219
+ "Not evaluated / unknown",
220
+ "Not applicable"
221
+ ]
222
+ }
223
+ },
224
+ "required": [
225
+ "@name",
226
+ "@value"
227
+ ]
228
+ },
229
+ {
230
+ "type": "array",
231
+ "items": {
232
+ "type": "object",
233
+ "properties": {
234
+ "@name": {
235
+ "type": "string",
236
+ "enum": [
237
+ "Technological representativeness",
238
+ "Time representativeness",
239
+ "Geographical representativeness",
240
+ "Completeness",
241
+ "Precision",
242
+ "Methodological appropriateness and consistency",
243
+ "Overall quality"
244
+ ]
245
+ },
246
+ "@value": {
247
+ "type": "string",
248
+ "enum": [
249
+ "Very good",
250
+ "Good",
251
+ "Fair",
252
+ "Poor",
253
+ "Very poor",
254
+ "Not evaluated / unknown",
255
+ "Not applicable"
256
+ ]
257
+ }
258
+ },
259
+ "required": [
260
+ "@name",
261
+ "@value"
262
+ ]
263
+ }
264
+ }
265
+ ]
266
+ }
267
+ },
268
+ "required": [
269
+ "common:dataQualityIndicator"
270
+ ]
271
+ },
272
+ "common:reviewDetails": {
273
+ "$ref": "tidas_data_types.json#/$defs/FTMultiLang",
274
+ "description": "Summary of the review. All the following items should be explicitly addressed: Representativeness, completeness, and precision of Inputs and Outputs for the process in its documented location, technology and time i.e. both completeness of technical model (product, waste, and elementary flows) and completeness of coverage of the relevant problem fields (environmental, human health, resource use) for this specific good, service, or process. Plausibility of data. Correctness and appropriateness of the data set documentation. Appropriateness of system boundaries, cut-off rules, LCI modelling choices such as e.g. allocation, consistency of included processes and of LCI methodology. If the data set comprises pre-calculated LCIA results, the correspondence of the Input and Output elementary flows (including their geographical validity) with the applied LCIA method(s) should be addressed by the reviewer. An overall quality statement on the data set may be included here."
275
+ },
276
+ "common:referenceToNameOfReviewerAndInstitution": {
277
+ "$ref": "tidas_data_types.json#/$defs/GlobalReferenceType",
278
+ "description": "\"Contact data set\" of reviewer. The full name of reviewer(s) and institution(s) as well as a contact address and/or email should be provided in that contact data set."
279
+ },
280
+ "common:otherReviewDetails": {
281
+ "$ref": "tidas_data_types.json#/$defs/FTMultiLang",
282
+ "description": "Further information from the review process, especially comments received from third parties once the data set has been published or additional reviewer comments from an additional external review."
283
+ },
284
+ "common:referenceToCompleteReviewReport": {
285
+ "$ref": "tidas_data_types.json#/$defs/GlobalReferenceType",
286
+ "description": "\"Source data set\" of the complete review report."
287
+ },
288
+ "common:other": {
289
+ "$ref": "tidas_data_types.json#/$defs/CommonOther"
290
+ }
291
+ },
292
+ "required": [
293
+ "@type"
294
+ ],
295
+ "allOf": [
296
+ {
297
+ "if": {
298
+ "properties": {
299
+ "@type": {
300
+ "const": "Not reviewed"
301
+ }
302
+ }
303
+ },
304
+ "then": {},
305
+ "else": {
306
+ "required": [
307
+ "common:scope",
308
+ "common:reviewDetails",
309
+ "common:referenceToNameOfReviewerAndInstitution"
310
+ ]
311
+ }
312
+ }
313
+ ]
314
+ }
315
+ },
3
316
  "type": "object",
4
317
  "properties": {
5
318
  "processDataSet": {
@@ -719,311 +1032,15 @@
719
1032
  "properties": {
720
1033
  "review": {
721
1034
  "description": "Type of review that has been performed regarding independency and type of review process.",
722
- "type": "object",
723
- "properties": {
724
- "@type": {
725
- "type": "string",
726
- "enum": [
727
- "Dependent internal review",
728
- "Independent internal review",
729
- "Independent external review",
730
- "Accredited third party review",
731
- "Independent review panel",
732
- "Not reviewed"
733
- ]
734
- },
735
- "common:scope": {
736
- "description": "Scope of review regarding which aspects and components of the data set was reviewed or verified. In case of aggregated e.g. LCI results also and on which level of detail (e.g. LCI results only, included unit processes, ...) the review / verification was performed.",
737
- "anyOf": [
738
- {
739
- "type": "object",
740
- "properties": {
741
- "@name": {
742
- "type": "string",
743
- "enum": [
744
- "Raw data",
745
- "Unit process(es), single operation",
746
- "Unit process(es), black box",
747
- "LCI results or Partly terminated system",
748
- "LCIA results",
749
- "Documentation",
750
- "Life cycle inventory methods",
751
- "LCIA results calculation",
752
- "Goal and scope definition"
753
- ]
754
- },
755
- "common:method": {
756
- "description": "Validation method(s) used in the respective \"Scope of review\".",
757
- "anyOf": [
758
- {
759
- "type": "object",
760
- "properties": {
761
- "@name": {
762
- "type": "string",
763
- "enum": [
764
- "Validation of data sources",
765
- "Sample tests on calculations",
766
- "Energy balance",
767
- "Element balance",
768
- "Cross-check with other source",
769
- "Cross-check with other data set",
770
- "Expert judgement",
771
- "Mass balance",
772
- "Compliance with legal limits",
773
- "Compliance with ISO 14040 to 14044",
774
- "Documentation",
775
- "Evidence collection by means of plant visits and/or interviews"
776
- ]
777
- }
778
- },
779
- "required": [
780
- "@name"
781
- ]
782
- },
783
- {
784
- "type": "array",
785
- "items": {
786
- "type": "object",
787
- "properties": {
788
- "@name": {
789
- "type": "string",
790
- "enum": [
791
- "Validation of data sources",
792
- "Sample tests on calculations",
793
- "Energy balance",
794
- "Element balance",
795
- "Cross-check with other source",
796
- "Cross-check with other data set",
797
- "Expert judgement",
798
- "Mass balance",
799
- "Compliance with legal limits",
800
- "Compliance with ISO 14040 to 14044",
801
- "Documentation",
802
- "Evidence collection by means of plant visits and/or interviews"
803
- ]
804
- }
805
- },
806
- "required": [
807
- "@name"
808
- ]
809
- }
810
- }
811
- ]
812
- }
813
- },
814
- "required": [
815
- "@name",
816
- "common:method"
817
- ]
818
- },
819
- {
820
- "type": "array",
821
- "items": {
822
- "type": "object",
823
- "properties": {
824
- "@name": {
825
- "type": "string",
826
- "enum": [
827
- "Raw data",
828
- "Unit process(es), single operation",
829
- "Unit process(es), black box",
830
- "LCI results or Partly terminated system",
831
- "LCIA results",
832
- "Documentation",
833
- "Life cycle inventory methods",
834
- "LCIA results calculation",
835
- "Goal and scope definition"
836
- ]
837
- },
838
- "common:method": {
839
- "description": "Validation method(s) used in the respective \"Scope of review\".",
840
- "anyOf": [
841
- {
842
- "type": "object",
843
- "properties": {
844
- "@name": {
845
- "type": "string",
846
- "enum": [
847
- "Validation of data sources",
848
- "Sample tests on calculations",
849
- "Energy balance",
850
- "Element balance",
851
- "Cross-check with other source",
852
- "Cross-check with other data set",
853
- "Expert judgement",
854
- "Mass balance",
855
- "Compliance with legal limits",
856
- "Compliance with ISO 14040 to 14044",
857
- "Documentation",
858
- "Evidence collection by means of plant visits and/or interviews"
859
- ]
860
- }
861
- },
862
- "required": [
863
- "@name"
864
- ]
865
- },
866
- {
867
- "type": "array",
868
- "items": {
869
- "type": "object",
870
- "properties": {
871
- "@name": {
872
- "type": "string",
873
- "enum": [
874
- "Validation of data sources",
875
- "Sample tests on calculations",
876
- "Energy balance",
877
- "Element balance",
878
- "Cross-check with other source",
879
- "Cross-check with other data set",
880
- "Expert judgement",
881
- "Mass balance",
882
- "Compliance with legal limits",
883
- "Compliance with ISO 14040 to 14044",
884
- "Documentation",
885
- "Evidence collection by means of plant visits and/or interviews"
886
- ]
887
- }
888
- },
889
- "required": [
890
- "@name"
891
- ]
892
- }
893
- }
894
- ]
895
- }
896
- },
897
- "required": [
898
- "@name",
899
- "common:method"
900
- ]
901
- }
902
- }
903
- ]
904
- },
905
- "common:dataQualityIndicators": {
906
- "type": "object",
907
- "description": "Data quality indicators serve to provide the reviewed key information on the data set in a defined, computer-readable (and hence searchable) form. This serves to support LCA practitioners to identify/select the highest quality and most appropriate data sets.",
908
- "properties": {
909
- "common:dataQualityIndicator": {
910
- "description": "Data quality indicators serve to provide the reviewed key information on the data set in a defined, computer-readable (and hence searchable) form. This serves to support LCA practitioners to identify/select the highest quality and most appropriate data sets.",
911
- "anyOf": [
912
- {
913
- "type": "object",
914
- "properties": {
915
- "@name": {
916
- "type": "string",
917
- "enum": [
918
- "Technological representativeness",
919
- "Time representativeness",
920
- "Geographical representativeness",
921
- "Completeness",
922
- "Precision",
923
- "Methodological appropriateness and consistency",
924
- "Overall quality"
925
- ]
926
- },
927
- "@value": {
928
- "type": "string",
929
- "enum": [
930
- "Very good",
931
- "Good",
932
- "Fair",
933
- "Poor",
934
- "Very poor",
935
- "Not evaluated / unknown",
936
- "Not applicable"
937
- ]
938
- }
939
- },
940
- "required": [
941
- "@name",
942
- "@value"
943
- ]
944
- },
945
- {
946
- "type": "array",
947
- "items": {
948
- "type": "object",
949
- "properties": {
950
- "@name": {
951
- "type": "string",
952
- "enum": [
953
- "Technological representativeness",
954
- "Time representativeness",
955
- "Geographical representativeness",
956
- "Completeness",
957
- "Precision",
958
- "Methodological appropriateness and consistency",
959
- "Overall quality"
960
- ]
961
- },
962
- "@value": {
963
- "type": "string",
964
- "enum": [
965
- "Very good",
966
- "Good",
967
- "Fair",
968
- "Poor",
969
- "Very poor",
970
- "Not evaluated / unknown",
971
- "Not applicable"
972
- ]
973
- }
974
- },
975
- "required": [
976
- "@name",
977
- "@value"
978
- ]
979
- }
980
- }
981
- ]
982
- }
983
- },
984
- "required": [
985
- "common:dataQualityIndicator"
986
- ]
987
- },
988
- "common:reviewDetails": {
989
- "$ref": "tidas_data_types.json#/$defs/FTMultiLang",
990
- "description": "Summary of the review. All the following items should be explicitly addressed: Representativeness, completeness, and precision of Inputs and Outputs for the process in its documented location, technology and time i.e. both completeness of technical model (product, waste, and elementary flows) and completeness of coverage of the relevant problem fields (environmental, human health, resource use) for this specific good, service, or process. Plausibility of data. Correctness and appropriateness of the data set documentation. Appropriateness of system boundaries, cut-off rules, LCI modelling choices such as e.g. allocation, consistency of included processes and of LCI methodology. If the data set comprises pre-calculated LCIA results, the correspondence of the Input and Output elementary flows (including their geographical validity) with the applied LCIA method(s) should be addressed by the reviewer. An overall quality statement on the data set may be included here."
991
- },
992
- "common:referenceToNameOfReviewerAndInstitution": {
993
- "$ref": "tidas_data_types.json#/$defs/GlobalReferenceType",
994
- "description": "\"Contact data set\" of reviewer. The full name of reviewer(s) and institution(s) as well as a contact address and/or email should be provided in that contact data set."
995
- },
996
- "common:otherReviewDetails": {
997
- "$ref": "tidas_data_types.json#/$defs/FTMultiLang",
998
- "description": "Further information from the review process, especially comments received from third parties once the data set has been published or additional reviewer comments from an additional external review."
999
- },
1000
- "common:referenceToCompleteReviewReport": {
1001
- "$ref": "tidas_data_types.json#/$defs/GlobalReferenceType",
1002
- "description": "\"Source data set\" of the complete review report."
1035
+ "anyOf": [
1036
+ {
1037
+ "$ref": "#/$defs/ProcessReview"
1003
1038
  },
1004
- "common:other": {
1005
- "$ref": "tidas_data_types.json#/$defs/CommonOther"
1006
- }
1007
- },
1008
- "required": [
1009
- "@type"
1010
- ],
1011
- "allOf": [
1012
1039
  {
1013
- "if": {
1014
- "properties": {
1015
- "@type": {
1016
- "const": "Not reviewed"
1017
- }
1018
- }
1019
- },
1020
- "then": {},
1021
- "else": {
1022
- "required": [
1023
- "common:scope",
1024
- "common:reviewDetails",
1025
- "common:referenceToNameOfReviewerAndInstitution"
1026
- ]
1040
+ "type": "array",
1041
+ "minItems": 1,
1042
+ "items": {
1043
+ "$ref": "#/$defs/ProcessReview"
1027
1044
  }
1028
1045
  }
1029
1046
  ]