Characteristic parameters ---------------------------- Explanation of characteristic parameters ========================================= This table provides the user with a direct link to the explanation of the module that extracts the characteristic parameter from the coastal profile. Thus, it provides an explanation of the precise method used to derive each characteristic parameter. +-------------------------+---------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | Parameter | Type | Explanation | +-------------------------+---------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ |Dune top | Primary | :py:mod:`JAT.Jarkus_Analysis_Toolbox.Extraction.get_primary_dune_top` | + +---------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | | Secondary | :py:mod:`JAT.Jarkus_Analysis_Toolbox.Extraction.get_secondary_dune_top` | +-------------------------+---------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ |Mean Sea Level | Fixed | :py:mod:`JAT.Jarkus_Analysis_Toolbox.Extraction.get_mean_sea_level` | + +---------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | | Variable | :py:mod:`JAT.Jarkus_Analysis_Toolbox.Extraction.get_mean_sea_level_variable` | +-------------------------+---------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ |Mean Low Water | Fixed | :py:mod:`JAT.Jarkus_Analysis_Toolbox.Extraction.get_mean_low_water_fixed` | + +---------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | | Variable | :py:mod:`JAT.Jarkus_Analysis_Toolbox.Extraction.get_mean_low_water_variable` | +-------------------------+---------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ |Mean High Water | Fixed | :py:mod:`JAT.Jarkus_Analysis_Toolbox.Extraction.get_mean_high_water_fixed` | + +---------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | | Variable | :py:mod:`JAT.Jarkus_Analysis_Toolbox.Extraction.get_mean_high_water_variable` | +-------------------------+---------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ |Intertidal area width | Fixed | :py:mod:`JAT.Jarkus_Analysis_Toolbox.Extraction.get_intertidal_width_fixed` | + +---------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | | Variable | :py:mod:`JAT.Jarkus_Analysis_Toolbox.Extraction.get_intertidal_width_variable` | +-------------------------+---------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ |Landward boundary | Variance | :py:mod:`JAT.Jarkus_Analysis_Toolbox.Extraction.get_landward_point_variance` | + +---------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | | Derivative | :py:mod:`JAT.Jarkus_Analysis_Toolbox.Extraction.get_landward_point_derivative` | + +---------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | | BMA | :py:mod:`JAT.Jarkus_Analysis_Toolbox.Extraction.get_landward_point_bma` | +-------------------------+---------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ |Seaward boundary | Foreshore | :py:mod:`JAT.Jarkus_Analysis_Toolbox.Extraction.get_seaward_point_foreshore` | + +---------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | | Active Profile | :py:mod:`JAT.Jarkus_Analysis_Toolbox.Extraction.get_seaward_point_activeprofile` | + +---------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | | Depth of Closure | :py:mod:`JAT.Jarkus_Analysis_Toolbox.Extraction.get_seaward_point_doc` | +-------------------------+---------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ |Dune toe | Fixed | :py:mod:`JAT.Jarkus_Analysis_Toolbox.Extraction.get_dune_toe_fixed` | + +---------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | | Derivative | :py:mod:`JAT.Jarkus_Analysis_Toolbox.Extraction.get_dune_toe_derivative` | + +---------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | | Pybeach | :py:mod:`JAT.Jarkus_Analysis_Toolbox.Extraction.get_dune_toe_pybeach` | +-------------------------+---------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ |Beach width | Fixed | :py:mod:`JAT.Jarkus_Analysis_Toolbox.Extraction.get_beach_width_fix` | + +---------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | | Variable | :py:mod:`JAT.Jarkus_Analysis_Toolbox.Extraction.get_beach_width_var` | + +---------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | | Derivative | :py:mod:`JAT.Jarkus_Analysis_Toolbox.Extraction.get_beach_width_der` | + +---------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | | Variable Derivative | :py:mod:`JAT.Jarkus_Analysis_Toolbox.Extraction.get_beach_width_der_var` | +-------------------------+---------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ |Beach gradient | Fixed | :py:mod:`JAT.Jarkus_Analysis_Toolbox.Extraction.get_beach_gradient_fix` | + +---------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | | Variable | :py:mod:`JAT.Jarkus_Analysis_Toolbox.Extraction.get_beach_gradient_var` | + +---------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | | Derivative | :py:mod:`JAT.Jarkus_Analysis_Toolbox.Extraction.get_beach_gradient_der` | +-------------------------+---------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ |Dune front width | Primary Fixed | :py:mod:`JAT.Jarkus_Analysis_Toolbox.Extraction.get_dune_front_width_prim_fix` | + +---------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | | Primary Derivative | :py:mod:`JAT.Jarkus_Analysis_Toolbox.Extraction.get_dune_front_width_prim_der` | + +---------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | | Secondary Fixed | :py:mod:`JAT.Jarkus_Analysis_Toolbox.Extraction.get_dune_front_width_sec_fix` | + +---------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | | Secondary Derivative| :py:mod:`JAT.Jarkus_Analysis_Toolbox.Extraction.get_dune_front_width_sec_der` | +-------------------------+---------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ |Dune front gradient | Primary Fixed | :py:mod:`JAT.Jarkus_Analysis_Toolbox.Extraction.get_dune_front_gradient_prim_fix` | + +---------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | | Primary Derivative | :py:mod:`JAT.Jarkus_Analysis_Toolbox.Extraction.get_dune_front_gradient_prim_der` | + +---------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | | Secondary Fixed | :py:mod:`JAT.Jarkus_Analysis_Toolbox.Extraction.get_dune_front_gradient_sec_fix` | + +---------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | | Secondary Derivative| :py:mod:`JAT.Jarkus_Analysis_Toolbox.Extraction.get_dune_front_gradient_sec_der` | +-------------------------+---------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ |Dune volume | Fixed | :py:mod:`JAT.Jarkus_Analysis_Toolbox.Extraction.get_dune_volume_fix` | + +---------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | | Derivative | :py:mod:`JAT.Jarkus_Analysis_Toolbox.Extraction.get_dune_volume_der` | +-------------------------+---------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ |Intertidal area gradient | Fixed | :py:mod:`JAT.Jarkus_Analysis_Toolbox.Extraction.get_intertidal_gradient_fix` | +-------------------------+---------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ |Intertidal area volume | Fixed | :py:mod:`JAT.Jarkus_Analysis_Toolbox.Extraction.get_intertidal_volume_fix` | + +---------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | | Variable | :py:mod:`JAT.Jarkus_Analysis_Toolbox.Extraction.get_intertidal_volume_var` | +-------------------------+---------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ |Foreshore gradient | BMA | :py:mod:`JAT.Jarkus_Analysis_Toolbox.Extraction.get_foreshore_gradient` | +-------------------------+---------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ |Foreshore volume | BMA | :py:mod:`JAT.Jarkus_Analysis_Toolbox.Extraction.get_foreshore_volume` | +-------------------------+---------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ |Active profile gradient | BMA | :py:mod:`JAT.Jarkus_Analysis_Toolbox.Extraction.get_active_profile_gradient` | +-------------------------+---------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ |Active profile volume | BMA | :py:mod:`JAT.Jarkus_Analysis_Toolbox.Extraction.get_active_profile_volume` | +-------------------------+---------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ Variable names and dependencies of characteristic parameters ============================================================= This table shows the variable name of each characteristic parameter that is used in the jarkus.yml file to indicate which characteristic parameters should be extracted. Additionally, the corresponding variable names of the output that is produced for each characteristic parameter is given. The last column provides on which variable the extraction of the characteristic parameters depends. For instance, the mean sea level can only be extracted when the dune top location had already been extracted because the cross-shore location of the primary dune top is necessary. These dependencies are also indicated in the :doc:`Functionalities` with the `See also` sections. +-------------------------+-----------------------------------+----------------------------------------+------------------------------------------------------------------------------------------------------+ | Parameter | Variable name (in jarkus.yml) | Output variables | Dependent | +-------------------------+-----------------------------------+----------------------------------------+------------------------------------------------------------------------------------------------------+ |Dune top | primary_dune_top | DuneTop_prim_x | | + + +----------------------------------------+------------------------------------------------------------------------------------------------------+ | | | DuneTop_prim_y | | + +-----------------------------------+----------------------------------------+------------------------------------------------------------------------------------------------------+ | | secondary_dune_top | DuneTop_sec_x | DuneTop_prim_x | + + +----------------------------------------+------------------------------------------------------------------------------------------------------+ | | | DuneTop_sec_y | DuneTop_prim_y | +-------------------------+-----------------------------------+----------------------------------------+------------------------------------------------------------------------------------------------------+ |Mean Sea Level | mean_sea_level | MSL_x | DuneTop_prim_x | + +-----------------------------------+----------------------------------------+------------------------------------------------------------------------------------------------------+ | | mean_sea_level_variable | MSL_x_var | MLW_x_var | + + + +------------------------------------------------------------------------------------------------------+ | | | | MHW_x_var | +-------------------------+-----------------------------------+----------------------------------------+------------------------------------------------------------------------------------------------------+ |Mean Low Water | mean_low_water_fixed | MLW_x_fix | MSL_x | + +-----------------------------------+----------------------------------------+------------------------------------------------------------------------------------------------------+ | | mean_low_water_variable | MLW_x_var | MSL_x | + + +----------------------------------------+------------------------------------------------------------------------------------------------------+ | | | MHW_y_var | | +-------------------------+-----------------------------------+----------------------------------------+------------------------------------------------------------------------------------------------------+ |Mean High Water | mean_high_water_fixed | MHW_x_fix | MSL_x | + +-----------------------------------+----------------------------------------+------------------------------------------------------------------------------------------------------+ | | mean_high_water_variable | MHW_x_var | MSL_x | + + +----------------------------------------+------------------------------------------------------------------------------------------------------+ | | | MHW_y_var | | +-------------------------+-----------------------------------+----------------------------------------+------------------------------------------------------------------------------------------------------+ |Intertidal area width | intertidal_width_fixed | Intertidal_width_fix | MLW_x_var | + + + +------------------------------------------------------------------------------------------------------+ | | | | MHW_x_var | + +-----------------------------------+----------------------------------------+------------------------------------------------------------------------------------------------------+ | | intertidal_width_var | Intertidal_width_var | MLW_x_var | + + + +------------------------------------------------------------------------------------------------------+ | | | | MHW_x_var | +-------------------------+-----------------------------------+----------------------------------------+------------------------------------------------------------------------------------------------------+ |Landward boundary | landward_point_variance | Landward_x_variance | DuneTop_prim_x | + +-----------------------------------+----------------------------------------+------------------------------------------------------------------------------------------------------+ | | landward_point_derivative | Landward_x_der | MHW_y_var | + +-----------------------------------+----------------------------------------+------------------------------------------------------------------------------------------------------+ | | landward_point_bma | Landward_x_bma | | +-------------------------+-----------------------------------+----------------------------------------+------------------------------------------------------------------------------------------------------+ |Seaward boundary | seaward_point_foreshore | Seaward_x_FS | | + +-----------------------------------+----------------------------------------+------------------------------------------------------------------------------------------------------+ | | seaward_point_activeprofile | Seaward_x_AP | | + +-----------------------------------+----------------------------------------+------------------------------------------------------------------------------------------------------+ | | seaward_point_doc | Seaward_x_mindepth | | + + +----------------------------------------+------------------------------------------------------------------------------------------------------+ | | | Seaward_x_DoC | | +-------------------------+-----------------------------------+----------------------------------------+------------------------------------------------------------------------------------------------------+ |Dune toe | dune_toe_fixed | Dunetoe_x_fix | | + +-----------------------------------+----------------------------------------+------------------------------------------------------------------------------------------------------+ | | dune_toe_derivative | Dunetoe_y_der | | + + +----------------------------------------+------------------------------------------------------------------------------------------------------+ | | | Dunetoe_x_der | | + +-----------------------------------+----------------------------------------+------------------------------------------------------------------------------------------------------+ | | dune_toe_pybeach | Dunetoe_y_pybeach | DuneTop_prim_x | + + +----------------------------------------+------------------------------------------------------------------------------------------------------+ | | | Dunetoe_x_pybeach | MSL_x | + + + +------------------------------------------------------------------------------------------------------+ | | | | MHW_x_var | + + + +------------------------------------------------------------------------------------------------------+ | | | | Landward_x_der | +-------------------------+-----------------------------------+----------------------------------------+------------------------------------------------------------------------------------------------------+ |Beach width | beach_width_fix | Beach_width_fix | MSL_x | + + + +------------------------------------------------------------------------------------------------------+ | | | | Dunetoe_x_fix | + +-----------------------------------+----------------------------------------+------------------------------------------------------------------------------------------------------+ | | beach_width_var | Beach_width_var | MSL_x_var | + + + +------------------------------------------------------------------------------------------------------+ | | | | Dunetoe_x_fix | + +-----------------------------------+----------------------------------------+------------------------------------------------------------------------------------------------------+ | | beach_width_der | Beach_width_der | MSL_x | + + + +------------------------------------------------------------------------------------------------------+ | | | | Dunetoe_x_der | + +-----------------------------------+----------------------------------------+------------------------------------------------------------------------------------------------------+ | | beach_width_der_var | Beach_width_der_var | MSL_x_var | + + + +------------------------------------------------------------------------------------------------------+ | | | | Dunetoe_x_der | +-------------------------+-----------------------------------+----------------------------------------+------------------------------------------------------------------------------------------------------+ |Beach gradient | beach_gradient_fix | Beach_gradient_fix | MSL_x | + + + +------------------------------------------------------------------------------------------------------+ | | | | Dunetoe_x_fix | + +-----------------------------------+----------------------------------------+------------------------------------------------------------------------------------------------------+ | | beach_gradient_var | Beach_gradient_var | MSL_x_var | + + + +------------------------------------------------------------------------------------------------------+ | | | | Dunetoe_x_fix | + +-----------------------------------+----------------------------------------+------------------------------------------------------------------------------------------------------+ | | beach_gradient_der | Beach_gradient_der | MSL_x | + + + +------------------------------------------------------------------------------------------------------+ | | | | Dunetoe_x_der | +-------------------------+-----------------------------------+----------------------------------------+------------------------------------------------------------------------------------------------------+ |Dune front width | dune_front_width_prim_fix | Dunefront_width_prim_fix | DuneTop_prim_x | + + + +------------------------------------------------------------------------------------------------------+ | | | | Dunetoe_x_fix | + +-----------------------------------+----------------------------------------+------------------------------------------------------------------------------------------------------+ | | dune_front_width_prim_der | Dunefront_width_prim_der | DuneTop_prim_x | + + + +------------------------------------------------------------------------------------------------------+ | | | | Dunetoe_x_der | + +-----------------------------------+----------------------------------------+------------------------------------------------------------------------------------------------------+ | | dune_front_width_sec_fix | Dunefront_width_sec_fix | DuneTop_prim_x | + + + +------------------------------------------------------------------------------------------------------+ | | | | DuneTop_prim_y | + + + +------------------------------------------------------------------------------------------------------+ | | | | DuneTop_sec_x | + + + +------------------------------------------------------------------------------------------------------+ | | | | Dunetoe_x_fix | + +-----------------------------------+----------------------------------------+------------------------------------------------------------------------------------------------------+ | | dune_front_width_sec_der | Dunefront_width_sec_der | DuneTop_prim_x | + + + +------------------------------------------------------------------------------------------------------+ | | | | DuneTop_prim_y | + + + +------------------------------------------------------------------------------------------------------+ | | | | DuneTop_sec_x | + + + +------------------------------------------------------------------------------------------------------+ | | | | Dunetoe_x_der | +-------------------------+-----------------------------------+----------------------------------------+------------------------------------------------------------------------------------------------------+ |Dune front gradient | dune_front_gradient_prim_fix | Dunefront_gradient_prim_fix | DuneTop_prim_x | + + + +------------------------------------------------------------------------------------------------------+ | | | | Dunetoe_x_fix | + +-----------------------------------+----------------------------------------+------------------------------------------------------------------------------------------------------+ | | dune_front_gradient_prim_der | Dunefront_gradient_prim_der | DuneTop_prim_x | + + + +------------------------------------------------------------------------------------------------------+ | | | | Dunetoe_x_der | + +-----------------------------------+----------------------------------------+------------------------------------------------------------------------------------------------------+ | | dune_front_gradient_sec_fix | Dunefront_gradient_sec_fix | DuneTop_prim_x | + + + +------------------------------------------------------------------------------------------------------+ | | | | DuneTop_prim_y | + + + +------------------------------------------------------------------------------------------------------+ | | | | DuneTop_sec_x | + + + +------------------------------------------------------------------------------------------------------+ | | | | Dunetoe_x_fix | + +-----------------------------------+----------------------------------------+------------------------------------------------------------------------------------------------------+ | | dune_front_gradient_sec_der | Dunefront_gradient_sec_der | DuneTop_prim_x | + + + +------------------------------------------------------------------------------------------------------+ | | | | DuneTop_prim_y | + + + +------------------------------------------------------------------------------------------------------+ | | | | DuneTop_sec_x | + + + +------------------------------------------------------------------------------------------------------+ | | | | Dunetoe_x_der | +-------------------------+-----------------------------------+----------------------------------------+------------------------------------------------------------------------------------------------------+ |Dune volume | dune_volume_fix | DuneVol_fix | DuneTop_prim_x | + + + +------------------------------------------------------------------------------------------------------+ | | | | Landward_x_variance | + + + +------------------------------------------------------------------------------------------------------+ | | | | Dunetoe_x_fix | + +-----------------------------------+----------------------------------------+------------------------------------------------------------------------------------------------------+ | | dune_volume_der | DuneVol_der | DuneTop_prim_x | + + + +------------------------------------------------------------------------------------------------------+ | | | | Landward_x_variance | + + + +------------------------------------------------------------------------------------------------------+ | | | | Dunetoe_x_der | +-------------------------+-----------------------------------+----------------------------------------+------------------------------------------------------------------------------------------------------+ |Intertidal area gradient | intertidal_gradient | Intertidal_gradient_fix | MSL_x | + + + +------------------------------------------------------------------------------------------------------+ | | | | MLW_x_fix | + + + +------------------------------------------------------------------------------------------------------+ | | | | MHW_x_fix | +-------------------------+-----------------------------------+----------------------------------------+------------------------------------------------------------------------------------------------------+ |Intertidal area volume | intertidal_volume_fix | Intertidal_volume_fix | MSL_x | + + + +------------------------------------------------------------------------------------------------------+ | | | | MLW_x_fix | + + + +------------------------------------------------------------------------------------------------------+ | | | | MHW_x_fix | + +-----------------------------------+----------------------------------------+------------------------------------------------------------------------------------------------------+ | | intertidal_volume_var | Intertidal_volume_var | MSL_x | + + + +------------------------------------------------------------------------------------------------------+ | | | | MLW_x_var | + + + +------------------------------------------------------------------------------------------------------+ | | | | MHW_x_var | +-------------------------+-----------------------------------+----------------------------------------+------------------------------------------------------------------------------------------------------+ |Foreshore gradient | foreshore_gradient | Foreshore_gradient | Seaward_x_FS | + + + +------------------------------------------------------------------------------------------------------+ | | | | Landward_x_bma | +-------------------------+-----------------------------------+----------------------------------------+------------------------------------------------------------------------------------------------------+ |Foreshore volume | foreshore_volume | Foreshore_volume | Seaward_x_FS | + + + +------------------------------------------------------------------------------------------------------+ | | | | Landward_x_bma | +-------------------------+-----------------------------------+----------------------------------------+------------------------------------------------------------------------------------------------------+ |Active profile gradient | active_profile_gradient | Active_profile_gradient | Seaward_x_AP | + + + +------------------------------------------------------------------------------------------------------+ | | | | Landward_x_bma | +-------------------------+-----------------------------------+----------------------------------------+------------------------------------------------------------------------------------------------------+ |Active profile volume | active_profile_volume | Active_profile_volume | Seaward_x_AP | + + + +------------------------------------------------------------------------------------------------------+ | | | | Landward_x_bma | +-------------------------+-----------------------------------+----------------------------------------+------------------------------------------------------------------------------------------------------+