primap2 0.3.1

The next generation of the PRIMAP climate policy analysis suite.

PRIMAP2

PRIMAP2 is the next generation of the PRIMAP climate policy analysis suite. PRIMAP2 is free software, you are welcome to use it in your own research. The documentation can be found at https://primap2.readthedocs.io.

Structure

PRIMAP2 is:

• A flexible and powerful data format built on xarray.

• A collection of functions for common tasks when wrangling climate policy data, like aggregation and interpolation.

• A format for data packages built on datalad, providing metadata extraction and search on a collection of data packages.

Status

PRIMAP2 is in active development, and not everything promised above is built yet.

License

Copyright 2020-2021, Potsdam-Institut für Klimafolgenforschung e.V.

Licensed under the Apache License, Version 2.0 (the “License”); you may not use this file except in compliance with the License. You may obtain a copy of the License at

https://www.apache.org/licenses/LICENSE-2.0

Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an “AS IS” BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License.

PRIMAP2 incorporates parts of xarray and pint_xarray, which are available under the Apache License, Version 2.0 as well. The full text of the xarray copyright statement is included in the licenses directory.

Citation

If you use this library and want to cite it, please cite it as:

Mika Pflüger. (2021, February 11). pik-primap/primap2: Version 0.3.1. Zenodo. http://doi.org/10.5281/zenodo.4535903

Changelog

0.3.1

• Re-release 0.3.0 to trigger zenodo.

0.3.0

• Add functions for downscaling and aggregation of gas baskets and categorical baskets.

• Add functions, docs, and tests for basic GWP handling.

• Add Makefile target to generate patched stub files for xarray containing the primap2 API.

• Add development documentation detailing the structure of the repository and the tools used to development of PRIMAP2.

• Add selection and indexing which understands dimension names like area in addition to the full dimension key including the category set like area (ISO3). Works with ds.pr[key] and ds.pr.loc[selection] as well as da.pr.loc[selection].

• Add usage documentation for all currently included functionality.

• Access metadata easily via properties like ds.pr.references.

0.2.0

• Add documentation.

• Add tests.

• Add continuous integration using github actions.

• Add functions for storing to and loading from netcdf.

• Add description of the data format.

• Add function which ensures that a dataset is in this data format.

• Provide all functions using a pint extension accessor.

0.1.0

• First development release.