From 90a657449631805dd7674e5a9818ea295a5be5f7 Mon Sep 17 00:00:00 2001 From: awarde96 Date: Thu, 15 Aug 2024 07:24:37 +0000 Subject: [PATCH] Update readme with info about the config --- README.md | 11 +++++++++++ 1 file changed, 11 insertions(+) diff --git a/README.md b/README.md index bc612e8..e4b6e4c 100644 --- a/README.md +++ b/README.md @@ -80,6 +80,17 @@ 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. + ## Testing Python unit tests can be run with pytest: