Skip to content

Commit fcb332d

Browse files
committed
Updates to running windows parts of the documentation
1 parent ebfa752 commit fcb332d

File tree

5 files changed

+11
-11
lines changed

5 files changed

+11
-11
lines changed

ibicus/debias/_cdft.py

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -136,9 +136,9 @@ class CDFt(SeasonalAndFutureRunningWindowDebiaser):
136136
running_window_mode_over_years_of_cm_future : bool
137137
Controls whether the methodology is applied on a running time window, running over the years of the future climate model. This helps to smooth discontinuities in the preserved trends. Default: ``False``.
138138
running_window_over_years_of_cm_future_length : int
139-
Length of the running window in years: how many years are used to define the future climate (default: ``17`` years). Only relevant if ``running_window_mode_over_years_of_cm_future = True``.
139+
Length of the running window in years: how many years are used to define the future climate. Only relevant if ``running_window_mode_over_years_of_cm_future = True``. Default: ``17`` years.
140140
running_window_over_years_of_cm_future_step_length : int
141-
Step length of the running window in years: how many years are bias adjusted inside the running window (default: ``9`` years). Only relevant if ``running_window_mode_over_years_of_cm_future = True``.
141+
Step length of the running window in years: how many years are bias adjusted inside the running window. Only relevant if ``running_window_mode_over_years_of_cm_future = True``. Default: ``9`` years.
142142
143143
variable : str
144144
Variable for which the debiasing is done. Default: ``"unknown"``.

ibicus/debias/_ecdfm.py

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -128,9 +128,9 @@ class ECDFM(SeasonalAndFutureRunningWindowDebiaser):
128128
running_window_mode_over_years_of_cm_future : bool
129129
Controls whether the methodology is applied on a running time window, running over the years of the future climate model. This helps to smooth discontinuities in the preserved trends. Default: ``False``.
130130
running_window_over_years_of_cm_future_length : int
131-
Length of the running window in years: how many years are used to define the future climate (default: ``31`` years). Only relevant if ``running_window_mode_over_years_of_cm_future = True``.
131+
Length of the running window in years: how many years are used to define the future climate. Only relevant if ``running_window_mode_over_years_of_cm_future = True``. Default: ``31`` years.
132132
running_window_over_years_of_cm_future_step_length : int
133-
Step length of the running window in years: how many years are bias adjusted inside the running window (default: ``9`` years). Only relevant if ``running_window_mode_over_years_of_cm_future = True``.
133+
Step length of the running window in years: how many years are bias adjusted inside the running window. Only relevant if ``running_window_mode_over_years_of_cm_future = True``. Default: ``9`` years.
134134
135135
variable : str
136136
Variable for which the debiasing is done. Default: "unknown".
@@ -187,7 +187,7 @@ class ECDFM(SeasonalAndFutureRunningWindowDebiaser):
187187
validator=[attrs.validators.instance_of(int), attrs.validators.gt(0)],
188188
)
189189
running_window_over_years_of_cm_future_step_length: int = attrs.field(
190-
default=1, validator=[attrs.validators.instance_of(int), attrs.validators.gt(0)]
190+
default=9, validator=[attrs.validators.instance_of(int), attrs.validators.gt(0)]
191191
)
192192

193193
@classmethod

ibicus/debias/_quantile_delta_mapping.py

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -168,9 +168,9 @@ class QuantileDeltaMapping(SeasonalAndFutureRunningWindowDebiaser):
168168
running_window_mode_over_years_of_cm_future : bool
169169
Controls whether the methodology is applied on a running time window, running over the years of the future climate model. This helps to smooth discontinuities in the preserved trends. Default: ``True``.
170170
running_window_over_years_of_cm_future_length : int
171-
Length of the running window in years: how many years are used to define the future climate (default: ``31`` years). Only relevant if ``running_window_mode_over_years_of_cm_future = True``.
171+
Length of the running window in years: how many years are used to define the future climate. Only relevant if ``running_window_mode_over_years_of_cm_future = True``. Default: `31` years.
172172
running_window_over_years_of_cm_future_step_length : int
173-
Step length of the running window in years: how many years are bias adjusted inside the running window (default: ``1`` years). Only relevant if ``running_window_mode_over_years_of_cm_future = True``.
173+
Step length of the running window in years: how many years are bias adjusted inside the running window. Only relevant if ``running_window_mode_over_years_of_cm_future = True``. Default: `1` year.
174174
175175
variable : str
176176
Variable for which the debiasing is done. Default: ``"unknown"``. |brr|

ibicus/debias/_quantile_mapping.py

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -161,9 +161,9 @@ class QuantileMapping(SeasonalAndFutureRunningWindowDebiaser):
161161
running_window_mode_over_years_of_cm_future : bool
162162
Controls whether the methodology is applied on a running time window, running over the years of the future climate model. This helps to smooth discontinuities in the preserved trends. Default: ``False``.
163163
running_window_over_years_of_cm_future_length : int
164-
Length of the running window in years: how many years are used to define the future climate (default: ``31`` years). Only relevant if ``running_window_mode_over_years_of_cm_future = True``.
164+
Length of the running window in years: how many years are used to define the future climate. Only relevant if ``running_window_mode_over_years_of_cm_future = True``. Default: ``31`` years.
165165
running_window_over_years_of_cm_future_step_length : int
166-
Step length of the running window in years: how many years are bias adjusted inside the running window (default: ``9`` years). Only relevant if ``running_window_mode_over_years_of_cm_future = True``.
166+
Step length of the running window in years: how many years are bias adjusted inside the running window. Only relevant if ``running_window_mode_over_years_of_cm_future = True``. Default: ``9`` years.
167167
168168
variable : str
169169
Variable for which the debiasing is done. Default: ``"unknown"``.

ibicus/debias/_running_window_debiaser.py

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -219,9 +219,9 @@ class SeasonalAndFutureRunningWindowDebiaser(SeasonalRunningWindowDebiaser):
219219
running_window_mode_over_years_of_cm_future : bool
220220
Controls whether the methodology is applied on a running time window, running over the years of the future climate model. This helps to smooth discontinuities in the preserved trends. Default: ``False``.
221221
running_window_over_years_of_cm_future_length : int
222-
Length of the running window in years: how many years are used to define the future climate (default: ``31`` years). Only relevant if ``running_window_mode_over_years_of_cm_future = True``.
222+
Length of the running window in years: how many years are used to define the future climate. Only relevant if ``running_window_mode_over_years_of_cm_future = True``. Default: ``31`` years.
223223
running_window_over_years_of_cm_future_step_length : int
224-
Step length of the running window in years: how many years are bias adjusted inside the running window (default: ``9`` years). Only relevant if ``running_window_mode_over_years_of_cm_future = True``.
224+
Step length of the running window in years: how many years are bias adjusted inside the running window. Only relevant if ``running_window_mode_over_years_of_cm_future = True``. Default: ``9`` years.
225225
"""
226226

227227
# Running window over future

0 commit comments

Comments
 (0)