Compile documentation

IEA-Task-43 · Jan 12, 2022 · a40ea1f · a40ea1f
1 parent 4600fe1
commit a40ea1f
Show file tree

Hide file tree

Showing 41 changed files with 777 additions and 289 deletions.
diff --git a/docs/README.md b/docs/README.md
@@ -12,14 +12,16 @@
 
 *   [Calibration Uncertainty](./iea43\_wra_data_model-properties-measurement-location-measurement-location-properties-measurement-point-measurement-point-properties-sensor-sensor-properties-calibration-calibration-properties-calibration-uncertainty-calibration-uncertainty.md) – `https://raw.githubusercontent.com/IEA-Task-43/digital_wra_data_standard/master/schema/iea43_wra_data_model.schema.json#/properties/measurement_location/items/properties/measurement_point/items/properties/sensor/items/properties/calibration/items/properties/calibration_uncertainty/items`
 
-*   [Column Names](./iea43\_wra_data_model-properties-measurement-location-measurement-location-properties-measurement-point-measurement-point-properties-sensor-configuration-sensor-configuration-properties-column-names-column-names.md) – `https://raw.githubusercontent.com/IEA-Task-43/digital_wra_data_standard/master/schema/iea43_wra_data_model.schema.json#/properties/measurement_location/items/properties/measurement_point/items/properties/sensor_config/items/properties/column_name/items`
+*   [Column Names](./iea43\_wra_data_model-properties-measurement-location-measurement-location-properties-measurement-point-measurement-point-properties-logger-measurement-configuration-logger-measurement-configuration-properties-column-names-column-names.md) – `https://raw.githubusercontent.com/IEA-Task-43/digital_wra_data_standard/master/schema/iea43_wra_data_model.schema.json#/properties/measurement_location/items/properties/measurement_point/items/properties/logger_measurement_config/items/properties/column_name/items`
 
 *   [Interference Structures](./iea43\_wra_data_model-properties-measurement-location-measurement-location-properties-measurement-point-measurement-point-properties-interference-structures-interference-structures.md) – `https://raw.githubusercontent.com/IEA-Task-43/digital_wra_data_standard/master/schema/iea43_wra_data_model.schema.json#/properties/measurement_location/items/properties/measurement_point/items/properties/interference_structures/items`
 
 *   [Lidar Specific Configuration](./iea43\_wra_data_model-properties-measurement-location-measurement-location-properties-logger-configuration-logger-configuration-properties-lidar-specific-configuration-lidar-specific-configuration.md) – `https://raw.githubusercontent.com/IEA-Task-43/digital_wra_data_standard/master/schema/iea43_wra_data_model.schema.json#/properties/measurement_location/items/properties/logger_main_config/items/properties/lidar_config/items`
 
 *   [Logger Configuration](./iea43\_wra_data_model-properties-measurement-location-measurement-location-properties-logger-configuration-logger-configuration.md) – `https://raw.githubusercontent.com/IEA-Task-43/digital_wra_data_standard/master/schema/iea43_wra_data_model.schema.json#/properties/measurement_location/items/properties/logger_main_config/items`
 
+*   [Logger Measurement Configuration](./iea43\_wra_data_model-properties-measurement-location-measurement-location-properties-measurement-point-measurement-point-properties-logger-measurement-configuration-logger-measurement-configuration.md) – `https://raw.githubusercontent.com/IEA-Task-43/digital_wra_data_standard/master/schema/iea43_wra_data_model.schema.json#/properties/measurement_location/items/properties/measurement_point/items/properties/logger_measurement_config/items`
+
 *   [Mast Section Geometry](./iea43\_wra_data_model-properties-measurement-location-measurement-location-properties-mast-properties-properties-mast-section-geometry-mast-section-geometry.md) – `https://raw.githubusercontent.com/IEA-Task-43/digital_wra_data_standard/master/schema/iea43_wra_data_model.schema.json#/properties/measurement_location/items/properties/mast_properties/properties/mast_section_geometry/items`
 
 *   [Measurement Location](./iea43\_wra_data_model-properties-measurement-location-measurement-location.md) – `https://raw.githubusercontent.com/IEA-Task-43/digital_wra_data_standard/master/schema/iea43_wra_data_model.schema.json#/properties/measurement_location/items`
@@ -30,24 +32,22 @@
 
 *   [Sensor](./iea43\_wra_data_model-properties-measurement-location-measurement-location-properties-measurement-point-measurement-point-properties-sensor-sensor.md) – `https://raw.githubusercontent.com/IEA-Task-43/digital_wra_data_standard/master/schema/iea43_wra_data_model.schema.json#/properties/measurement_location/items/properties/measurement_point/items/properties/sensor/items`
 
