-
David Schäfer authoredcfa4f98b
To find the state of this project's repository at the time of any of these versions, check out the tags.
CHANGELOG.md 4.98 KiB
Changelog
This changelog starts with version 2.0.0. Basically all parts of the system, including the format of this changelog, have been reworked between the releases 1.4 and 2.0. Preceding the major breaking release 2.0, the maintenance of this file was rather sloppy, so we won't provide a detailed change history for early versions.
Unreleased
Added
- translation of
dfilter
- new generic function
clip
- parameter
min_periods
toSaQC.flagConstants
- function
fitButterworth
Changed
- test function interface changed to
func(saqc: SaQC, field: str | Sequence[str], *args, **kwargs)
- lib function
butterFilter
returnsNaN
for too-short series
Removed
-
closed
keyword inflagJumps
Fixed
- fixed undesired behavior in
flagIsolated
for not harmonized data - fixed failing translation of
dfilter
-defaults - fixed unbound recursion error when interpolating with order-independent methods in
interpolateIndex
- fixed not working min_periods condition if
window=None
inassignZScore
- fixed Exception occuring when fitting polynomials via
polyfit
to harmonized data, containing all-NaN gaps wider than the polynomial fitting window size. - fixed bug in function parameter checking
- fixed bug one-off bug in
flagJumps
2.1.0 - 2022-06-14
Added
- documentation of global keywords
- generic documentation module
docurator.py
- documentation of flagging constants
pyproject.toml
- new function
progagateFlags
- include function typehints in parameter documentation
-
label
parameter to the generic functionisflagged
Changed
-
flagOffsets
parametersthresh
andthresh_relative
are optional - corrected false notion of the term residual (replace all occurences of residue by residual)
-
FILTER_NONE
andFILTER_ALL
are top level constants (imported insaqc.__init__
) - renamed
maskTime
toselectTime
-
SaQC.data
returnsdios.DictOfSeries
-
SaQC.flags
returnsdios.DictOfSeries
orpd.DataFrame
-
SaQC.data
andSaQC.flags
are not mutated by function calls - renamed
History.max
toHistory.squeeze
- renamed parameter
freq
of function flagByStray towindow
-
DmpScheme
: setDFILTER_DEFAULT
to 1 in order to not mask the flag 'OK'
Removed
- data accessors
SaQC.result
,SaQC.data_raw
,SaQC.flags_raw
Fixed
-
flagOffset
failure on falsythresh
-
flagCrossStatistics
failure on unaligned input variables -
plot
data loss when using dfilter kwarg -
correctDrift
: failure on single value intervals -
concatFlags
: information loss by appending squeezed histories -
interpolateInvalid
: replace flags by interpolated values -
resample
: pass resampling function tohistory.appy()
-
tools.seasonalMask
: mask swapping withinclude_bounds=True
-
flagGeneric
:- fixed inconsistent history meta writing
- fixed handling of existing flags
-
proGeneeric
: fixed inconsistent history meta writing -
docs
: removed documentation of data/flags parameters from automatic sphinx doc
2.0.1 - 2021-12-20
Added
- CLI now accepts remote configuration and data files as URL
- new function
transferFlags
- improved error messages from
flagGeneric
andprocessGeneric
- new
ax_kwargs
keyword toSaQC.plot
function
Changed
- generate documentation from the
develop
branch - doctest is now ran upon push to the
develop
branch, failing doc snippets cause CI-pipeline to fail - renamed function
flagCrossStatistic
toflagCrossStatistics
Removed
- removed function
flagDriftFromScaledNorm
- removed
stats
keywords and functionality fromSaQC.plot
function
Fixed
- RDM/UFZ logos:
- use the English versions of the respective images
- use full URLs instead of the repository local URLs in
README.md
- fix code snippets in
README.md
- fix version confusion
-
copyField
: fix misleading error message -
flagGeneric
: fix failure on empty data - existing
target
variables led to function calls ontarget
instead offield
- the functions
flagDriftFromNorm
,flagDriftFromReference
,flagCrossStatistics
andflagMVScores
now properly support the field-target workflow -
field
was not masked for resampling functions - allow custom registered functions to overwrite built-ins.
2.0.0 - 2021-11-25
This release marks the beginning of a new release cycle. Basically the entire system got reworked between versions 1.4 and 2.0, a detailed changelog is not recoverable and/or useful.