This release is a pre-release and may not be stable for production use.
Recommendations for Safe Lossy Compression of weather and climate data
What lossy compression is safe when using lossy compression on weather and climate data?
This repository contains community-provided recommendations that are automatically compiled into one machine-readable recommendations.yaml file.
These recommendations can then be used by external tools to automatically recommend appropriate safety requirements for compressing various weather and climate data.
This repository also provides the compression-recommendations Python package for loading these recommendations and inspecting them in the strongly typed Recommendations data structure.
Furthermore, we provide the following integrations:
compression-requirement-checkschecks whether safety requirements are upheld by a lossy-decompressed reconstruction of the original data.compression-requirement-safeguardstranslates safety requirements into compression safeguards that can be wrapped around any compressor to guarantee that the requirements are fulfilled.
Contributing: What should be recommended?
That is up to you, the community, to decide!
- You can add comments to any recommendation to elaborate or discuss different requirements.
- You can propose edits to any recommendation, which we accept once a new consensus has been reached.
- You can create new recommendations for new variables or to specialise existing requirements for specific cases.
- You can merge multiple recommendations to generalise them.
- You can propose new filters to select which recommendations should apply, or new kinds of requirements.
Glossary
Compression : Reducing the number of bits needed to store some data.
Lossy Compression : Compression that may only produce an approximation of the original data during decompression.
Filter : Criteria, or a composition of multiple criteria, that select which requirements should apply.
Safety Requirement : A property, e.g. an error bound, or a composition of multiple properties, that the lossy-compressed data must fulfil with respect to the original uncompressed data.
Citation
Please refer to the CITATION.cff file and refer to https://citation-file-format.github.io to extract the citation in a format of your choice.
License
Licensed under the Mozilla Public License, Version 2.0 (LICENSE or https://www.mozilla.org/en-US/MPL/2.0/).
Funding
The outline for the recommendations have been developed as part of ESiWACE3, the third phase of the Centre of Excellence in Simulation of Weather and Climate in Europe.
Funded by the European Union. This work has received funding from the European High Performance Computing Joint Undertaking (JU) under grant agreement No 101093054.
1 maintainer
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
Built Distribution
Filter files by name, interpreter, ABI, and platform.
If you're not sure about the file name format, learn more about wheel file names.
Copy a direct link to the current filters
File details
Details for the file compression_recommendations-0.1.0a1.tar.gz.
File metadata
- Download URL: compression_recommendations-0.1.0a1.tar.gz
- Upload date:
- Size: 26.6 kB
- Tags: Source
- Uploaded using Trusted Publishing? Yes
- Uploaded via:
twine/7.0.0 CPython/3.13.14
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
8d19b220f0e5abf9a65cae978116d2d96560a437998e15a9b0beac06ffbe6b23
|
|
| MD5 |
31bc4b0e00f4f4fdb44ac2ca79e94332
|
|
| BLAKE2b-256 |
d8db84d535cceb1a2f8484abffb140e04ab506fd5644e38a6f73c4e1c8aeae3d
|
Provenance
The following attestation bundles were made for compression_recommendations-0.1.0a1.tar.gz:
Publisher:
ci.yml on juntyr/compression-recommendations
-
Statement:
-
Statement type:
https://in-toto.io/Statement/v1 -
Predicate type:
https://docs.pypi.org/attestations/publish/v1 -
Subject name:
compression_recommendations-0.1.0a1.tar.gz -
Subject digest:
8d19b220f0e5abf9a65cae978116d2d96560a437998e15a9b0beac06ffbe6b23 - Sigstore transparency entry: 2839181254
- Sigstore integration time:
-
Permalink:
juntyr/compression-recommendations@b6488392998ba194157af5360a1554d5c2b1f5f3 -
Branch / Tag:
refs/tags/0.1.0a1.post1 - Owner: https://github.com/juntyr
-
Access:
public
-
Token Issuer:
https://token.actions.githubusercontent.com -
Runner Environment:
github-hosted -
Publication workflow:
ci.yml@b6488392998ba194157af5360a1554d5c2b1f5f3 -
Trigger Event:
release
-
Statement type:
File details
Details for the file compression_recommendations-0.1.0a1-py3-none-any.whl.
File metadata
- Download URL: compression_recommendations-0.1.0a1-py3-none-any.whl
- Upload date:
- Size: 42.3 kB
- Tags: Python 3
- Uploaded using Trusted Publishing? Yes
- Uploaded via:
twine/7.0.0 CPython/3.13.14
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
554f0207b657bc1e12ce38f8cc399671f22f4cc6641c7b4c87f2b335766de47d
|
|
| MD5 |
19d8739d8b2d3d8d309f20645f03d09c
|
|
| BLAKE2b-256 |
78b2367255b4c6370f1e7995f59f525f14a2fe884e9ecad8c792c2a5fb5fa964
|
Provenance
The following attestation bundles were made for compression_recommendations-0.1.0a1-py3-none-any.whl:
Publisher:
ci.yml on juntyr/compression-recommendations
-
Statement:
-
Statement type:
https://in-toto.io/Statement/v1 -
Predicate type:
https://docs.pypi.org/attestations/publish/v1 -
Subject name:
compression_recommendations-0.1.0a1-py3-none-any.whl -
Subject digest:
554f0207b657bc1e12ce38f8cc399671f22f4cc6641c7b4c87f2b335766de47d - Sigstore transparency entry: 2839164788
- Sigstore integration time:
-
Permalink:
juntyr/compression-recommendations@b6488392998ba194157af5360a1554d5c2b1f5f3 -
Branch / Tag:
refs/tags/0.1.0a1.post1 - Owner: https://github.com/juntyr
-
Access:
public
-
Token Issuer:
https://token.actions.githubusercontent.com -
Runner Environment:
github-hosted -
Publication workflow:
ci.yml@b6488392998ba194157af5360a1554d5c2b1f5f3 -
Trigger Event:
release
-
Statement type:
