Skip to content

Latest commit

 

History

History
182 lines (139 loc) · 5.04 KB

format_csv_ref_data.md

File metadata and controls

182 lines (139 loc) · 5.04 KB
Raw

CSV format for openLCA reference data

Reference data are common units, flow properties, flows, locations, LCIA categories etc. for different databases. We store these data in simple CSV files in order to create reference data packages from scratch; it shouldn't be used as a general data exchange format. All CSV files need to have the following format:

  • the first row contains the column headers
  • the file encoding must be utf-8 without byte-order-mark
  • the column separator is a comma: ,
  • strings should be enclosed in double quotes, but only if necessary: "
  • the decimal separator of numbers is a decimal point: .

Locations

File:locations.csv

0  | ID          | required | uuid
1  | Name        | required | string
2  | Description | optional | string
3  | Category    | optional | path
4  | Code        | required | string
5  | Latitude    | required | double
6  | Longitude   | required | double

Unit groups

File:unit_groups.csv

0  | ID                    | required | uuid
1  | Name                  | required | string
2  | Description           | optional | string
3  | Category              | optional | path
4  | Default flow property | optional | uuid or name
5  | Reference unit        | required | uuid or name

File:units.csv

0 | ID                 | required | uuid
1 | Name               | required | string
2 | Description        | optional | string
3 | Conversion factor  | required | double
4 | Synonyms           | optional | string list separated by semicolons
5 | Unit group         | required | uuid or name

Flow properties

File:flow_properties.csv

0  | ID            | required | uuid
1  | Name          | required | string
2  | Description   | optional | string
3  | Category      | optional | path
4  | Unit group    | required | uuid or name
5  | Property type | optional | "economic" else "physical"

Flows

File:flows.csv

0  | ID                      | required | uuid
1  | Name                    | required | string
2  | Description             | optional | string
3  | Category                | optional | path
4  | Flow type               | required | "elementary" or "product" or "waste"
5  | CAS number              | optional | string
6  | Chem. formula           | optional | string
7  | Reference flow property | required | uuid or name

File:flow_property_factors.csv

This file is optional and only required, if additional flow properties than the reference flow properties should be added to a flow.

0 | Flow              | required | uuid
1 | Flow property     | required | uuid or name
2 | Conversion factor | required | double

Currencies

File:currencies.csv

Note that all currencies should have the same reference currency.

0  | ID                 | required | uuid
1  | Name               | required | string
2  | Description        | optional | string
3  | Category           | optional | path
4  | Reference currency | required | name or uuid
5  | Currency code      | required | string
6  | Conversion factor  | required | double

LCIA categories

File: lcia_categories.csv

0  | ID                 | required | uuid
1  | Name               | required | string
2  | Description        | optional | string
3  | Category           | optional | path
4  | Reference unit     | optional | string

Files: lcia_factors/{short-id}.csv

A reference database can contain many LCIA categories and each LCIA category can contain many characterization factors. We therefore write the characterization factors of each LCIA category into a separate file. These files are located in a lcia_factors sub-folder. Anything can be used as name of file in this folder, we typically take the first part of the uuid of an LCIA category for this.

0 | LCIA category | required | uuid
1 | Flow          | required | uuid
2 | Flow property | required | uuid or name
3 | Flow unit     | required | uuid or name
4 | Location      | optional | uuid or name
5 | Factor        | required | double or formula

File: lcia_parameters_{short-id}.csv

This file is not handled yet in the openLCA import and export.

0 | LCIA category | required | uuid
1 | Parameter     | required | string
2 | Value         | required | double or formula

LCIA methods

File:lcia_methods.csv

0 | ID           | required | uuid
1 | Name         | required | string
2 | Description  | optional | string
3 | Category     | optional | path

File:lcia_method_categories.csv

0 | LCIA method   | required | uuid or name
1 | LCIA category | required | uuid

File:lcia_method_nw_sets.csv

This file contains the normalization and weighting sets (NW sets) of the LCIA methods.

0 | LCIA method          | required | uuid or name
1 | NW set - ID          | required | uuid
2 | NW set - name        | required | string
3 | LCIA category        | required | uuid
4 | Nomalisation factor  | optional | double
5 | Weighting factor     | optional | double
6 | Weighting score unit | optional | string