Skip to content

Commit

Permalink
Merge pull request #252 from IEA-Task-43/dev
Browse files Browse the repository at this point in the history
Release version 1.3.0-2024.03
  • Loading branch information
stephenholleran authored Mar 14, 2024
2 parents e590563 + 1e091e7 commit 681f905
Show file tree
Hide file tree
Showing 12 changed files with 376 additions and 50 deletions.
29 changes: 29 additions & 0 deletions CHANGELOG.md
Original file line number Diff line number Diff line change
Expand Up @@ -9,6 +9,35 @@ Given a version number MAJOR.MINOR.PATCH, increment the:

Additional labels for pre-release and build metadata are available as extensions to the MAJOR.MINOR.PATCH format.

## [1.3.0-2024.03]

1. Adding a new table to capture details of modelled VMM and reanalysis datasets (Issue [#214](https://github.com/IEA-Task-43/digital_wra_data_standard/issues/214))
1. This is called `model_config` which is at the same level as `logger_main_config` and contains similar information.
1. Resulting duplicate properties `offset_from_utc_hrs`, `averaging_period_minutes` and `timestamp_is_end_of_period` were moved to Definitions.
1. `reanalysis` and `virtual_met_mast` enums were added to `measurement_station_type` as outlined below.
1. To `measurement_type` enum add:
1. `obukhov_length` (Issue [#182](https://github.com/IEA-Task-43/digital_wra_data_standard/issues/182))
1. To `statistic_type_id` enum add:
1. `ti30sec` (Issue [#218](https://github.com/IEA-Task-43/digital_wra_data_standard/issues/218))
1. To `measurement_units_id` enum add:
1. `cm/s` (Issue [#241](https://github.com/IEA-Task-43/digital_wra_data_standard/issues/241))
1. `mm/s` (Issue [#241](https://github.com/IEA-Task-43/digital_wra_data_standard/issues/241))
1. To `measurement_station_type` enum add:
1. `wave_buoy` (Issue [#226](https://github.com/IEA-Task-43/digital_wra_data_standard/issues/226))
1. `adcp` (Issue [#226](https://github.com/IEA-Task-43/digital_wra_data_standard/issues/226))
1. `virtual_met_mast` (Issue [#214](https://github.com/IEA-Task-43/digital_wra_data_standard/issues/214))
1. `reanalysis` (Issue [#214](https://github.com/IEA-Task-43/digital_wra_data_standard/issues/214))
1. To `sensor_type` enum add:
1. `altimeter` (Issue [#226](https://github.com/IEA-Task-43/digital_wra_data_standard/issues/226))
1. `PTH` (Issue [#247](https://github.com/IEA-Task-43/digital_wra_data_standard/issues/247))
1. To `measurement_location` add:
1. `uuid` (Issue [#232](https://github.com/IEA-Task-43/digital_wra_data_standard/issues/232))
1. At top level, add `license` (Issue [#225](https://github.com/IEA-Task-43/digital_wra_data_standard/issues/225))
1. Bug fixes:
1. Add `null` to `height_reference` enum to match its type (Issue [#215](https://github.com/IEA-Task-43/digital_wra_data_standard/issues/215))
1. In `plant_type` enum, remove double quotes around the `null` (Issue [#217](https://github.com/IEA-Task-43/digital_wra_data_standard/issues/217)).


## [1.2.0-2023.01]

The majority of the changes in this release are to expand the data model to include floating lidar sensors, measurement
Expand Down
3 changes: 2 additions & 1 deletion demo_data/E06_wraMetaData.json
Original file line number Diff line number Diff line change
Expand Up @@ -2,12 +2,13 @@
"author": "Daniel Nuno",
"organisation": "EOLOS Floating Lidar Solutions",
"date": "2023-08-25",
"version": "1.2.0-2023.01",
"version": "1.3.0-2024.03",
"plant_name": "NYS",
"plant_type": "offshore_wind",
"notes": "IEA Task 43 WRA Data Model. Campaign data available for download at https://oswbuoysny.resourcepanorama.dnv.com/",
"measurement_location": [
{
"uuid": "e31117bd-6f58-4970-8045-337dd3c291fb",
"name": "E06",
"latitude_ddeg": 39.545,
"longitude_ddeg": -73.4295,
Expand Down
13 changes: 7 additions & 6 deletions demo_data/floating_lidar_demo_iea43_wra_data_model.json
Original file line number Diff line number Diff line change
Expand Up @@ -2,10 +2,11 @@
"author": "Stephen Holleran",
"organisation": "brightwind",
"date": "2022-03-31",
"version": "1.2.0-2023.01",
"version": "1.3.0-2024.03",
"plant_name": "Irish Sea Wind Farm",
"plant_type": "offshore_wind",
"measurement_location": [{
"uuid": "c5c1efe8-6daf-48e5-89c6-8098ea5a26f3",
"name": "ISWF_FLS1",
"latitude_ddeg": 53.35,
"longitude_ddeg": -5.3,
Expand Down Expand Up @@ -498,30 +499,30 @@
"notes": "Vertical water speed at 5m.",
"update_at": "2022-03-31T12:13:27",
"logger_measurement_config": [{
"measurement_units_id": "m/s",
"measurement_units_id": "cm/s",
"height_m": 3.7,
"date_from": "2022-03-01T12:10:00",
"date_to": null,
"notes": null,
"update_at": "2022-03-31T12:13:27",
"column_name": [
{
"column_name": "Vertical Water Speed (m/s) at 3.7m",
"column_name": "Vertical Water Speed (cm/s) at 3.7m",
"statistic_type_id": "avg",
"is_ignored": false,
"update_at": "2022-03-31T12:13:27"
},{
"column_name": "Vertical Water Speed Std. Dev. (m/s) at 3.7m",
"column_name": "Vertical Water Speed Std. Dev. (cm/s) at 3.7m",
"statistic_type_id": "sd",
"is_ignored": false,
"update_at": "2022-03-31T12:13:27"
},{
"column_name": "Vertical Water Speed Min (m/s) at 3.7m",
"column_name": "Vertical Water Speed Min (cm/s) at 3.7m",
"statistic_type_id": "min",
"is_ignored": false,
"update_at": "2022-03-31T12:13:27"
},{
"column_name": "Vertical Water Speed Max (m/s) at 3.7m",
"column_name": "Vertical Water Speed Max (cm/s) at 3.7m",
"statistic_type_id": "max",
"is_ignored": false,
"update_at": "2022-03-31T12:13:27"
Expand Down
12 changes: 10 additions & 2 deletions demo_data/iea43_wra_data_model.json
Original file line number Diff line number Diff line change
Expand Up @@ -2,10 +2,12 @@
"author": "Stephen Holleran",
"organisation": "brightwind",
"date": "2021-12-23",
"version": "1.2.0-2023.01",
"version": "1.3.0-2024.03",
"license": "https://opensource.org/license/mit/",
"plant_name": "A Name of the Wind Farm",
"plant_type": "onshore_wind",
"measurement_location": [{
"uuid": "6858cf5c-24e0-40d4-955b-8aecbccba391",
"name": "Test_MM1",
"latitude_ddeg": 53.5,
"longitude_ddeg": -8,
Expand Down Expand Up @@ -109,6 +111,12 @@
"is_ignored": false,
"notes": "I can write anything I want here.",
"update_at": "2020-04-18T18:13:00"
},{
"column_name": "CH1Ti30sec",
"statistic_type_id": "ti30sec",
"is_ignored": false,
"notes": "I can write anything I want here.",
"update_at": "2020-04-18T18:13:00"
}]
},{
"slope": 0.04573,
Expand Down Expand Up @@ -1740,7 +1748,7 @@
"name": "Logger_V",
"measurement_type_id": "voltage",
"height_m": null,
"height_reference_id": "ground_level",
"height_reference_id": null,
"notes": "I can write anything I want here.",
"update_at": "2020-04-18T18:13:00",
"logger_measurement_config": [{
Expand Down
84 changes: 84 additions & 0 deletions demo_data/iea43_wra_data_model_reanalysis.json
Original file line number Diff line number Diff line change
@@ -0,0 +1,84 @@
{
"author": "Stephen Holleran",
"organisation": "BrightWind",
"date": "2023-11-24",
"version": "1.3.0-2024.03",
"measurement_location": [{
"uuid": "282c5c44-17a2-426a-b10d-0826d0d868fc",
"name": "ERA5_53.536N_-6.3E",
"latitude_ddeg": 53.536,
"longitude_ddeg": -6.3,
"measurement_station_type_id": "reanalysis",
"notes": "This is an ERA5 reanalysis dataset produced by ECMWF.",
"update_at": "2023-11-24T18:13:00",
"model_config": [{
"reanalysis": "ERA5",
"horizontal_grid_resolution_m": 11000,
"model_used": "ECMWF IFS",
"offset_from_utc_hrs": 0,
"averaging_period_minutes": 60,
"timestamp_is_end_of_period": false,
"date_from": "2000-01-01T00:00:00",
"date_to": null,
"notes": "This is an ERA5 reanalysis dataset produced by ECMWF.",
"update_at": "2023-11-24T18:13:00"
}],
"measurement_point": [{
"name": "WS100m",
"measurement_type_id": "wind_speed",
"height_m": 100,
"height_reference_id": "ground_level",
"logger_measurement_config": [{
"measurement_units_id": "m/s",
"date_from": "2000-01-01T00:00:00",
"date_to": null,
"column_name": [{
"column_name": "Spd_100m_mps",
"statistic_type_id": "avg"
}]
}]
},{
"name": "WD100m",
"measurement_type_id": "wind_direction",
"height_m": 100,
"logger_measurement_config": [{
"measurement_units_id": "deg",
"date_from": "2000-01-01T00:00:00",
"date_to": null,
"column_name": [
{
"column_name": "Dir_100m_deg",
"statistic_type_id": "avg"
}]
}]
},{
"name": "Tmp2m",
"measurement_type_id": "air_temperature",
"height_m": 2,
"logger_measurement_config": [{
"measurement_units_id": "deg_C",
"date_from": "2000-01-01T00:00:00",
"date_to": null,
"column_name": [
{
"column_name": "Tmp_2m_degC",
"statistic_type_id": "avg"
}]
}]
},{
"name": "Prs0m",
"measurement_type_id": "air_pressure",
"height_m": 0,
"logger_measurement_config": [{
"measurement_units_id": "hPa",
"date_from": "2000-01-01T00:00:00",
"date_to": null,
"column_name": [
{
"column_name": "Prs_0m_hPa",
"statistic_type_id": "avg"
}]
}]
}]
}]
}
Original file line number Diff line number Diff line change
Expand Up @@ -151,6 +151,7 @@ The measurement sensor type e.g. anemometer.
| `"solar_compass"` | |
| `"inertial_measurement_unit"` | |
| `"adcp"` | |
| `"altimeter"` | |
| `"ctd"` | |
| `"lidar"` | |
| `"sodar"` | |
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -12,4 +12,6 @@
| `"lidar"` | |
| `"sodar"` | |
| `"floating_lidar"` | |
| `"wave_buoy"` | |
| `"adcp"` | |
| `"solar"` | |
Original file line number Diff line number Diff line change
Expand Up @@ -103,7 +103,7 @@ Longitude coordinate in the Geographic Coordinate System using the WGS84 referen

## measurement\_station\_type\_id

The type of measurement station. This must be one of either met mast, lidar (a vertical profiler), sodar (also a vertical profiler) or floating lidar (floating vertical profiler lidar).
The type of measurement station. This must be one of either met mast, lidar (a vertical profiler), sodar (also a vertical profiler), floating lidar (floating vertical profiler lidar), wave buoy or ADCP.

`measurement_station_type_id`

Expand All @@ -129,6 +129,8 @@ The type of measurement station. This must be one of either met mast, lidar (a v
| `"lidar"` | |
| `"sodar"` | |
| `"floating_lidar"` | |
| `"wave_buoy"` | |
| `"adcp"` | |
| `"solar"` | |

## notes
Expand Down
26 changes: 26 additions & 0 deletions release_procedure.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,26 @@
# Release Procedure

**This is a procedure for how to create a release of the WRA Data Model.**

The release is from the master branch. Ideally all merges over the course of maintenance or development were merged into
the `dev` branch. Therefore, the `dev` branch will be cleaned up first.

1. In the `dev` branch update the version number in:
1. the actual JSON Schema file itself,
2. all the relevant demo implementation files in the demo_data folder,
3. the CHANGELOG file and
4. the description of the SQL create table file.
2. Do a pull request to merge the `dev` branch into `master`.
3. The documentation is automatically generated when there is a merge into `master`. Make sure that this has completed successfully.
4. Go to 'Releases' on GitHub and 'Draft a new release'.
5. For the 'Choose a tag' create a new tag by typing in the name e.g. "v1.2.0-2023.01". Ensure you copy the format exactly
including the "v" as this will be included in the URL to find the assets that may be hardcoded in software.
1. The target for the tag should be the `master` branch. However, a recent commit can be selected. Selecting a recent
commit would be more informative as the last commit is usually the 'Compile Documentation' commit which is not
informative. In this instance the commit for "update version number to 1.2.0-2023.01" is selected.
6. For the 'Release title' type in the same as the name for the tag but without the "v". E.g. "1.2.0-2023.01". The real
reason for this only to be consistent with previous releases.
7. In the 'Describe this release' box, copy and paste the contents from the CHANGELOG file that are relevant to this release.
8. Attach the JSON Schema file as an asset so this can be retrieved via code. Ensure that you are copying the most
up-to-date schema file which has the correct version number.
9. Publish release.
Loading

0 comments on commit 681f905

Please sign in to comment.