diff --git a/CHANGELOG.md b/CHANGELOG.md index 68e01ad5e00a34180f72850a2064439065bbc997..bf0c2b6b3ab672522630b28a1865e020b64ac86b 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -1,6 +1,26 @@ # Changelog All notable changes to this project will be documented in this file. +## v1.1.0 - 2020-11-18 - hourly resolution support and new data handlers + +### general: +* MLAir can be used with 1H resolution data from JOIN +* new data handlers to use the Kolmogorov-Zurbenko filter and mixed sampling types + +### new features: +* new data handler `DataHandlerKzFilter` to use Kolmogorov-Zurbenko filter (kz filter) on inputs (#195) +* new data handler `DataHandlerMixedSampling` that can used mixed sampling types for input and target (#197) +* new data handler `DataHandlerMixedSamplingWithFilter` that uses kz filter and mixed sampling (#197) +* new data handler `DataHandlerSeparationOfScales` to filter-depended time steps sizes on filtered inputs using mixed sampling (#196) + +### technical: +* bug fix for very short time series in TimeSeriesPlot (#215) +* bug fix for variable dictionary when using hourly resolution (#212) +* variable naming for data from JOIN interface harmonised (#206) +* transformation setup is now separated for inputs and targets (#202) +* bug fix in PlotClimatologicalSkillScore if only single station is used (#193) +* preprocessed data is now stored inside experiment and not in the data folder + ## v1.0.0 - 2020-10-08 - official release of new version 1.0.0 ### general: diff --git a/mlair/__init__.py b/mlair/__init__.py index 7097b1f3965e79f349ee1e48e669cc4b8a2cc0ad..41b258eb7a0ef445718cb7c45cc01bbc3092cadc 100644 --- a/mlair/__init__.py +++ b/mlair/__init__.py @@ -1,6 +1,6 @@ __version_info__ = { 'major': 1, - 'minor': 0, + 'minor': 1, 'micro': 0, } diff --git a/mlair/data_handler/data_handler_mixed_sampling.py b/mlair/data_handler/data_handler_mixed_sampling.py index aa1f0d55b55757875b640de00f66e62dd3586b11..80890b6f45dcde80aa75e9203a4a44ba25c7db01 100644 --- a/mlair/data_handler/data_handler_mixed_sampling.py +++ b/mlair/data_handler/data_handler_mixed_sampling.py @@ -126,7 +126,7 @@ class DataHandlerMixedSamplingWithFilter(DefaultDataHandler): _requirements = data_handler.requirements() -class DataHandlerMixedSamplingSeparationOfScalesSingleStation(DataHandlerMixedSamplingWithFilterSingleStation): +class DataHandlerSeparationOfScalesSingleStation(DataHandlerMixedSamplingWithFilterSingleStation): """ Data handler using mixed sampling for input and target. Inputs are temporal filtered and depending on the separation frequency of a filtered time series the time step delta for input data is adjusted (see image below). @@ -194,10 +194,10 @@ class DataHandlerMixedSamplingSeparationOfScalesSingleStation(DataHandlerMixedSa return int(max([self.time_delta(est) * self.window_history_size, est])) -class DataHandlerMixedSamplingSeparationOfScales(DefaultDataHandler): +class DataHandlerSeparationOfScales(DefaultDataHandler): """Data handler using mixed sampling for input and target. Inputs are temporal filtered and different time step sizes are applied in relation to frequencies.""" - data_handler = DataHandlerMixedSamplingSeparationOfScalesSingleStation - data_handler_transformation = DataHandlerMixedSamplingSeparationOfScalesSingleStation + data_handler = DataHandlerSeparationOfScalesSingleStation + data_handler_transformation = DataHandlerSeparationOfScalesSingleStation _requirements = data_handler.requirements() diff --git a/run_mixed_sampling.py b/run_mixed_sampling.py index a70e2aa36e5c1da83c4f667fbbe8b27b5949b4d6..a87e9f38e9379d10f3472009934b61acb2d147ff 100644 --- a/run_mixed_sampling.py +++ b/run_mixed_sampling.py @@ -5,7 +5,7 @@ import argparse from mlair.workflows import DefaultWorkflow from mlair.data_handler.data_handler_mixed_sampling import DataHandlerMixedSampling, DataHandlerMixedSamplingWithFilter, \ - DataHandlerMixedSamplingSeparationOfScales + DataHandlerSeparationOfScales def main(parser_args): @@ -13,7 +13,7 @@ def main(parser_args): sampling_inputs="hourly", window_history_size=24, **parser_args.__dict__, - data_handler=DataHandlerMixedSamplingSeparationOfScales, + data_handler=DataHandlerSeparationOfScales, kz_filter_length=[100 * 24, 15 * 24], kz_filter_iter=[4, 5], start="2006-01-01", diff --git a/supplement/development_guidelines.md b/supplement/development_guidelines.md index b847f06010b9d6d4b718373142e8088b4119c5df..d91e5b45bf578c30917ce38aad21bdea6ccd16ce 100644 --- a/supplement/development_guidelines.md +++ b/supplement/development_guidelines.md @@ -14,3 +14,19 @@ * Commit + push * Merge `release_vX.Y.Z` into `master` * Create new tag + + +## template for release issue + +* [ ] Create Release Issue +* [ ] Create merge request: branch `release_vX.Y.Z` into `master` +* [ ] Merge `develop` into `release_vX.Y.Z` +* [ ] Checkout `release_vX.Y.Z` +* [ ] Adjust `changelog.md` +* [ ] Update version number in `mlair/__ init__.py` +* [ ] Create new dist file: `python3 setup.py sdist bdist_wheel` +* [ ] Update file link `distribution file (current version)` in `README.md` +* [ ] Update file link in `docs/_source/get-started.rst` +* [ ] Commit + push +* [ ] Merge `release_vX.Y.Z` into `master` +* [ ] Create new tag \ No newline at end of file