Skip to main content
Ctrl+K

primap2 documentation

Contents

  • Installation
  • Usage
    • Select and View Data
    • Store and load datasets
    • Add and overwrite data
    • Log messages
    • Merging datasets
    • Dealing with missing information
    • Downscaling
    • Gas baskets
    • The Composite Source Generator
  • Data Format
    • Data format
    • Data format details
    • Interchange format
    • Interchange format details
  • Data Reading
    • Data reading example 1 - minimal test dataset
    • Data reading example 2 - PRIMAP-hist v2.2
    • Data reading example 3 - minimal test dataset (long)
  • Data Packages
  • Development
  • Credits
  • Changelog
  • API
    • primap2.Not
    • primap2.ProcessingStepDescription
    • primap2.TimeseriesProcessingDescription
    • primap2.accessors
    • primap2.open_dataset
    • primap2.ureg
    • primap2.pm2io.convert_long_dataframe_if
    • primap2.pm2io.convert_wide_dataframe_if
    • primap2.pm2io.from_interchange_format
    • primap2.pm2io.nir_add_unit_information
    • primap2.pm2io.nir_convert_df_to_long
    • primap2.pm2io.read_interchange_format
    • primap2.pm2io.read_long_csv_file_if
    • primap2.pm2io.read_wide_csv_file_if
    • primap2.pm2io.write_interchange_format
    • primap2.csg.FitParameters
    • primap2.csg.GlobalLSStrategy
    • primap2.csg.LocalTrendsStrategy
    • primap2.csg.PriorityDefinition
    • primap2.csg.StrategyDefinition
    • primap2.csg.StrategyUnableToProcess
    • primap2.csg.SubstitutionStrategy
    • primap2.csg.compose
    • primap2.csg.create_composite_source
    • xarray.DataArray.pr.dim_alias_translations
    • xarray.DataArray.pr.gwp_context
    • xarray.DataArray.pr.loc
    • xarray.DataArray.pr.__getitem__
    • xarray.DataArray.pr.add_aggregates_coordinates
    • xarray.DataArray.pr.any
    • xarray.DataArray.pr.combine_first
    • xarray.DataArray.pr.convert
    • xarray.DataArray.pr.convert_to_gwp
    • xarray.DataArray.pr.convert_to_gwp_like
    • xarray.DataArray.pr.convert_to_mass
    • xarray.DataArray.pr.count
    • xarray.DataArray.pr.coverage
    • xarray.DataArray.pr.dequantify
    • xarray.DataArray.pr.downscale_timeseries
    • xarray.DataArray.pr.fill_all_na
    • xarray.DataArray.pr.fillna
    • xarray.DataArray.pr.merge
    • xarray.DataArray.pr.quantify
    • xarray.DataArray.pr.set
    • xarray.DataArray.pr.sum
    • xarray.DataArray.pr.to_df
    • xarray.Dataset.pr.comment
    • xarray.Dataset.pr.contact
    • xarray.Dataset.pr.dim_alias_translations
    • xarray.Dataset.pr.entity_terminology
    • xarray.Dataset.pr.institution
    • xarray.Dataset.pr.loc
    • xarray.Dataset.pr.publication_date
    • xarray.Dataset.pr.references
    • xarray.Dataset.pr.rights
    • xarray.Dataset.pr.title
    • xarray.Dataset.pr.__getitem__
    • xarray.Dataset.pr.add_aggregates_coordinates
    • xarray.Dataset.pr.add_aggregates_variables
    • xarray.Dataset.pr.any
    • xarray.Dataset.pr.combine_first
    • xarray.Dataset.pr.count
    • xarray.Dataset.pr.coverage
    • xarray.Dataset.pr.dequantify
    • xarray.Dataset.pr.downscale_gas_timeseries
    • xarray.Dataset.pr.downscale_timeseries
    • xarray.Dataset.pr.ensure_valid
    • xarray.Dataset.pr.expand_dims
    • xarray.Dataset.pr.fill_all_na
    • xarray.Dataset.pr.fill_na_gas_basket_from_contents
    • xarray.Dataset.pr.fillna
    • xarray.Dataset.pr.gas_basket_contents_sum
    • xarray.Dataset.pr.has_processing_info
    • xarray.Dataset.pr.merge
    • xarray.Dataset.pr.quantify
    • xarray.Dataset.pr.remove_processing_info
    • xarray.Dataset.pr.set
    • xarray.Dataset.pr.sum
    • xarray.Dataset.pr.to_df
    • xarray.Dataset.pr.to_interchange_format
    • xarray.Dataset.pr.to_netcdf
  • Sparse data ideas
  • Repository
  • Suggest edit
  • Open issue
  • .md

Data Format

Data Format#

In this section, we will dive deeper into the specifics of the primap2 data format, and we will also show the interchange format, an additional format for ingesting and exporting data.

primap2 data formats

  • Data format
    • Minimal example
    • Opulent example
    • Processing information example
    • Limitations
  • Data format details
    • Dimensions
    • Additional Coordinates
    • Data Variables
    • Dataset Attributes
    • Timeseries-Level Processing Information
  • Interchange format
    • Logical format
    • Use
    • In-memory representation
    • On-disk representation
    • Examples
  • Interchange format details
    • Tabular data
    • Meta Data
    • On-disk format details

previous

The Composite Source Generator

next

Data format

By Mika Pflüger and Johannes Gütschow

© Copyright 2021-2023: Potsdam Institute for Climate Impact Research; 2023-2024: Climate Resource.