Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

output updates to correspond with Finch version 0.11.3 #328

Open
wants to merge 2 commits into
base: master
Choose a base branch
from
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
12 changes: 8 additions & 4 deletions docs/source/notebooks/subset-user-input.ipynb
Original file line number Diff line number Diff line change
Expand Up @@ -446,7 +446,7 @@
" end_date : string\n",
" Final date for temporal subsetting. Can be expressed as year (%Y), year-month (%Y-%m) or year-month-day(%Y-%m-%d). Defaults to last day in file.\n",
" variable : string\n",
" Name of the variable in the NetCDF file.\n",
" Name of the variable in the input files.\n",
" \n",
" Returns\n",
" -------\n",
Expand Down Expand Up @@ -1444,8 +1444,8 @@
"text": [
"Help on method heat_wave_frequency in module birdy.client.base:\n",
"\n",
"heat_wave_frequency(tasmin=None, tasmax=None, thresh_tasmin='22.0 degC', thresh_tasmax='30 degC', window=3, freq='YS', check_missing='any', missing_options=None, cf_compliance='warn', data_validation='raise', variable=None, output_name=None, output_format='netcdf', csv_precision=None, output_formats=None) method of birdy.client.base.WPSClient instance\n",
" Number of heat waves over a given period. A heat wave is defined as an event where the minimum and maximum daily temperature both exceeds specific thresholds over a minimum number of days.\n",
"heat_wave_frequency(tasmin=None, tasmax=None, thresh_tasmin='22.0 degC', thresh_tasmax='30 degC', window=3, freq='YS', op='>', resample_before_rl=True, check_missing='any', missing_options=None, cf_compliance='warn', data_validation='raise', variable=None, output_name=None, output_format='netcdf', csv_precision=None, output_formats=None) method of birdy.client.base.WPSClient instance\n",
" Number of heat waves. A heat wave occurs when daily minimum and maximum temperatures exceed given thresholds for a number of days.\n",
" \n",
" Parameters\n",
" ----------\n",
Expand All @@ -1461,6 +1461,10 @@
" Minimum number of days with temperatures above thresholds to qualify as a heatwave.\n",
" freq : {'YS', 'MS', 'QS-DEC', 'AS-JUL'}string\n",
" Resampling frequency.\n",
" op : {'>', 'ge', '>=', 'gt'}string\n"
" Comparison operation. Default: \">\".\n",
" resample_before_rl : boolean\n",
" Determines if the resampling should take place before or after the run length encoding (or a similar algorithm) is applied to runs.\n"
" check_missing : {'any', 'wmo', 'pct', 'at_least_n', 'skip', 'from_context'}string\n",
" Method used to determine which aggregations should be considered missing.\n",
" missing_options : ComplexData:mimetype:`application/json`\n",
Expand All @@ -1470,7 +1474,7 @@
" data_validation : {'log', 'warn', 'raise'}string\n",
" Whether to log, warn or raise when inputs fail data validation checks.\n",
" variable : string\n",
" Name of the variable in the NetCDF file.\n",
" Name of the variable in the input files.\n",
" output_name : string\n",
" Filename of the output (no extension).\n",
" output_format : {'netcdf', 'csv'}string\n",
Expand Down
2 changes: 1 addition & 1 deletion docs/source/notebooks/subsetting.ipynb
Original file line number Diff line number Diff line change
Expand Up @@ -127,7 +127,7 @@
" end_date : string\n",
" Final date for temporal subsetting. Can be expressed as year (%Y), year-month (%Y-%m) or year-month-day(%Y-%m-%d). Defaults to last day in file.\n",
" variable : string\n",
" Name of the variable in the NetCDF file.\n",
" Name of the variable in the input files.\n",
" \n",
" Returns\n",
" -------\n",
Expand Down