https://github.com/ecmwf/covjsonkit
A library for encoding and decoding coverageJSON files/objects of meteorlogical features such as vertical profiles and time series.
https://github.com/ecmwf/covjsonkit
coveragejson ogc polytope
Last synced: 4 months ago
JSON representation
A library for encoding and decoding coverageJSON files/objects of meteorlogical features such as vertical profiles and time series.
- Host: GitHub
- URL: https://github.com/ecmwf/covjsonkit
- Owner: ecmwf
- License: apache-2.0
- Created: 2023-11-23T11:29:33.000Z (over 2 years ago)
- Default Branch: main
- Last Pushed: 2025-11-19T10:38:25.000Z (7 months ago)
- Last Synced: 2025-11-27T17:54:15.187Z (7 months ago)
- Topics: coveragejson, ogc, polytope
- Language: Python
- Homepage:
- Size: 1.54 MB
- Stars: 5
- Watchers: 11
- Forks: 2
- Open Issues: 3
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# covjsonkit
Concept •
Installation •
Example •
Testing
## Concept
Covjsonkit is an ECMWF library for encoding and decoding coverageJSON files/objects of meteorlogical features such as vertical profiles and time series.
* Encodes and decodes CoverageJSON objects
* Convert CoverageJSON files to and from xarray
* Works in conjunction with ECMWFs Polytope feature extraction library
Current features implemented:
* Time Series
* Vertical Profile
* Bounding Box
* Frame
* Path
* Wkt Polygons
* Shapefiles
> \[!IMPORTANT\]
> This software is **Incubating** and subject to ECMWF's guidelines on [Software Maturity](https://github.com/ecmwf/codex/raw/refs/heads/main/Project%20Maturity).
## Installation
Install the covjsonkit with Python 3 (>=3.7) from GitHub directly with the command
python3 -m pip install git+ssh://git@github.com/ecmwf/covjsonkit.git@develop
or from PyPI with the command
python3 -m pip install covjsonkit
## Example
The library consists of an encoder and a decoder element. The decoder can be used to decode valid coverageJSON files that can be then be edited and accessed via the api. It can also be used to convert to ther formats such as xarray.
### Decoder
```Python
from covjsonkit.api import Covjsonkit
decoder = Covjsonkit().decode(coverage.covjson)
print(decoder.type)
print(decoder.parameters)
print(decoder.get_referencing())
ds = decoder.to_xarray()
```
### Encoder
The following example encodes data output from the polytope feature extraction library assuming polytope_output is a valid output from polytope.
```Python
from covjsonkit.api import Covjsonkit
encoder = Covjsonkit().encode("CoverageCollection", "BoundingBox")
res = encoder.from_polytope(polytope_output)
```
### Config
Covjsonkit uses a config to determine what parameter metadata to use, an example can be found in [example_config.json](example_config.json). This will automatically be loaded at runtime to point to the correct parameter metadata files.
The example config has to be stored in one of the following places:
1. System-wide configuration in /etc/covjsonkit/config.json (and yaml)
2. User configuration in ~/.covjsonkit.json (and yaml)
Users can add their own parameter metadata in the [data directory](covjsonkit/data/) by add ing a new directory containing a param.json, param_id.json, and units.json in a format the same as can be found in [ecmwf directory](covjsonkit/data/ecmwf/). Then edit the config to point to your newly named directory.
If users want to pass in their own config tehy can do this as a python dictioanry in the following way:
```Python
encoder = Covjsonkit(cf).encode("CoverageCollection", "BoundingBox")
```
Where `cf` is a valid covjsonkit config.
## Testing
Python unit tests can be run with pytest:
python -m pytest
When a pull request is merged into develop or main a github actions CI pipeline is triggered to test formatting and unit tests.
## Acknowledgements
Past and current funding and support is listed in the adjoining [Acknowledgements](./ACKNOWLEDGEMENTS.rst).