Package: channest
This package estimates channel parameters from Delft3D-based RESQML models. The repository is tightly linked withhttps://github.com/NorskRegnesentral/nrresqmlThe main function ischannest.calculate_channel_parameters(settings, output_directory)calculate_channel_parametersEstimate channel parameters based on the provided parameterssettingsFile path to a json file or a dictionary containing estimation settings. All settings are optional exceptdata_file. In addition to these settings, advanced settings are described below. There are several available
advanced settings. However, the default values have been determined experimentally and should work well for most
Delft3D models. The advanced settings are documented below for completeness.data_fileFile path to a RESQML model (.epc file)crop_boxDictionary describing the extent of the model to use for estimation. Specified by providing keys x_0,
x_1, y_0 and y_1 with float values. Delft3D models are typically starting at x=0, y=0.output_directoryDirectory to which output is written.  The following files are written (relative to the provided directory):tw_scatter.pngScatter plot showing the channel thickness/width distribution per layer. Requires plotly-orca,
otherwise, this is skipped.tw_scatter.htmlScatter plot showing the channel thickness/width distribution per layer. Same as
tw_scatter.png, except as html (based on plotly) which adds zoom and pan functions.summary.jsonJSON file containing the main results as well as the settings used to generate the results.
Values under "channel-width" and "channel-height" are averaged over layers, with each layer having equal weight.
Values under "segment-width" and "segment-height" are averaged over width segments, with each segment having equal
weight.Advanced settingsThe advanced settings can be split in two: method-related and output-related. Some settings under method-related
must be specified as lists of single values. All combinations of such values are then executed in a
multi-configuration fashion, similar to vargrest. These settings are indicated by having a default values surrounded
by [brackets].Method-related parameters:merge_layersNumber of layers to merge when calculating segments. Default is [5].alpha_hullParameter to the alpha hull algorithm. 0.0 yields the convex hull. Default is [0.6]element_thresholdFloating point threshold in number of layers for which points to include as channels in the
merge layers. A value of None yields a default of including all points with a channel in at least one layer. Default
is [None]mean_map_thresholdThreshold between 0.0 and 1.0 used when filtering segments that cross areas not labeled as
channel. A value of 1.0 removes all segments touching an area not labeled as channel. A value of 0.0 will only
remove segments that does not touch areas labeled as channel at all. Default is [0.9]minimum_polygon_areaMinimum area of the alpha polygon shape for it to be included in the estimation. Default
is 100.turn_off_filtersDisables all segment filters when set to True. Default is [False].step_zSampling rate in z-direction in number of layers. Default is 1, which means all layers are sampled.z0Starting layer for sampling in z-direction. Default is 0.Output-related parameters:generate_plotsGenerate additional quality assessment plots. Default is False.generate_fencesGenerate poly lines as text files along the longest channel in each layer. These lines can be
important and used as "fences" in RMS for. Default is False.pickle_dataStore preliminary results in a Python pickle file. Main purpose is debugging or alternative
post-processing. Default is False.scatter_max_widthLength of the x-axis of the TW scatter plot, representing channel width. Default is 500.scatter_max_heightHeight of the y-axis of the TW scatter plot, representing channel thickness. Default is 14.