@tiangong-lca/tidas-sdk 0.1.13 → 0.1.15

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.
@@ -0,0 +1,476 @@
1
+ {
2
+ "_metadata": {
3
+ "bundled_at": "2025-08-29T10:55:00.181Z",
4
+ "total_files": 17,
5
+ "processed_files": 1,
6
+ "skipped_files": 16,
7
+ "file_list": [
8
+ "processes"
9
+ ]
10
+ },
11
+ "methodologies": {
12
+ "processes": {
13
+ "metadata": {
14
+ "version": "1.0.0",
15
+ "last_updated": "2024-01-15",
16
+ "applies_to": "ILCD/Tidas Process Dataset v1.1"
17
+ },
18
+ "global_rules": {
19
+ "multi_language_support": {
20
+ "<rules>": [
21
+ {
22
+ "language": "en",
23
+ "requirement": "English version is mandatory for all multilingual fields",
24
+ "purpose": "Ensures international accessibility"
25
+ },
26
+ {
27
+ "language": "zh",
28
+ "requirement": "中文版本建议提供,特别是中国地区的数据",
29
+ "purpose": "确保本地用户可理解性"
30
+ }
31
+ ]
32
+ }
33
+ },
34
+ "processDataSet": {
35
+ "processInformation": {
36
+ "dataSetInformation": {
37
+ "name": {
38
+ "baseName": {
39
+ "<rules>": [
40
+ {
41
+ "language": "en",
42
+ "naming_convention": "Format: [Output product/service]; [Technology/Route]; [Additional specifiers]\n- Start with the main output product or service\n- Include technology type if relevant\n- Add location or time specifiers if needed\n",
43
+ "content_requirements": [
44
+ "Use semicolons to separate major components",
45
+ "Avoid abbreviations except widely recognized ones (e.g., CO2, kWh)",
46
+ "Maximum 200 characters"
47
+ ],
48
+ "examples": [
49
+ "Electricity; hard coal; modern power plant; China 2023",
50
+ "Steel; electric arc furnace; recycled scrap",
51
+ "Transport; truck; Euro 6; 40t gross weight"
52
+ ],
53
+ "best_practices": [
54
+ "Be specific but concise",
55
+ "Include distinguishing technical characteristics",
56
+ "Use consistent terminology across datasets"
57
+ ]
58
+ },
59
+ {
60
+ "language": "zh",
61
+ "naming_convention": "格式:[产出产品/服务];[技术/路线];[附加说明]\n- 以主要产出产品或服务开头\n- 包含相关技术类型\n- 必要时添加地点或时间说明\n",
62
+ "content_requirements": [
63
+ "使用分号分隔主要组成部分",
64
+ "避免使用缩写,除非广泛认可",
65
+ "最长200个字符"
66
+ ],
67
+ "examples": [
68
+ "电力;燃煤;现代电厂;中国2023",
69
+ "钢铁;电弧炉;再生废料",
70
+ "运输;卡车;国六标准;40吨总重"
71
+ ],
72
+ "best_practices": [
73
+ "具体但简洁",
74
+ "包含关键技术特征",
75
+ "跨数据集使用一致的术语"
76
+ ]
77
+ }
78
+ ]
79
+ },
80
+ "treatmentStandardsRoutes": {
81
+ "<rules>": [
82
+ {
83
+ "language": "en",
84
+ "content_requirements": [
85
+ "Specify treatment standards (e.g., ISO, EN, GB standards)",
86
+ "Include process routes or pathways",
87
+ "Mention specific technologies or methods"
88
+ ],
89
+ "examples": [
90
+ "ISO 14040 compliant; wet process route",
91
+ "EU BAT reference; membrane technology"
92
+ ]
93
+ },
94
+ {
95
+ "language": "zh",
96
+ "content_requirements": [
97
+ "说明处理标准(如ISO、EN、GB标准)",
98
+ "包含工艺路线或路径",
99
+ "提及具体技术或方法"
100
+ ],
101
+ "examples": [
102
+ "符合ISO 14040标准;湿法工艺路线",
103
+ "欧盟最佳可行技术;膜技术"
104
+ ]
105
+ }
106
+ ]
107
+ }
108
+ },
109
+ "common:generalComment": {
110
+ "<rules>": [
111
+ {
112
+ "language": "en",
113
+ "structure": "Recommended structure:\n1. Process overview and purpose\n2. System boundaries description\n3. Key assumptions and limitations\n4. Data quality considerations\n5. Special remarks or warnings\n",
114
+ "writing_style": [
115
+ "Write in third person",
116
+ "Use present tense for current processes",
117
+ "Be objective and factual"
118
+ ],
119
+ "examples": [
120
+ "This dataset represents electricity production from hard coal in a modern \nsupercritical power plant. The system boundary includes coal handling, \ncombustion, and flue gas treatment. Efficiency is assumed at 45% net. \nData quality is high, based on measured plant data from 2023.\n"
121
+ ]
122
+ },
123
+ {
124
+ "language": "zh",
125
+ "structure": "建议结构:\n1. 流程概述和目的\n2. 系统边界描述\n3. 关键假设和限制\n4. 数据质量考虑\n5. 特别说明或警告\n",
126
+ "writing_style": [
127
+ "使用第三人称",
128
+ "当前流程使用现在时",
129
+ "客观、事实性描述"
130
+ ],
131
+ "examples": [
132
+ "该数据集代表现代超临界电厂的燃煤发电。系统边界包括煤炭处理、\n燃烧和烟气处理。净效率假定为45%。数据质量高,基于2023年\n实测电厂数据。\n"
133
+ ]
134
+ }
135
+ ]
136
+ }
137
+ },
138
+ "time": {
139
+ "referenceYear": {
140
+ "<rules>": [
141
+ {
142
+ "language": "all",
143
+ "format": "YYYY (4-digit year)",
144
+ "requirements": [
145
+ "Must be 4-digit format",
146
+ "Should represent the year of data validity",
147
+ "For future scenarios, clearly indicate in comments"
148
+ ],
149
+ "examples": {
150
+ "valid": [
151
+ "2023",
152
+ "2020",
153
+ "2025"
154
+ ],
155
+ "invalid": [
156
+ "23",
157
+ "2020-2021",
158
+ "2020s"
159
+ ]
160
+ }
161
+ }
162
+ ]
163
+ },
164
+ "timeRepresentativenessDescription": {
165
+ "<rules>": [
166
+ {
167
+ "language": "en",
168
+ "content_guide": [
169
+ "How well the reference year represents the technology",
170
+ "Expected changes or trends",
171
+ "Validity period justification"
172
+ ],
173
+ "examples": [
174
+ "Data represents average 2023 technology. The technology is mature with \nminimal expected changes until 2030. Annual efficiency improvements of \n0.5% may occur.\n"
175
+ ]
176
+ },
177
+ {
178
+ "language": "zh",
179
+ "content_guide": [
180
+ "参考年份对技术的代表性",
181
+ "预期变化或趋势",
182
+ "有效期说明"
183
+ ],
184
+ "examples": [
185
+ "数据代表2023年平均技术水平。技术成熟,预计2030年前变化较小。\n年效率可能提升0.5%。\n"
186
+ ]
187
+ }
188
+ ]
189
+ }
190
+ },
191
+ "geography": {
192
+ "locationOfOperationSupplyOrProduction": {
193
+ "location": {
194
+ "<rules>": [
195
+ {
196
+ "language": "all",
197
+ "naming_convention": "ISO 3166-1 alpha-2 codes",
198
+ "code_mapping": {
199
+ "countries": {
200
+ "CN": "China",
201
+ "US": "United States",
202
+ "DE": "Germany"
203
+ },
204
+ "regions": {
205
+ "GLO": "Global",
206
+ "RER": "Europe region",
207
+ "RNA": "North America region",
208
+ "RAF": "Africa region",
209
+ "RAS": "Asia region",
210
+ "RLA": "Latin America region",
211
+ "ROW": "Rest of World"
212
+ }
213
+ },
214
+ "subdivision_format": "ISO 3166-2 (e.g., CN-GD for Guangdong)",
215
+ "examples": [
216
+ "CN",
217
+ "GLO",
218
+ "CN-GD"
219
+ ]
220
+ }
221
+ ]
222
+ },
223
+ "descriptionOfRestrictions": {
224
+ "<rules>": [
225
+ {
226
+ "language": "en",
227
+ "content_requirements": [
228
+ "Explain any geographic limitations",
229
+ "Mention climate or regional factors",
230
+ "Note infrastructure dependencies"
231
+ ],
232
+ "examples": [
233
+ "Valid for temperate climate zones. Requires access to waterways for \ncooling. Grid connection assumes European standard voltage.\n"
234
+ ]
235
+ },
236
+ {
237
+ "language": "zh",
238
+ "content_requirements": [
239
+ "说明地理限制",
240
+ "提及气候或区域因素",
241
+ "说明基础设施依赖"
242
+ ],
243
+ "examples": [
244
+ "适用于温带气候区。需要水路用于冷却。电网连接假定欧洲标准电压。\n"
245
+ ]
246
+ }
247
+ ]
248
+ }
249
+ }
250
+ },
251
+ "technology": {
252
+ "technologyDescriptionAndIncludedProcesses": {
253
+ "<rules>": [
254
+ {
255
+ "language": "en",
256
+ "structure": [
257
+ "Technology type and generation",
258
+ "Process steps included",
259
+ "Auxiliary processes",
260
+ "Excluded processes (cut-off)"
261
+ ],
262
+ "writing_guidelines": [
263
+ "Use technical but accessible language",
264
+ "Define acronyms on first use",
265
+ "List process steps sequentially"
266
+ ],
267
+ "examples": [
268
+ "Ultra-supercritical (USC) pulverized coal combustion technology, \n600°C/620°C steam conditions. Includes: coal grinding, combustion, \nsteam generation, turbine operation, condensation. Auxiliary: \nDeNOx (SCR), DeSOx (FGD), ESP for particulates. Excludes: \ncoal mining, ash disposal infrastructure.\n"
269
+ ]
270
+ },
271
+ {
272
+ "language": "zh",
273
+ "structure": [
274
+ "技术类型和代别",
275
+ "包含的工艺步骤",
276
+ "辅助过程",
277
+ "排除的过程(截断)"
278
+ ],
279
+ "writing_guidelines": [
280
+ "使用专业但易懂的语言",
281
+ "首次使用时定义缩略词",
282
+ "按顺序列出工艺步骤"
283
+ ],
284
+ "examples": [
285
+ "超超临界(USC)煤粉燃烧技术,600°C/620°C蒸汽条件。包括:磨煤、\n燃烧、蒸汽发生、汽轮机运行、冷凝。辅助:脱硝(SCR)、脱硫(FGD)、\n静电除尘器。不包括:煤炭开采、灰渣处理基础设施。\n"
286
+ ]
287
+ }
288
+ ]
289
+ }
290
+ }
291
+ },
292
+ "modellingAndValidation": {
293
+ "LCIMethodAndAllocation": {
294
+ "typeOfDataSet": {
295
+ "<rules>": [
296
+ {
297
+ "language": "all",
298
+ "valid_values": [
299
+ "Unit process, single operation",
300
+ "Unit process, black box",
301
+ "LCI result",
302
+ "Partly terminated system"
303
+ ],
304
+ "description": "Defines the type and aggregation level of the process"
305
+ }
306
+ ]
307
+ },
308
+ "LCIMethodPrinciple": {
309
+ "<rules>": [
310
+ {
311
+ "language": "all",
312
+ "valid_values": [
313
+ "Attributional",
314
+ "Consequential",
315
+ "Not applicable"
316
+ ],
317
+ "applicability": "Required for LCI results"
318
+ }
319
+ ]
320
+ },
321
+ "modellingConstants": {
322
+ "<rules>": [
323
+ {
324
+ "language": "all",
325
+ "format": "key-value pairs",
326
+ "naming_convention": [
327
+ "Use lowercase with underscores",
328
+ "Include units in the name or separately"
329
+ ],
330
+ "examples": [
331
+ "efficiency: 0.45",
332
+ "capacity_factor: 0.85",
333
+ "lifetime_years: 30"
334
+ ]
335
+ }
336
+ ]
337
+ }
338
+ },
339
+ "dataSourcesTreatmentAndRepresentativeness": {
340
+ "dataCollectionPeriod": {
341
+ "<rules>": [
342
+ {
343
+ "language": "all",
344
+ "format": "YYYY-MM to YYYY-MM or YYYY",
345
+ "alignment": "Should align with referenceYear",
346
+ "examples": [
347
+ "2023",
348
+ "2023-01 to 2023-12",
349
+ "2022-06 to 2023-05"
350
+ ]
351
+ }
352
+ ]
353
+ }
354
+ },
355
+ "validation": {
356
+ "review": {
357
+ "scope": {
358
+ "<rules>": [
359
+ {
360
+ "language": "all",
361
+ "valid_scopes": [
362
+ "Raw data",
363
+ "Unit process(es), single operation",
364
+ "Unit process(es), black box",
365
+ "LCI results or Partly terminated system",
366
+ "LCIA results",
367
+ "Life cycle inventory methods",
368
+ "Goal and scope definition",
369
+ "LCIA methods"
370
+ ],
371
+ "requirement": "At least one review recommended for published datasets"
372
+ }
373
+ ]
374
+ }
375
+ }
376
+ }
377
+ },
378
+ "administrativeInformation": {
379
+ "dataEntryBy": {
380
+ "common:timeStamp": {
381
+ "<rules>": [
382
+ {
383
+ "language": "all",
384
+ "format": "ISO 8601",
385
+ "pattern": "YYYY-MM-DDTHH:MM:SS",
386
+ "examples": [
387
+ "2024-01-15T10:30:00",
388
+ "2023-12-31T23:59:59"
389
+ ]
390
+ }
391
+ ]
392
+ }
393
+ },
394
+ "publicationAndOwnership": {
395
+ "common:dataSetVersion": {
396
+ "<rules>": [
397
+ {
398
+ "language": "all",
399
+ "format": "Semantic versioning",
400
+ "pattern": "major.minor.patch",
401
+ "examples": [
402
+ "1.0.0",
403
+ "2.1.3",
404
+ "0.9.1-beta"
405
+ ]
406
+ }
407
+ ]
408
+ },
409
+ "permanentDataSetURI": {
410
+ "<rules>": [
411
+ {
412
+ "language": "all",
413
+ "requirement": "Optional but recommended for published datasets",
414
+ "format": "Resolvable URI",
415
+ "examples": [
416
+ "https://example.org/ilcd/processes/550e8400-e29b-41d4",
417
+ "https://data.ecoinvent.org/process/abc-123-def"
418
+ ]
419
+ }
420
+ ]
421
+ }
422
+ }
423
+ },
424
+ "exchanges": {
425
+ "exchange": {
426
+ "referenceToFlowDataSet": {
427
+ "<rules>": [
428
+ {
429
+ "language": "all",
430
+ "naming_convention": {
431
+ "elementary_flows": "Follow ILCD nomenclature",
432
+ "product_flows": "Follow process name rules",
433
+ "waste_flows": "Prefix with 'waste' or '废物'"
434
+ },
435
+ "validation": "Must reference existing flow dataset UUID"
436
+ }
437
+ ]
438
+ },
439
+ "meanAmount": {
440
+ "<rules>": [
441
+ {
442
+ "language": "all",
443
+ "data_type": "Decimal number",
444
+ "requirement": "Required unless resultingAmount is provided",
445
+ "sign_convention": "Positive or negative depending on direction"
446
+ }
447
+ ]
448
+ },
449
+ "dataSourceType": {
450
+ "<rules>": [
451
+ {
452
+ "language": "all",
453
+ "valid_values": [
454
+ "Primary data",
455
+ "Secondary data",
456
+ "Calculated",
457
+ "Unknown"
458
+ ],
459
+ "requirement": "Required for all exchanges"
460
+ }
461
+ ]
462
+ },
463
+ "location": {
464
+ "<rules>": [
465
+ {
466
+ "language": "all",
467
+ "consistency_rule": "Should align with process location unless specifically different\n(e.g., imported materials, exported products)\n"
468
+ }
469
+ ]
470
+ }
471
+ }
472
+ }
473
+ }
474
+ }
475
+ }
476
+ }
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@tiangong-lca/tidas-sdk",
3
- "version": "0.1.13",
3
+ "version": "0.1.15",
4
4
  "main": "dist/index.js",
5
5
  "types": "dist/index.d.ts",
6
6
  "module": "dist/index.js",
@@ -32,10 +32,11 @@
32
32
  }
33
33
  },
34
34
  "scripts": {
35
- "build": "tsc && cp -r tidas-tools/src/tidas_tools/tidas/methodologies dist/methodologies",
35
+ "build": "tsx scripts/bundle-methodologies.ts && tsc",
36
36
  "dev": "tsc --watch",
37
37
  "clean": "rm -rf dist",
38
38
  "prebuild": "npm run clean",
39
+ "bundle-methodologies": "tsx scripts/bundle-methodologies.ts",
39
40
  "generate-types": "tsx scripts/generate-types.ts",
40
41
  "generate-schemas": "tsx scripts/generate-zod-schemas.ts",
41
42
  "lint": "eslint .",