@opengeoweb/soundings 19.0.0 → 19.1.1

package/dist/README.md

@@ -0,0 +1,59 @@
+# Soundings
+
+This library was generated with [Nx](https://nx.dev).
+
+## Configuration for soundings EDR services
+
+The sources that are available in the soundings sources menu are specified in the initialPresets.json file.
+
+There, you can specify the required details for each source under the `soundingsCollections` property:
+
+```
+"soundingsCollections": [
+      {
+        "name": "Harmonie scandinavia hybrid",
+        "id": "harmonie_scandinavia_hybrid",
+        "url": "https://opendata.fmi.fi/edr",
+        "description": "MEPS/vertical coordinate model level",
+        "windSpeedUnit": "ms",
+        "parameterMappings": {
+          "temperature": "temperature",
+          "windDirection": "winddirection",
+          "windSpeed": "windspeedms",
+          "pressure": "pressure",
+          "dewpoint": "dewpoint"
+        }
+      },
+      {
+        "name": "Harmonie scandinavia pressure",
+        "id": "harmonie_scandinavia_pressure",
+        "url": "https://opendata.fmi.fi/edr",
+        "description": "MEPS/vertical coordinate pressure",
+        "windSpeedUnit": "ms",
+        "parameterMappings": {
+          "temperature": "temperature",
+          "windDirection": "winddirection",
+          "windSpeed": "windspeedms",
+          "pressure": "pressure",
+          "dewpoint": "dewpoint"
+        }
+      }
+]
+```
+
+Each source should have a `name`, `id`, `source url`, `description`, `windSpeedUnit` and include parameter mappings telling the soundings API which EDR parameters to assign to which physical property.
+
+The `windSpeedUnit` is required to ensure correct derivation of the windbarbs and hodograph. This should contain either 'ms' or 'kts' depending on the unit served by the EDR service
+
+The following mappings are needed:
+
+- pressure
+- temperature
+- dewpoint (OR specificHumidity OR relativeHumidity, from which we can derive dewpoint in case it is not available)
+- (windSpeed AND windDirection) OR (windU AND windV), either one of the two can be used
+
+If your EDR parameter is called windSpeedInMS the mapping would be as follows: `windSpeed: windSpeedInMS`
+
+## Running unit tests
+
+Run `nx test soundings` to execute the unit tests via [Jest](https://jestjs.io).

package/dist/index.d.ts

@@ -0,0 +1 @@
+export * from "./src/index";