-*   [Sensor Configuration](./iea43\_wra_data_model-properties-measurement-location-measurement-location-properties-measurement-point-measurement-point-properties-sensor-configuration-sensor-configuration.md) – `https://raw.githubusercontent.com/IEA-Task-43/digital_wra_data_standard/master/schema/iea43_wra_data_model.schema.json#/properties/measurement_location/items/properties/measurement_point/items/properties/sensor_config/items`
-
 *   [Vertical Profiler Properties](./iea43\_wra_data_model-properties-measurement-location-measurement-location-properties-vertical-profiler-properties-vertical-profiler-properties.md) – `https://raw.githubusercontent.com/IEA-Task-43/digital_wra_data_standard/master/schema/iea43_wra_data_model.schema.json#/properties/measurement_location/items/properties/vertical_profiler_properties/items`
 
 ### Arrays
 
-*   [Column Names](./iea43\_wra_data_model-properties-measurement-location-measurement-location-properties-measurement-point-measurement-point-properties-sensor-configuration-sensor-configuration-properties-column-names.md "The group of column names in the data file which relates to this sensor configuration") – `https://raw.githubusercontent.com/IEA-Task-43/digital_wra_data_standard/master/schema/iea43_wra_data_model.schema.json#/properties/measurement_location/items/properties/measurement_point/items/properties/sensor_config/items/properties/column_name`
+*   [Column Names](./iea43\_wra_data_model-properties-measurement-location-measurement-location-properties-measurement-point-measurement-point-properties-logger-measurement-configuration-logger-measurement-configuration-properties-column-names.md "The group of column names in the data file which relates to this sensor configuration") – `https://raw.githubusercontent.com/IEA-Task-43/digital_wra_data_standard/master/schema/iea43_wra_data_model.schema.json#/properties/measurement_location/items/properties/measurement_point/items/properties/logger_measurement_config/items/properties/column_name`
 
 *   [Logger Configuration](./iea43\_wra_data_model-properties-measurement-location-measurement-location-properties-logger-configuration.md "This represents how the logger's main settings are configured") – `https://raw.githubusercontent.com/IEA-Task-43/digital_wra_data_standard/master/schema/iea43_wra_data_model.schema.json#/properties/measurement_location/items/properties/logger_main_config`
 
+*   [Logger Measurement Configuration](./iea43\_wra_data_model-properties-measurement-location-measurement-location-properties-measurement-point-measurement-point-properties-logger-measurement-configuration.md "The measurement configuration that is programmed into the logging device") – `https://raw.githubusercontent.com/IEA-Task-43/digital_wra_data_standard/master/schema/iea43_wra_data_model.schema.json#/properties/measurement_location/items/properties/measurement_point/items/properties/logger_measurement_config`
+
 *   [Measurement Location](./iea43\_wra_data_model-properties-measurement-location.md "This is the geographic location of the meteorological measurement station i") – `https://raw.githubusercontent.com/IEA-Task-43/digital_wra_data_standard/master/schema/iea43_wra_data_model.schema.json#/properties/measurement_location`
 
 *   [Measurement Point](./iea43\_wra_data_model-properties-measurement-location-measurement-location-properties-measurement-point.md "This represents a point in space where a measurement takes place") – `https://raw.githubusercontent.com/IEA-Task-43/digital_wra_data_standard/master/schema/iea43_wra_data_model.schema.json#/properties/measurement_location/items/properties/measurement_point`
 
 *   [Sensor](./iea43\_wra_data_model-properties-measurement-location-measurement-location-properties-measurement-point-measurement-point-properties-sensor.md "This represents information about the sensor taking the measurements") – `https://raw.githubusercontent.com/IEA-Task-43/digital_wra_data_standard/master/schema/iea43_wra_data_model.schema.json#/properties/measurement_location/items/properties/measurement_point/items/properties/sensor`
 
-*   [Sensor Configuration](./iea43\_wra_data_model-properties-measurement-location-measurement-location-properties-measurement-point-measurement-point-properties-sensor-configuration.md "The sensor configuration that is programmed into the logging device") – `https://raw.githubusercontent.com/IEA-Task-43/digital_wra_data_standard/master/schema/iea43_wra_data_model.schema.json#/properties/measurement_location/items/properties/measurement_point/items/properties/sensor_config`
-
 ## Version Note
 
 The schemas linked above follow the JSON Schema Spec version: `http://json-schema.org/draft-07/schema#`
