Data reading

To work with emissions data in PRIMAP2 it needs to be converted into the PRIMAP2 netcdf data format. For the most important datasets we will (in the future) offer datalad packages that can automatically download and process the data. But currently and for custom data you will need to do the conversion yourself.

General information

The data reading functionality is bundled in the PRIMAP2 submodule pm2io.

To enable a wider use of the PRIMAP2 data reading functionality we read all data into the PRIMAP2 interchange format which is a wide format pandas DataFrame with coordinates in columns and following PRIMAP2 specifications. Additional meta data is stored in DataFrame.attrs. As the attrs functionality in pandas is experimental it is just stored in the DataFrame returned by the reading functions and should be stored individually before doing any processing with the DataFrame.

The PRIMAP2 interchange format can then be converted into native PRIMAP2 xarray Datasets.

For details on data reading see the following sections and example code linked therein.

Wide csv file

The function primap2.pm2io.read_wide_csv_file_if() reads wide format csv files which are widely used for emissions data. All coordinate columns can be defined using dicts as input including giving default values for coordinates not available in the csv files. Data can be filtered for wanted or unwanted coordinate values.

To illustrate the use of the function we have two examples. The first example illustrates the different input parameters using a simple test dataset while the second example is a real world use of the function reading the PRIMAP-hist v2.2 dataset into PRIMAP2.

Long (tidy) csv file

The function primap2.pm2io.read_long_csv_file_if() reads long format CSV files (also often called tidy CSV files), which are for example used by the FAOstat for agriculture emissions data. The input for the function is very similar to the input for primap2.pm2io.read_wide_csv_file_if() described previously, with the difference mainly that you have to specify the column where to find the data and time information.

To illustrate the use of the function, we have again two examples. The first example just reads in some example data to understand how the function works. The second example shows how to read in FAOstat data into PRIMAP2.

Treatment of string codes

String codes like “IE”, “NA” etc. need to be mapped to numerical values. The codes have to be interpreted to select if they have to be mapped to 0 or NaN. For example “IE” stands for “included elsewhere” and thus it has to be mapped to 0 to show that emissions in this timeseries are 0 and not missing.

As a default, we use easy rules combined with defined mappings for special cases. The rules are

  • If the code contains IE and/or NO it is mapped to 0

  • If the code contains NE and/or NA but neither IE nor NO, it is mapped to NaN.

The special cases are

_special_codes = {
    "C": np.nan,
    "nan": np.nan,
    "NaN": np.nan,
    "-": 0,
    "NE0": np.nan,
    "": np.nan,

NaN and nan will be detected as np.nan.

Users can define custom rules by assigning a dict in the format of _special_rules to the convert_str parameter.

Further formats

In the future we will offer data reading functions for further formats. Information will be added here.