diff --git a/...ment-point-properties-height-reference.md → ...ata_model-definitions-height-reference.md b/...ment-point-properties-height-reference.md → ...ata_model-definitions-height-reference.md
@@ -1,6 +1,6 @@
 ## height_reference_id Type
 
-`string` ([Height Reference](iea43\_wra_data_model-properties-measurement-location-measurement-location-properties-measurement-point-measurement-point-properties-height-reference.md))
+unknown ([Height Reference](iea43\_wra_data_model-definitions-height-reference.md))
 
 ## height_reference_id Constraints
 

diff --git a/...ment-point-properties-measurement-type.md → ...ata_model-definitions-measurement-type.md b/...ment-point-properties-measurement-type.md → ...ata_model-definitions-measurement-type.md
@@ -1,6 +1,6 @@
 ## measurement_type_id Type
 
-`string` ([Measurement Type](iea43\_wra_data_model-properties-measurement-location-measurement-location-properties-measurement-point-measurement-point-properties-measurement-type.md))
+`string` ([Measurement Type](iea43\_wra_data_model-definitions-measurement-type.md))
 
 ## measurement_type_id Constraints
 
@@ -35,6 +35,7 @@
 | `"fog"`                           |             |
 | `"gps_coordinates"`               |             |
 | `"status"`                        |             |
+| `"flag"`                          |             |
 | `"counter"`                       |             |
 | `"availability"`                  |             |
 | `"quality"`                       |             |
@@ -43,9 +44,13 @@
 | `"orientation"`                   |             |
 | `"compass_direction"`             |             |
 | `"true_north_offset"`             |             |
+| `"tilt"`                          |             |
 | `"tilt_x"`                        |             |
 | `"tilt_y"`                        |             |
 | `"tilt_z"`                        |             |
+| `"u"`                             |             |
+| `"v"`                             |             |
+| `"w"`                             |             |
 | `"elevation"`                     |             |
 | `"altitude"`                      |             |
 | `"azimuth"`                       |             |
@@ -206,6 +211,18 @@
 "tilt_z (the tilt of an object relative to the z-axis)"
 ```
 
+```json
+"u (the U component vector, relating to wind it is positive for a west to east flow (eastward wind), however, it can be used for other vectors. If so, please use the notes property to define it.)"
+```
+
+```json
+"v (the V component vector, relating to wind it is positive for a south to north flow (northward wind), however, it can be used for other vectors. If so, please use the notes property to define it.)"
+```
+
+```json
+"w (the W component vector, if using this for wind please use the 'vertical_wind_speed' measurement type. Please use the notes property to define how this component is utilised."
+```
+
 ```json
 "elevation (the height the surface of the earth is above mean sea level)"
 ```

diff --git a/...rties-properties-orientation-reference.md → ...odel-definitions-orientation-reference.md b/...rties-properties-orientation-reference.md → ...odel-definitions-orientation-reference.md
@@ -1,6 +1,6 @@
 ## orientation_reference_id Type
 
-`string` ([Orientation Reference](iea43\_wra_data_model-properties-measurement-location-measurement-location-properties-vertical-profiler-properties-vertical-profiler-properties-properties-orientation-reference.md))
+`string` ([Orientation Reference](iea43\_wra_data_model-definitions-orientation-reference.md))
 
 ## orientation_reference_id Constraints
 

diff --git a/...onfiguration-logger-configuration-properties-logger-acquisition-uncertainty-.md b/...onfiguration-logger-configuration-properties-logger-acquisition-uncertainty-.md
@@ -0,0 +1,9 @@
+## logger_acquisition_uncertainty Type
+
+`number` ([Logger Acquisition Uncertainty \[%\]](iea43\_wra_data_model-properties-measurement-location-measurement-location-properties-logger-configuration-logger-configuration-properties-logger-acquisition-uncertainty-.md))
+
+## logger_acquisition_uncertainty Examples
+
+```json
+"0.1"
+```
diff --git a/...logger-configuration-logger-configuration-properties-logger-firmware-version.md b/...logger-configuration-logger-configuration-properties-logger-firmware-version.md
@@ -0,0 +1,3 @@
+## logger_firmware_version Type
+
+`string` ([Logger Firmware Version](iea43\_wra_data_model-properties-measurement-location-measurement-location-properties-logger-configuration-logger-configuration-properties-logger-firmware-version.md))
Original file line number	Diff line number	Diff line change
		@@ -0,0 +1,3 @@
		## logger_firmware_version Type

		`string` ([Logger Firmware Version](iea43\_wra_data_model-properties-measurement-location-measurement-location-properties-logger-configuration-logger-configuration-properties-logger-firmware-version.md))