diff --git a/docs/Gettingstarted.rst b/docs/Gettingstarted.rst index 4c53693..7c5cec6 100644 --- a/docs/Gettingstarted.rst +++ b/docs/Gettingstarted.rst @@ -105,8 +105,24 @@ User-defined settings ---------------------- Below you can find a list of all user-defined settings that are included in the `jarkus.yml` file. For each setting a link to the documentation of the corresponding function is provided which explains how the setting is used. -Upcoming! - + * filter1: :py:mod:`JAT.Jarkus_Analysis_Toolbox.Transects.save_elevation_dataframes` + * filter2: :py:mod:`JAT.Filtering_functions.availability_locations_filter` + * primary dune: :py:mod:`JAT.Jarkus_Analysis_Toolbox.Extraction.get_primary_dune_top` + * secondary dune: :py:mod:`JAT.Jarkus_Analysis_Toolbox.Extraction.get_secondary_dune_top` + * mean sea level: :py:mod:`JAT.Jarkus_Analysis_Toolbox.Extraction.get_mean_sea_level` + * mean high water: :py:mod:`JAT.Jarkus_Analysis_Toolbox.Extraction.get_mean_high_water_fixed` + * mean low water: :py:mod:`JAT.Jarkus_Analysis_Toolbox.Extraction.get_mean_low_water_fixed` + * landward variance threshold: :py:mod:`JAT.Jarkus_Analysis_Toolbox.Extraction.get_landward_point_variance` + * landward derivative: :py:mod:`JAT.Jarkus_Analysis_Toolbox.Extraction.get_landward_point_derivative` + * landward bma: :py:mod:`JAT.Jarkus_Analysis_Toolbox.Extraction.get_landward_point_bma` + * seaward foreshore: :py:mod:`JAT.Jarkus_Analysis_Toolbox.Extraction.get_seaward_point_foreshore` + * seaward active profile: :py:mod:`JAT.Jarkus_Analysis_Toolbox.Extraction.get_seaward_point_activeprofile` + * seaward DoC: :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` + * dune toe classifier: :py:mod:`JAT.Jarkus_Analysis_Toolbox.Extraction.get_dune_toe_derivative` + * normalization: :py:mod:`JAT.Jarkus_Analysis_Toolbox.Extraction.normalize_dimensions(` + + Dependencies --------------- The JAT has specific dependencies that are managed through the `setup.py` file, the packages needed are as follows:: diff --git a/docs/_build/Examples.html b/docs/_build/Examples.html index 914c5ab..567b6bf 100644 --- a/docs/_build/Examples.html +++ b/docs/_build/Examples.html @@ -183,8 +183,8 @@

2. Regional analysis

This Example shows how to extract all characteristic parameters from all transect locations. For this, include the correct directories in the jarkus_03.yml file and run the code in JAT_use_extract_all.py. The analysis can take a long time, around 10 hours. Thus, it is recommended to download the input files and store them locally to reduce the run time.

The Filtering_execution.py file provides an example of how the filtering functionalities of the JAT can be used.

-

To create distribution plots that show the values of the characteristic parameters through time and space use Distribution_plots.py. This script can only be used after the output of JAT_use_extract_all.py and Filtering_execution.py are available. Distribution_plots.py creates the distribution plots for both the filtered and unfiltered dataframes. The distribution plots of the unfiltered dataframes are available on the 4TU repository to show what the characteristic parameters look like.

-

Creation_netcdf.py was used to produce the netcdf file that is available on the 4TU repository. The output of Creation_netcdf.py, which is extracted_parameters.nc is saved in the Input directory because it serves as the input for Example 5.

+

To create distribution plots that show the values of the characteristic parameters through time and space use Distribution_plots.py. This script can only be used after the output of JAT_use_extract_all.py and Filtering_execution.py are available. Distribution_plots.py creates the distribution plots for both the filtered and unfiltered dataframes. The distribution plots of the unfiltered dataframes are available on the 4TU repository to show what the characteristic parameters look like.

+

Creation_netcdf.py was used to produce the netcdf file that is available on the 4TU repository. The output of Creation_netcdf.py, which is extracted_parameters.nc is saved in the Input directory because it serves as the input for Example 5.

4. Dune toe analysis

@@ -212,7 +212,7 @@

4. Dune toe analysis

5. Use NetCDF file

-

The output of Example 3 was converted into a netcdf file that is publicly available. This makes sure that the characteristic parameters can be accessed directly without having to use the Jarkus Analysis Toolbox. Thus, to work with this example you can choose to work through example 3 or just simply download extracted_parameters.nc from the 4TU repository.

+

The output of Example 3 was converted into a netcdf file that is publicly available. This makes sure that the characteristic parameters can be accessed directly without having to use the Jarkus Analysis Toolbox. Thus, to work with this example you can choose to work through example 3 or just simply download extracted_parameters.nc from the 4TU repository.

The Load_data_from_netcdf.py script shows how to load the extracted characteristic parameters from the netcdf file and gives a first glimpse of how to work with these data.

diff --git a/docs/_build/Gettingstarted.html b/docs/_build/Gettingstarted.html index d8a13d0..3312436 100644 --- a/docs/_build/Gettingstarted.html +++ b/docs/_build/Gettingstarted.html @@ -267,7 +267,26 @@

Input files

User-defined settings

Below you can find a list of all user-defined settings that are included in the jarkus.yml file. For each setting a link to the documentation of the corresponding function is provided which explains how the setting is used.

-

Upcoming!

+
+
+

Dependencies

diff --git a/docs/_build/Method.html b/docs/_build/Method.html index e9c5902..d5f484c 100644 --- a/docs/_build/Method.html +++ b/docs/_build/Method.html @@ -172,7 +172,7 @@

MethodDevelopment section.

-

The raw output parameters that were extracted by using the currently available methods are made avaiable through 4TU repository.

+

The raw output parameters that were extracted by using the currently available methods are made avaiable through 4TU repository.

Within the examples provided along with the JAT there are examples of filtering and visualisation that can be executed based on the raw output parameters. These examples provide suggestions which help to kick-start further analysis, but this is where the user can apply their own methods.

diff --git a/docs/_build/_sources/Examples.rst.txt b/docs/_build/_sources/Examples.rst.txt index 128c06d..ca9ccd6 100644 --- a/docs/_build/_sources/Examples.rst.txt +++ b/docs/_build/_sources/Examples.rst.txt @@ -56,5 +56,5 @@ The output of Example 3 was converted into a netcdf file that is publicly availa The `Load_data_from_netcdf.py` script shows how to load the extracted characteristic parameters from the netcdf file and gives a first glimpse of how to work with these data. -.. _4TU repository: https://github.com/christavanijzendoorn/JAT -.. _repository: https://github.com/christavanijzendoorn/JAT \ No newline at end of file +.. _4TU repository: https://doi.org/10.4121/14514213 +.. _repository: https://doi.org/10.4121/14514213 \ No newline at end of file diff --git a/docs/_build/_sources/Gettingstarted.rst.txt b/docs/_build/_sources/Gettingstarted.rst.txt index 4c53693..7c5cec6 100644 --- a/docs/_build/_sources/Gettingstarted.rst.txt +++ b/docs/_build/_sources/Gettingstarted.rst.txt @@ -105,8 +105,24 @@ User-defined settings ---------------------- Below you can find a list of all user-defined settings that are included in the `jarkus.yml` file. For each setting a link to the documentation of the corresponding function is provided which explains how the setting is used. -Upcoming! - + * filter1: :py:mod:`JAT.Jarkus_Analysis_Toolbox.Transects.save_elevation_dataframes` + * filter2: :py:mod:`JAT.Filtering_functions.availability_locations_filter` + * primary dune: :py:mod:`JAT.Jarkus_Analysis_Toolbox.Extraction.get_primary_dune_top` + * secondary dune: :py:mod:`JAT.Jarkus_Analysis_Toolbox.Extraction.get_secondary_dune_top` + * mean sea level: :py:mod:`JAT.Jarkus_Analysis_Toolbox.Extraction.get_mean_sea_level` + * mean high water: :py:mod:`JAT.Jarkus_Analysis_Toolbox.Extraction.get_mean_high_water_fixed` + * mean low water: :py:mod:`JAT.Jarkus_Analysis_Toolbox.Extraction.get_mean_low_water_fixed` + * landward variance threshold: :py:mod:`JAT.Jarkus_Analysis_Toolbox.Extraction.get_landward_point_variance` + * landward derivative: :py:mod:`JAT.Jarkus_Analysis_Toolbox.Extraction.get_landward_point_derivative` + * landward bma: :py:mod:`JAT.Jarkus_Analysis_Toolbox.Extraction.get_landward_point_bma` + * seaward foreshore: :py:mod:`JAT.Jarkus_Analysis_Toolbox.Extraction.get_seaward_point_foreshore` + * seaward active profile: :py:mod:`JAT.Jarkus_Analysis_Toolbox.Extraction.get_seaward_point_activeprofile` + * seaward DoC: :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` + * dune toe classifier: :py:mod:`JAT.Jarkus_Analysis_Toolbox.Extraction.get_dune_toe_derivative` + * normalization: :py:mod:`JAT.Jarkus_Analysis_Toolbox.Extraction.normalize_dimensions(` + + Dependencies --------------- The JAT has specific dependencies that are managed through the `setup.py` file, the packages needed are as follows:: diff --git a/docs/_build/_sources/Method.rst.txt b/docs/_build/_sources/Method.rst.txt index 4f08dbe..6bdf054 100644 --- a/docs/_build/_sources/Method.rst.txt +++ b/docs/_build/_sources/Method.rst.txt @@ -8,7 +8,7 @@ Method The Jarkus Analysis Toolbox helps to analyse the Jarkus dataset. This dataset is stored on an online repository and made available by Rijkswaterstaat and Deltares. -.. _online repository: http://opendap.deltares.nl/thredds/catalog/opendap/rijkswaterstaat/jarkus/profiles/catalog.html?dataset=varopendap/rijkswaterstaat/jarkus/profiles/transect.nc +.. _online repository: https://opendap.deltares.nl/thredds/fileServer/opendap/rijkswaterstaat/jarkus/profiles/transect.nc Based on user input the necessary data is retrieved from this dataset by the JAT for certain years and locations. The JAT contains the option to save the elevation information of the requested coastal transects and to create a quickplot that shows all measured years per requested transect. @@ -16,7 +16,7 @@ The core of the JAT is in the parameter extraction. This means that characterist The raw output parameters that were extracted by using the currently available methods are made avaiable through `4TU repository`_. -.. _4TU repository: https://github.com/christavanijzendoorn/JAT +.. _4TU repository: https://doi.org/10.4121/14514213 Within the examples provided along with the JAT there are examples of filtering and visualisation that can be executed based on the raw output parameters. These examples provide suggestions which help to kick-start further analysis, but this is where the user can apply their own methods. diff --git a/docs/_build/_sources/index.rst.txt b/docs/_build/_sources/index.rst.txt index 3e8860d..cedc3ef 100644 --- a/docs/_build/_sources/index.rst.txt +++ b/docs/_build/_sources/index.rst.txt @@ -6,7 +6,8 @@ The Jarkus Analysis Toolbox (JAT) is a Python-based open-source software, that c The software that is described in this documentation can be found in this `Github repository`_. Additionally, the extracted parameters for the entire Jarkus dataset are made available through the `4TU repository`_. Please use the `issues`_ page to raise questions and suggest improvements. .. _Github repository: https://github.com/christavanijzendoorn/JAT -.. _4TU repository: https://github.com/christavanijzendoorn/JAT +.. _4TU repository: https://doi.org/10.4121/14514213 + .. _issues: https://github.com/christavanijzendoorn/JAT/issues diff --git a/docs/_build/doctrees/CharacteristicParameters.doctree b/docs/_build/doctrees/CharacteristicParameters.doctree new file mode 100644 index 0000000..1ad5a70 Binary files /dev/null and b/docs/_build/doctrees/CharacteristicParameters.doctree differ diff --git a/docs/_build/doctrees/Development.doctree b/docs/_build/doctrees/Development.doctree new file mode 100644 index 0000000..c23b0ee Binary files /dev/null and b/docs/_build/doctrees/Development.doctree differ diff --git a/docs/_build/doctrees/Examples.doctree b/docs/_build/doctrees/Examples.doctree new file mode 100644 index 0000000..22a0a41 Binary files /dev/null and b/docs/_build/doctrees/Examples.doctree differ diff --git a/docs/_build/doctrees/Functionalities.doctree b/docs/_build/doctrees/Functionalities.doctree new file mode 100644 index 0000000..3573f52 Binary files /dev/null and b/docs/_build/doctrees/Functionalities.doctree differ diff --git a/docs/_build/doctrees/Gettingstarted.doctree b/docs/_build/doctrees/Gettingstarted.doctree new file mode 100644 index 0000000..2222809 Binary files /dev/null and b/docs/_build/doctrees/Gettingstarted.doctree differ diff --git a/docs/_build/doctrees/Help.doctree b/docs/_build/doctrees/Help.doctree new file mode 100644 index 0000000..1e6b0b2 Binary files /dev/null and b/docs/_build/doctrees/Help.doctree differ diff --git a/docs/_build/doctrees/Method.doctree b/docs/_build/doctrees/Method.doctree new file mode 100644 index 0000000..92e47f0 Binary files /dev/null and b/docs/_build/doctrees/Method.doctree differ diff --git a/docs/_build/doctrees/index.doctree b/docs/_build/doctrees/index.doctree new file mode 100644 index 0000000..e19061f Binary files /dev/null and b/docs/_build/doctrees/index.doctree differ diff --git a/docs/_build/index.html b/docs/_build/index.html index 1449647..b6cd5ac 100644 --- a/docs/_build/index.html +++ b/docs/_build/index.html @@ -163,7 +163,7 @@

Jarkus Analysis Toolbox documentation

The Jarkus Analysis Toolbox (JAT) is a Python-based open-source software, that can be used to analyze the Jarkus dataset. The Jarkus dataset is one of the most elaborate coastal datasets in the world and consists of coastal profiles of the entire Dutch coast, spaced about 250-500 m apart, which have been measured yearly since 1965. The main purpose of the JAT is to provide stakeholders (e.g. scientists, engineers and coastal managers) with the techniques that are necessary to study the spatial and temporal variations in characteristic parameters like dune height, dune volume, dune foot, beach width and closure depth. Different available definitions for extracting these characteristic parameters were collected and implemented in the JAT.

-

The software that is described in this documentation can be found in this Github repository. Additionally, the extracted parameters for the entire Jarkus dataset are made available through the 4TU repository. Please use the issues page to raise questions and suggest improvements.

+

The software that is described in this documentation can be found in this Github repository. Additionally, the extracted parameters for the entire Jarkus dataset are made available through the 4TU repository. Please use the issues page to raise questions and suggest improvements.

_images/parameters.png
diff --git a/docs/_build/searchindex.js b/docs/_build/searchindex.js index af6a9eb..29d6fd6 100644 --- a/docs/_build/searchindex.js +++ b/docs/_build/searchindex.js @@ -1 +1 @@ -Search.setIndex({docnames:["CharacteristicParameters","Development","Examples","Functionalities","Gettingstarted","Help","Method","index"],envversion:{"sphinx.domains.c":1,"sphinx.domains.changeset":1,"sphinx.domains.citation":1,"sphinx.domains.cpp":1,"sphinx.domains.javascript":1,"sphinx.domains.math":2,"sphinx.domains.python":1,"sphinx.domains.rst":1,"sphinx.domains.std":1,"sphinx.ext.todo":2,sphinx:56},filenames:["CharacteristicParameters.rst","Development.rst","Examples.rst","Functionalities.rst","Gettingstarted.rst","Help.rst","Method.rst","index.rst"],objects:{"JAT.Filtering_functions":{availability_locations_filter:[3,1,1,""],availability_years_filter:[3,1,1,""],locations_filter:[3,1,1,""],nourishment_filter:[3,1,1,""],yrs_filter:[3,1,1,""]},"JAT.Geometric_functions":{find_intersections:[3,1,1,""],get_gradient:[3,1,1,""],get_volume:[3,1,1,""]},"JAT.Jarkus_Analysis_Toolbox":{Extraction:[3,2,1,""],Transects:[3,2,1,""]},"JAT.Jarkus_Analysis_Toolbox.Extraction":{get_active_profile_gradient:[3,3,1,""],get_active_profile_volume:[3,3,1,""],get_all_dimensions:[3,3,1,""],get_beach_gradient_der:[3,3,1,""],get_beach_gradient_fix:[3,3,1,""],get_beach_gradient_var:[3,3,1,""],get_beach_width_der:[3,3,1,""],get_beach_width_der_var:[3,3,1,""],get_beach_width_fix:[3,3,1,""],get_beach_width_var:[3,3,1,""],get_dataframe_per_dimension:[3,3,1,""],get_dune_front_gradient_prim_der:[3,3,1,""],get_dune_front_gradient_prim_fix:[3,3,1,""],get_dune_front_gradient_sec_der:[3,3,1,""],get_dune_front_gradient_sec_fix:[3,3,1,""],get_dune_front_width_prim_der:[3,3,1,""],get_dune_front_width_prim_fix:[3,3,1,""],get_dune_front_width_sec_der:[3,3,1,""],get_dune_front_width_sec_fix:[3,3,1,""],get_dune_toe_derivative:[3,3,1,""],get_dune_toe_fixed:[3,3,1,""],get_dune_toe_pybeach:[3,3,1,""],get_dune_volume_der:[3,3,1,""],get_dune_volume_fix:[3,3,1,""],get_foreshore_gradient:[3,3,1,""],get_foreshore_volume:[3,3,1,""],get_intertidal_gradient_fix:[3,3,1,""],get_intertidal_volume_fix:[3,3,1,""],get_intertidal_volume_var:[3,3,1,""],get_intertidal_width_fixed:[3,3,1,""],get_intertidal_width_variable:[3,3,1,""],get_landward_point_bma:[3,3,1,""],get_landward_point_derivative:[3,3,1,""],get_landward_point_variance:[3,3,1,""],get_mean_high_water_fixed:[3,3,1,""],get_mean_high_water_variable:[3,3,1,""],get_mean_low_water_fixed:[3,3,1,""],get_mean_low_water_variable:[3,3,1,""],get_mean_sea_level:[3,3,1,""],get_mean_sea_level_variable:[3,3,1,""],get_primary_dune_top:[3,3,1,""],get_requested_variables:[3,3,1,""],get_seaward_point_activeprofile:[3,3,1,""],get_seaward_point_doc:[3,3,1,""],get_seaward_point_foreshore:[3,3,1,""],get_secondary_dune_top:[3,3,1,""],normalize_dimensions:[3,3,1,""]},"JAT.Jarkus_Analysis_Toolbox.Transects":{get_availability:[3,3,1,""],get_conversion_dicts:[3,3,1,""],get_transect_plot:[3,3,1,""],get_transects_filtered:[3,3,1,""],get_years_filtered:[3,3,1,""],save_elevation_dataframes:[3,3,1,""]},JAT:{Filtering_functions:[3,0,0,"-"],Geometric_functions:[3,0,0,"-"],Jarkus_Analysis_Toolbox:[3,0,0,"-"]}},objnames:{"0":["py","module","Python module"],"1":["py","function","Python function"],"2":["py","class","Python class"],"3":["py","method","Python method"]},objtypes:{"0":"py:module","1":"py:function","2":"py:class","3":"py:method"},terms:{"200m":3,"2nd":1,"4tu":[2,6,7],"case":[4,5],"class":[1,3],"default":[2,3],"float":3,"function":[0,1,2,4,5,6,7],"import":[1,3],"int":3,"long":2,"new":[2,6,7],"public":2,"return":[3,5],"short":5,"true":1,"try":[2,5],Adding:7,But:5,For:[0,1,2,3,4,5],IDE:2,That:5,The:[0,1,2,3,4,5,6,7],Then:[1,2,3],There:5,These:[0,3,4,5,6],Use:[4,7],Using:[3,7],abl:[3,4,5],about:7,abov:[1,3],access:[2,3,4],action:4,activ:[0,1,2,3,4,5],active_profile_gradi:[0,3],active_profile_volum:[0,3],add:[1,6],added:[1,6],adding:1,addit:7,addition:[0,3,7],advanc:3,advic:2,advis:4,aeolian:3,aerial:3,after:[1,2],again:5,all:[3,4,5,6,7],allow:3,along:[3,6],alongshor:3,alreadi:0,also:[0,5],alter:3,alwai:4,amount:4,anaconda:[2,4,5],analys:[4,6],analysi:[4,5,6],analyz:7,ananlysi:4,anoth:5,apart:7,appli:[3,6],applic:[3,5],applicaiton:3,appropri:1,approx:4,approxim:3,aqeou:3,area:[0,3,4],around:[2,4],arrai:3,ask:5,assig:1,assign:[1,3],associ:3,assum:3,automat:[1,3,4],avaiabl:6,avail:[1,2,3,4,5,6,7],availability_locations_filt:3,availability_years_filt:3,avoid:5,axes:3,barrier:3,base:[1,3,4,6,7],baselin:3,basemap:2,basic:3,beach:[0,3,7],beach_gradient_d:[0,3],beach_gradient_fix:[0,3],beach_gradient_var:[0,3],beach_width_d:[0,3],beach_width_der_var:[0,3],beach_width_fix:[0,3],beach_width_var:[0,3],becaus:[0,2,3,5],been:[0,3,7],begin_year:3,begin_yr:3,behaviour:3,behind:3,below:[1,3,4],beneath:3,best:[1,2,3,4,5],between:[3,4],beuzen:3,bkl:1,blink:5,blue:3,bma:[0,3],both:[1,2,3],boundari:[0,1,3,4],brows:5,button:5,calcul:[1,3],call:5,can:[0,1,2,3,4,5,6,7],cannot:3,categori:3,caus:3,certain:[3,4,5,6],cftime:4,chang:[3,4,5],characterist:[2,3,4,6,7],check:[1,2,3,4],choic:2,choos:[2,4],christavanijzendoorn:4,clair:3,classif:3,clone:4,closur:[0,1,3,7],coast:[3,7],coastal:[0,2,3,4,6,7],coastlin:1,code:[2,5],collect:7,color:3,column:0,com:[4,5],command:[2,4,5],compar:[1,3],compat:[2,4,5],comput:[4,5],conda:[2,5],config:3,configur:[1,3],consist:7,constant:3,constantli:5,contact:7,contain:[3,4,6],contour:3,contribut:5,conveni:4,convent:4,convers:3,conversion_alongshore2id:3,conversion_ids2alongshor:3,convert:[2,3],core:6,correct:2,correspond:[0,3,4],could:[1,3],creat:[2,3,4,5,6],creation_netcdf:2,cross:[0,1,3],crossshor:3,crtl:5,crucial:1,current:[1,3,5,6],cursor:5,cut:5,dam:[3,4],data:[2,3,4,6],databas:[3,4],datafram:[1,2,3],dataset:[2,3,4,6,7],decad:3,decid:4,def:1,defin:[3,7],definit:7,deltar:6,denot:5,depend:[2,5,7],depth:[0,1,3,7],deriv:[0,1,3,4],describ:7,detail:4,detect:3,determin:[3,6],develop:[2,3,4,6,7],deviat:3,diamantid:3,dict:3,dictionari:3,differ:[2,3,5,7],dike:4,dimens:[1,3,4],dimension_filt:3,direct:0,directli:[2,3],directori:[2,3,4,5],diss:3,distanc:3,distribut:[1,2,4],distribution_plot:2,doc:[1,3,4,5],document:[1,4],doe:3,doi:3,dollar:5,don:5,done:[2,3],download:[2,4],due:3,dune:[0,3,4,7],dune_front_gradient_prim_d:0,dune_front_gradient_prim_fix:0,dune_front_gradient_sec_d:0,dune_front_gradient_sec_fix:0,dune_front_width_prim_d:0,dune_front_width_prim_fix:0,dune_front_width_sec_d:0,dune_front_width_sec_fix:0,dune_toe_deriv:0,dune_toe_fix:0,dune_toe_pybeach:0,dune_transect_map:2,dune_volume_d:0,dune_volume_fix:0,dunefront_gradient_prim_d:[0,3],dunefront_gradient_prim_fix:[0,3],dunefront_gradient_sec_d:[0,3],dunefront_gradient_sec_fix:[0,3],dunefront_width_prim_d:[0,3],dunefront_width_prim_fix:[0,3],dunefront_width_sec_d:[0,3],dunefront_width_sec_fix:[0,3],duneto:4,dunetoe_alongshore_figur:2,dunetoe_transect_figur:2,dunetoe_transect_map:2,dunetoe_trend_figur:2,dunetoe_x_d:[0,3],dunetoe_x_fix:[0,3],dunetoe_x_pybeach:[0,3],dunetoe_y_d:[0,3],dunetoe_y_pybeach:[0,3],dunetop_prim_i:[0,3],dunetop_prim_x:[0,3],dunetop_sec_i:[0,3],dunetop_sec_x:[0,3],dunevol_d:[0,3],dunevol_fix:[0,3],dure:2,dutch:[3,7],each:[0,3,4,6],easi:3,edg:3,effect:3,elabor:[2,7],elev:[1,3,6],embai:3,embryo:3,end:[3,5],end_year:3,end_yr:3,engin:[3,4,7],entir:7,env:2,environ:[2,4,5],eprint:3,equal:3,especi:4,everyon:5,evolv:5,exampl:[1,4,5,6,7],exchang:3,exclud:3,execut:[2,3,6],exist:4,expect:[2,6],experienc:5,expert:3,explain:[3,4,5],explan:[5,7],explor:5,extract:[0,3,4,6,7],extracted_paramet:2,fals:[1,3],featur:5,feel:5,figur:[1,2,4],file:[0,1,3,5,7],fill:[1,4],filter1:3,filter2:3,filter:[1,2,4,6,7],filter_fil:3,filtering_execut:2,filtering_funct:[3,4],find:[1,3,4,5],find_intersect:3,find_peak:3,first:[2,3,4,5],fit:3,fix:[0,3],flowchart:6,folder:[2,4,5],follow:[2,4,5],foot:7,foreshor:[0,3],foreshore_gradi:[0,3],foreshore_volum:[0,3],forget:4,format:3,found:[2,3,4,7],free:4,from:[0,2,3,4,5,6],front:[0,3],further:[3,6],futur:[3,6],gener:[1,3],geometr:7,geometric_funct:3,geoweb55:4,get:[2,3,5,7],get_active_profile_gradi:[0,3],get_active_profile_volum:[0,3],get_all_dimens:[1,3],get_avail:3,get_beach_gradient_d:[0,3],get_beach_gradient_fix:[0,3],get_beach_gradient_var:[0,3],get_beach_width_d:[0,3],get_beach_width_der_var:[0,3],get_beach_width_fix:[0,3],get_beach_width_var:[0,3],get_conversion_dict:3,get_dataframe_per_dimens:3,get_dune_front_gradient_prim_d:[0,3],get_dune_front_gradient_prim_fix:[0,3],get_dune_front_gradient_sec_d:[0,3],get_dune_front_gradient_sec_fix:[0,3],get_dune_front_width_prim_d:[0,3],get_dune_front_width_prim_fix:[0,3],get_dune_front_width_sec_d:[0,3],get_dune_front_width_sec_fix:[0,3],get_dune_toe_deriv:[0,3],get_dune_toe_fix:[0,3],get_dune_toe_pybeach:[0,3],get_dune_volume_d:[0,3],get_dune_volume_fix:[0,3],get_foreshore_gradi:[0,3],get_foreshore_volum:[0,3],get_gradi:3,get_intertidal_gradient_fix:[0,3],get_intertidal_volume_fix:[0,3],get_intertidal_volume_var:[0,3],get_intertidal_width_fix:[0,3],get_intertidal_width_vari:[0,3],get_landward_point_bma:[0,3],get_landward_point_deriv:[0,3],get_landward_point_vari:[0,3],get_mean_high_water_fix:[0,3],get_mean_high_water_vari:[0,3],get_mean_low_water_fix:[0,3],get_mean_low_water_vari:[0,3],get_mean_sea_level:[0,3],get_mean_sea_level_vari:[0,3],get_paramet:1,get_primary_dune_top:[0,3],get_requested_vari:3,get_seaward_point_activeprofil:[0,3],get_seaward_point_doc:[0,3],get_seaward_point_foreshor:[0,3],get_secondary_dune_top:[0,3],get_transect_plot:3,get_transects_filt:3,get_volum:3,get_years_filt:3,giardino:3,git:4,github:[4,5,7],give:[2,3],given:0,glimps:2,goal:3,going:2,googl:5,gpl:4,gradient:[0,3],graph:[3,5],green:5,guid:[5,6],had:0,hallin:2,has:[3,4,5],have:[2,3,4,5,7],height:[3,7],help:[2,4,6,7],here:[2,3,4,5],hesp:2,high:[0,3],hinton:3,holland:3,hondsbossch:3,hoogheemraadschap:3,horizont:3,hour:2,how:[2,3,4,5,6],howev:5,html:[3,4,5],http:[3,4,5],ide:5,idea:5,identif:3,identifi:3,ijzendoorn:2,imagin:5,implement:7,improv:[5,7],includ:[1,2,3,4],incompat:5,increas:4,inde:4,independ:4,index:[3,4,5],indic:[0,3,5],inform:[4,5,6],input:[2,6,7],inputdir:4,insert:3,inspir:1,instal:[5,7],instanc:[0,3,4,5],instruct:5,integr:3,internet:[4,5],interpret:3,intersect:3,intersection_x:3,intertid:[0,3],intertidal_gradi:0,intertidal_gradient_fix:[0,3],intertidal_volume_fix:[0,3],intertidal_volume_var:[0,3],intertidal_width_fix:[0,3],intertidal_width_var:[0,3],introduc:1,introduct:4,island:3,issu:[5,7],its:[3,5],jarku:[0,1,2,5,6],jarkus_01:[2,5],jarkus_02:2,jarkus_03:2,jarkus_04:2,jarkus_analysis_toolbox:[0,1,3],jat:[0,1,2,3,5,6,7],jat_us:4,jat_use_dune_toe_analysi:2,jat_use_extract_al:2,jat_use_region_transect:2,jat_use_single_transect:[2,5],jcoastr:3,joblib:4,joss:3,journal:3,just:[2,4,5],kick:6,kilomet:3,know:[4,5],kustlijnkaart:4,kustvak:4,kustvakken:4,label:1,landward:[0,1,3],landward_point_bma:0,landward_point_deriv:0,landward_point_vari:0,landward_x:3,landward_x_bma:[0,3],landward_x_d:[0,3],landward_x_vari:[0,3],larg:[1,4],larger:3,last:0,lat:1,latest:5,launch:5,learn:3,least:3,leav:3,led:2,length:3,level:[0,2,3],librari:5,licens:7,like:[2,3,7],limit:3,line:[3,5],link:[0,4],list:[3,4,5],load:[2,3,5],load_data_from_netcdf:2,local:2,locat:[0,2,3,4,5,6],location_filt:4,locations_filt:[3,4],locfilt:4,lon:1,look:[2,5],lost:5,lot:5,low:[0,3],lower:3,lowest:3,maasvlakt:3,machin:3,made:[3,4,6,7],mai:5,main:7,make:[1,2,3,4,5],manag:[4,5,7],mani:[1,3,4,5],map:[2,4],marin:3,mark:5,match:2,matlab:[1,3],matplotlib:[2,4,5],maximum:3,mdx:3,mean:[0,1,3,6],mean_high_water_fix:0,mean_high_water_vari:0,mean_low_water_fix:0,mean_low_water_vari:0,mean_sea_level:0,mean_sea_level_vari:0,measur:[3,6,7],meijendel:4,meter:3,method:[0,3,4,7],mhw:3,mhw_x_fix:[0,3],mhw_x_var:[0,3],mhw_y_var:[0,3],middl:3,middlesex:3,might:5,minimum:3,mix:3,mlw:3,mlw_x_fix:[0,3],mlw_x_var:[0,3],mlw_y_var:3,model:3,modul:[0,3],momentari:1,more:[1,2,3,4,6],morphodynam:3,most:[1,3,7],mostli:3,msl:3,msl_x:[0,3],msl_x_var:[0,3],much:3,multipl:[2,3,4],name:[1,4,5,7],nan:3,navig:[4,5],necessari:[0,2,3,5,6,7],need:[4,5],netcdf4:4,netcdf:7,newer:5,next:4,nice:5,nicha:[1,3],none:3,noorderkwarti:3,normal:[1,3],normalize_dimens:[1,3],not_nourished_datafram:3,note:[1,2,3,5],nourish:[1,3,4],nourished_datafram:3,nourishment_filt:3,number:[3,7],numpi:[4,5],occur:5,often:5,onc:2,one:[2,3,4,5,7],onli:[0,1,2,3,5],onlin:[4,6],open:[2,3,4,5,7],opendap:1,option:[3,5,6],order:4,org:[3,5],other:[1,4,5],otherwis:3,out:[2,3],outcom:3,outer:3,outpac:2,output:[0,1,2,4,6],outputdir:4,over:3,overflow:5,overheid:4,overview:4,own:6,packag:[2,3,4,5],page:[5,7],panda:[2,4],paper:2,paramet:[1,2,3,4,6,7],part:3,peak:3,peak_promin:3,peopl:5,per:[3,6],percentag:3,period:[2,3],pick:1,picl:3,place:3,plai:[2,5],pleas:[5,7],plot:[2,3,5],plot_til:1,png:3,point:[3,5],posit:3,post:3,pre:3,precis:0,prefer:5,prepar:4,presenc:3,present:[3,4,5],primari:[0,3],primary_dune_top:0,problem:5,proce:3,procedur:3,process:3,produc:[0,2],profil:[0,1,3,6,7],project:5,promin:3,prompt:[2,4,5],provid:[0,1,2,3,4,5,6,7],publicli:2,puc:4,puc_629858_31:4,purpos:7,pybeach:[0,3,4],python:[1,2,3,4,7],question:[5,7],quickplot:[3,6],raai:4,raainumm:4,rais:7,ranasingh:3,rang:[1,3,4],raw:6,recommen:5,recommend:[2,5],red:3,reduc:2,reduct:3,redund:3,refer:[1,2,3],region:[3,7],relat:[3,4,5],relev:3,remov:[3,4],replic:2,repositori:[2,3,4,6,7],repres:[3,5],request:[3,4,6],requir:4,research:[2,3],result:[2,3],retain:3,retriev:[3,6],revers:3,review:2,rewritten:4,right:4,rijkswaterstaat:[4,6],rise:2,run:[2,5],same:[3,5],sand:4,santinelli:3,save:[2,3,4,5,6],save_elevation_datafram:3,schipper:3,scientif:5,scientist:7,scipi:[3,4],script:[2,5],sea:[0,2,3],sea_level_rise_figur:2,seaward:[0,3],seaward_point_activeprofil:0,seaward_point_doc:0,seaward_point_foreshor:0,seaward_x:3,seaward_x_ap:[0,3],seaward_x_doc:[0,3],seaward_x_f:[0,3],seaward_x_mindepth:[0,3],second:[3,4],secondari:[0,3],secondary_dune_top:0,section:[0,2,3,4,5,6],sediment:3,see:[0,2,4,5],select:[3,4,5],serv:2,set:[1,2,3,5,7],setup:[4,5],sever:5,share:5,shoal:3,shore:[0,1,3],shorefac:3,should:[0,1,2,3,4,5],show:[0,2,3,4,6],sign:5,signal:3,similar:3,simpli:2,sinc:7,singl:[3,4,7],slope:3,smaller:3,softwar:[3,4,7],sourc:[3,4,7],space:[2,4,7],spatial:[3,4,7],specif:[2,4,5],specifi:[3,4],split:3,spyder:[2,5],stabl:3,stack:5,stakehold:7,stand:3,standard:3,start:[2,3,5,6,7],start_yr:3,statement:[1,5],step:[1,2,3,5],stive:3,store:[2,3,4,6],stronkhorst:3,studi:[3,7],sub:3,subsequ:5,subtract:3,suggest:[4,5,6,7],suitabl:1,supl:2,sure:[1,2,3,4,5],surfac:3,surround:3,tabl:0,take:2,tansect:4,task:5,techniqu:[3,7],tempor:7,than:3,them:2,therefor:[2,3],thi:[0,1,2,3,4,5,6,7],thing:5,those:3,three:3,threshold:3,through:[2,3,4,6,7],throughout:3,thu:[0,2],tidal:3,time:[2,3,4],titl:[1,4],toe:[0,3,4,7],togeth:5,toma:3,too:5,toolbox:[2,4,5,6],top:[0,3],tow:2,train:3,transect:[3,6,7],translat:2,trsct_idx:3,tutunji:3,two:[3,4],type:[0,3,4,5],ultim:3,under:[3,4],understand:4,unfilt:2,univers:3,upcom:4,updat:1,use:[1,2,3,4,5,7],used:[0,2,4,5,7],useful:3,user:[0,3,5,6,7],uses:[2,3],using:[2,4,5,6,7],vak:4,vaknumm:4,valu:[1,2,3,4],van:2,variabl:[1,3,4,5,7],variablenam:1,variables_req:3,varianc:[0,1,3],variat:7,versa:3,version:[1,2,3,4,5],vertic:3,vice:3,viewer:4,visual:[2,4,5],visualis:6,vnnnnnn:4,volum:[0,3,7],vri:[2,3],wadden:3,wai:[4,5],walkthrough:5,want:[4,5],water:[0,3],wave:3,web:5,were:[2,3,4,6,7],westenschouwen:4,what:[2,3,4,5],when:[0,3,4,5],where:[2,3,4,5,6],whether:[2,3,4],which:[0,2,3,4,5,6,7],white:5,wide:3,width:[0,3,7],window:5,within:6,without:2,work:[1,2,3,4,5],world:7,y_valu:3,year:[2,3,4,6],yearli:7,yellow:5,yml:[0,1,2,4,5],you:[1,2,4,5],your:[2,4],yrs_filter:3,zeeland:3,zone:3,zwarenstein:3},titles:["Characteristic parameters","Development","Examples","Functionalities","Getting Started","Help","Method","Jarkus Analysis Toolbox documentation"],titleterms:{"function":3,"new":[1,5],Adding:1,Use:2,Using:4,addit:1,all:2,analysi:[2,3,7],characterist:0,contact:5,content:7,defin:4,depend:[0,4],develop:1,document:7,dune:2,exampl:2,explan:0,extract:[1,2],file:[2,4],filter:3,geometr:3,get:4,help:5,improv:1,input:4,instal:4,jarku:[3,4,7],jat:4,licens:4,method:[1,6],name:0,netcdf:2,number:4,paramet:0,python:5,region:2,set:4,singl:2,start:4,suggest:1,todo:3,toe:2,toolbox:[3,7],transect:[2,4],user:4,variabl:0}}) \ No newline at end of file +Search.setIndex({docnames:["CharacteristicParameters","Development","Examples","Functionalities","Gettingstarted","Help","Method","index"],envversion:{"sphinx.domains.c":1,"sphinx.domains.changeset":1,"sphinx.domains.citation":1,"sphinx.domains.cpp":1,"sphinx.domains.javascript":1,"sphinx.domains.math":2,"sphinx.domains.python":1,"sphinx.domains.rst":1,"sphinx.domains.std":1,"sphinx.ext.todo":2,sphinx:56},filenames:["CharacteristicParameters.rst","Development.rst","Examples.rst","Functionalities.rst","Gettingstarted.rst","Help.rst","Method.rst","index.rst"],objects:{"JAT.Filtering_functions":{availability_locations_filter:[3,1,1,""],availability_years_filter:[3,1,1,""],locations_filter:[3,1,1,""],nourishment_filter:[3,1,1,""],yrs_filter:[3,1,1,""]},"JAT.Geometric_functions":{find_intersections:[3,1,1,""],get_gradient:[3,1,1,""],get_volume:[3,1,1,""]},"JAT.Jarkus_Analysis_Toolbox":{Extraction:[3,2,1,""],Transects:[3,2,1,""]},"JAT.Jarkus_Analysis_Toolbox.Extraction":{get_active_profile_gradient:[3,3,1,""],get_active_profile_volume:[3,3,1,""],get_all_dimensions:[3,3,1,""],get_beach_gradient_der:[3,3,1,""],get_beach_gradient_fix:[3,3,1,""],get_beach_gradient_var:[3,3,1,""],get_beach_width_der:[3,3,1,""],get_beach_width_der_var:[3,3,1,""],get_beach_width_fix:[3,3,1,""],get_beach_width_var:[3,3,1,""],get_dataframe_per_dimension:[3,3,1,""],get_dune_front_gradient_prim_der:[3,3,1,""],get_dune_front_gradient_prim_fix:[3,3,1,""],get_dune_front_gradient_sec_der:[3,3,1,""],get_dune_front_gradient_sec_fix:[3,3,1,""],get_dune_front_width_prim_der:[3,3,1,""],get_dune_front_width_prim_fix:[3,3,1,""],get_dune_front_width_sec_der:[3,3,1,""],get_dune_front_width_sec_fix:[3,3,1,""],get_dune_toe_derivative:[3,3,1,""],get_dune_toe_fixed:[3,3,1,""],get_dune_toe_pybeach:[3,3,1,""],get_dune_volume_der:[3,3,1,""],get_dune_volume_fix:[3,3,1,""],get_foreshore_gradient:[3,3,1,""],get_foreshore_volume:[3,3,1,""],get_intertidal_gradient_fix:[3,3,1,""],get_intertidal_volume_fix:[3,3,1,""],get_intertidal_volume_var:[3,3,1,""],get_intertidal_width_fixed:[3,3,1,""],get_intertidal_width_variable:[3,3,1,""],get_landward_point_bma:[3,3,1,""],get_landward_point_derivative:[3,3,1,""],get_landward_point_variance:[3,3,1,""],get_mean_high_water_fixed:[3,3,1,""],get_mean_high_water_variable:[3,3,1,""],get_mean_low_water_fixed:[3,3,1,""],get_mean_low_water_variable:[3,3,1,""],get_mean_sea_level:[3,3,1,""],get_mean_sea_level_variable:[3,3,1,""],get_primary_dune_top:[3,3,1,""],get_requested_variables:[3,3,1,""],get_seaward_point_activeprofile:[3,3,1,""],get_seaward_point_doc:[3,3,1,""],get_seaward_point_foreshore:[3,3,1,""],get_secondary_dune_top:[3,3,1,""],normalize_dimensions:[3,3,1,""]},"JAT.Jarkus_Analysis_Toolbox.Transects":{get_availability:[3,3,1,""],get_conversion_dicts:[3,3,1,""],get_transect_plot:[3,3,1,""],get_transects_filtered:[3,3,1,""],get_years_filtered:[3,3,1,""],save_elevation_dataframes:[3,3,1,""]},JAT:{Filtering_functions:[3,0,0,"-"],Geometric_functions:[3,0,0,"-"],Jarkus_Analysis_Toolbox:[3,0,0,"-"]}},objnames:{"0":["py","module","Python module"],"1":["py","function","Python function"],"2":["py","class","Python class"],"3":["py","method","Python method"]},objtypes:{"0":"py:module","1":"py:function","2":"py:class","3":"py:method"},terms:{"200m":3,"2nd":1,"4tu":[2,6,7],"case":[4,5],"class":[1,3],"default":[2,3],"float":3,"function":[0,1,2,4,5,6,7],"import":[1,3],"int":3,"long":2,"new":[2,6,7],"public":2,"return":[3,5],"short":5,"true":1,"try":[2,5],Adding:7,But:5,For:[0,1,2,3,4,5],IDE:2,That:5,The:[0,1,2,3,4,5,6,7],Then:[1,2,3],There:5,These:[0,3,4,5,6],Use:[4,7],Using:[3,7],abl:[3,4,5],about:7,abov:[1,3],access:[2,3,4],action:4,activ:[0,1,2,3,4,5],active_profile_gradi:[0,3],active_profile_volum:[0,3],add:[1,6],added:[1,6],adding:1,addit:7,addition:[0,3,7],advanc:3,advic:2,advis:4,aeolian:3,aerial:3,after:[1,2],again:5,all:[3,4,5,6,7],allow:3,along:[3,6],alongshor:3,alreadi:0,also:[0,5],alter:3,alwai:4,amount:4,anaconda:[2,4,5],analys:[4,6],analysi:[4,5,6],analyz:7,ananlysi:4,anoth:5,apart:7,appli:[3,6],applic:[3,5],applicaiton:3,appropri:1,approx:4,approxim:3,aqeou:3,area:[0,3,4],around:[2,4],arrai:3,ask:5,assig:1,assign:[1,3],associ:3,assum:3,automat:[1,3,4],avaiabl:6,avail:[1,2,3,4,5,6,7],availability_locations_filt:[3,4],availability_years_filt:3,avoid:5,axes:3,barrier:3,base:[1,3,4,6,7],baselin:3,basemap:2,basic:3,beach:[0,3,7],beach_gradient_d:[0,3],beach_gradient_fix:[0,3],beach_gradient_var:[0,3],beach_width_d:[0,3],beach_width_der_var:[0,3],beach_width_fix:[0,3],beach_width_var:[0,3],becaus:[0,2,3,5],been:[0,3,7],begin_year:3,begin_yr:3,behaviour:3,behind:3,below:[1,3,4],beneath:3,best:[1,2,3,4,5],between:[3,4],beuzen:3,bkl:1,blink:5,blue:3,bma:[0,3,4],both:[1,2,3],boundari:[0,1,3,4],brows:5,button:5,calcul:[1,3],call:5,can:[0,1,2,3,4,5,6,7],cannot:3,categori:3,caus:3,certain:[3,4,5,6],cftime:4,chang:[3,4,5],characterist:[2,3,4,6,7],check:[1,2,3,4],choic:2,choos:[2,4],christavanijzendoorn:4,clair:3,classif:3,classifi:4,clone:4,closur:[0,1,3,7],coast:[3,7],coastal:[0,2,3,4,6,7],coastlin:1,code:[2,5],collect:7,color:3,column:0,com:[4,5],command:[2,4,5],compar:[1,3],compat:[2,4,5],comput:[4,5],conda:[2,5],config:3,configur:[1,3],consist:7,constant:3,constantli:5,contact:7,contain:[3,4,6],contour:3,contribut:5,conveni:4,convent:4,convers:3,conversion_alongshore2id:3,conversion_ids2alongshor:3,convert:[2,3],core:6,correct:2,correspond:[0,3,4],could:[1,3],creat:[2,3,4,5,6],creation_netcdf:2,cross:[0,1,3],crossshor:3,crtl:5,crucial:1,current:[1,3,5,6],cursor:5,cut:5,dam:[3,4],data:[2,3,4,6],databas:[3,4],datafram:[1,2,3],dataset:[2,3,4,6,7],decad:3,decid:4,def:1,defin:[3,7],definit:7,deltar:6,denot:5,depend:[2,5,7],depth:[0,1,3,7],deriv:[0,1,3,4],describ:7,detail:4,detect:3,determin:[3,6],develop:[2,3,4,6,7],deviat:3,diamantid:3,dict:3,dictionari:3,differ:[2,3,5,7],dike:4,dimens:[1,3,4],dimension_filt:3,direct:0,directli:[2,3],directori:[2,3,4,5],diss:3,distanc:3,distribut:[1,2,4],distribution_plot:2,doc:[1,3,4,5],document:[1,4],doe:3,doi:3,dollar:5,don:5,done:[2,3],download:[2,4],due:3,dune:[0,3,4,7],dune_front_gradient_prim_d:0,dune_front_gradient_prim_fix:0,dune_front_gradient_sec_d:0,dune_front_gradient_sec_fix:0,dune_front_width_prim_d:0,dune_front_width_prim_fix:0,dune_front_width_sec_d:0,dune_front_width_sec_fix:0,dune_toe_deriv:0,dune_toe_fix:0,dune_toe_pybeach:0,dune_transect_map:2,dune_volume_d:0,dune_volume_fix:0,dunefront_gradient_prim_d:[0,3],dunefront_gradient_prim_fix:[0,3],dunefront_gradient_sec_d:[0,3],dunefront_gradient_sec_fix:[0,3],dunefront_width_prim_d:[0,3],dunefront_width_prim_fix:[0,3],dunefront_width_sec_d:[0,3],dunefront_width_sec_fix:[0,3],duneto:4,dunetoe_alongshore_figur:2,dunetoe_transect_figur:2,dunetoe_transect_map:2,dunetoe_trend_figur:2,dunetoe_x_d:[0,3],dunetoe_x_fix:[0,3],dunetoe_x_pybeach:[0,3],dunetoe_y_d:[0,3],dunetoe_y_pybeach:[0,3],dunetop_prim_i:[0,3],dunetop_prim_x:[0,3],dunetop_sec_i:[0,3],dunetop_sec_x:[0,3],dunevol_d:[0,3],dunevol_fix:[0,3],dure:2,dutch:[3,7],each:[0,3,4,6],easi:3,edg:3,effect:3,elabor:[2,7],elev:[1,3,6],embai:3,embryo:3,end:[3,5],end_year:3,end_yr:3,engin:[3,4,7],entir:7,env:2,environ:[2,4,5],eprint:3,equal:3,especi:4,everyon:5,evolv:5,exampl:[1,4,5,6,7],exchang:3,exclud:3,execut:[2,3,6],exist:4,expect:[2,6],experienc:5,expert:3,explain:[3,4,5],explan:[5,7],explor:5,extract:[0,3,4,6,7],extracted_paramet:2,fals:[1,3],featur:5,feel:5,figur:[1,2,4],file:[0,1,3,5,7],fill:[1,4],filter1:[3,4],filter2:[3,4],filter:[1,2,4,6,7],filter_fil:3,filtering_execut:2,filtering_funct:[3,4],find:[1,3,4,5],find_intersect:3,find_peak:3,first:[2,3,4,5],fit:3,fix:[0,3,4],flowchart:6,folder:[2,4,5],follow:[2,4,5],foot:7,foreshor:[0,3,4],foreshore_gradi:[0,3],foreshore_volum:[0,3],forget:4,format:3,found:[2,3,4,7],free:4,from:[0,2,3,4,5,6],front:[0,3],further:[3,6],futur:[3,6],gener:[1,3],geometr:7,geometric_funct:3,geoweb55:4,get:[2,3,5,7],get_active_profile_gradi:[0,3],get_active_profile_volum:[0,3],get_all_dimens:[1,3],get_avail:3,get_beach_gradient_d:[0,3],get_beach_gradient_fix:[0,3],get_beach_gradient_var:[0,3],get_beach_width_d:[0,3],get_beach_width_der_var:[0,3],get_beach_width_fix:[0,3],get_beach_width_var:[0,3],get_conversion_dict:3,get_dataframe_per_dimens:3,get_dune_front_gradient_prim_d:[0,3],get_dune_front_gradient_prim_fix:[0,3],get_dune_front_gradient_sec_d:[0,3],get_dune_front_gradient_sec_fix:[0,3],get_dune_front_width_prim_d:[0,3],get_dune_front_width_prim_fix:[0,3],get_dune_front_width_sec_d:[0,3],get_dune_front_width_sec_fix:[0,3],get_dune_toe_deriv:[0,3,4],get_dune_toe_fix:[0,3,4],get_dune_toe_pybeach:[0,3],get_dune_volume_d:[0,3],get_dune_volume_fix:[0,3],get_foreshore_gradi:[0,3],get_foreshore_volum:[0,3],get_gradi:3,get_intertidal_gradient_fix:[0,3],get_intertidal_volume_fix:[0,3],get_intertidal_volume_var:[0,3],get_intertidal_width_fix:[0,3],get_intertidal_width_vari:[0,3],get_landward_point_bma:[0,3,4],get_landward_point_deriv:[0,3,4],get_landward_point_vari:[0,3,4],get_mean_high_water_fix:[0,3,4],get_mean_high_water_vari:[0,3],get_mean_low_water_fix:[0,3,4],get_mean_low_water_vari:[0,3],get_mean_sea_level:[0,3,4],get_mean_sea_level_vari:[0,3],get_paramet:1,get_primary_dune_top:[0,3,4],get_requested_vari:3,get_seaward_point_activeprofil:[0,3,4],get_seaward_point_doc:[0,3,4],get_seaward_point_foreshor:[0,3,4],get_secondary_dune_top:[0,3,4],get_transect_plot:3,get_transects_filt:3,get_volum:3,get_years_filt:3,giardino:3,git:4,github:[4,5,7],give:[2,3],given:0,glimps:2,goal:3,going:2,googl:5,gpl:4,gradient:[0,3],graph:[3,5],green:5,guid:[5,6],had:0,hallin:2,has:[3,4,5],have:[2,3,4,5,7],height:[3,7],help:[2,4,6,7],here:[2,3,4,5],hesp:2,high:[0,3,4],hinton:3,holland:3,hondsbossch:3,hoogheemraadschap:3,horizont:3,hour:2,how:[2,3,4,5,6],howev:5,html:[3,4,5],http:[3,4,5],ide:5,idea:5,identif:3,identifi:3,ijzendoorn:2,imagin:5,implement:7,improv:[5,7],includ:[1,2,3,4],incompat:5,increas:4,inde:4,independ:4,index:[3,4,5],indic:[0,3,5],inform:[4,5,6],input:[2,6,7],inputdir:4,insert:3,inspir:1,instal:[5,7],instanc:[0,3,4,5],instruct:5,integr:3,internet:[4,5],interpret:3,intersect:3,intersection_x:3,intertid:[0,3],intertidal_gradi:0,intertidal_gradient_fix:[0,3],intertidal_volume_fix:[0,3],intertidal_volume_var:[0,3],intertidal_width_fix:[0,3],intertidal_width_var:[0,3],introduc:1,introduct:4,island:3,issu:[5,7],its:[3,5],jarku:[0,1,2,5,6],jarkus_01:[2,5],jarkus_02:2,jarkus_03:2,jarkus_04:2,jarkus_analysis_toolbox:[0,1,3,4],jat:[0,1,2,3,5,6,7],jat_us:4,jat_use_dune_toe_analysi:2,jat_use_extract_al:2,jat_use_region_transect:2,jat_use_single_transect:[2,5],jcoastr:3,joblib:4,joss:3,journal:3,just:[2,4,5],kick:6,kilomet:3,know:[4,5],kustlijnkaart:4,kustvak:4,kustvakken:4,label:1,landward:[0,1,3,4],landward_point_bma:0,landward_point_deriv:0,landward_point_vari:0,landward_x:3,landward_x_bma:[0,3],landward_x_d:[0,3],landward_x_vari:[0,3],larg:[1,4],larger:3,last:0,lat:1,latest:5,launch:5,learn:3,least:3,leav:3,led:2,length:3,level:[0,2,3,4],librari:5,licens:7,like:[2,3,7],limit:3,line:[3,5],link:[0,4],list:[3,4,5],load:[2,3,5],load_data_from_netcdf:2,local:2,locat:[0,2,3,4,5,6],location_filt:4,locations_filt:[3,4],locfilt:4,lon:1,look:[2,5],lost:5,lot:5,low:[0,3,4],lower:3,lowest:3,maasvlakt:3,machin:3,made:[3,4,6,7],mai:5,main:7,make:[1,2,3,4,5],manag:[4,5,7],mani:[1,3,4,5],map:[2,4],marin:3,mark:5,match:2,matlab:[1,3],matplotlib:[2,4,5],maximum:3,mdx:3,mean:[0,1,3,4,6],mean_high_water_fix:0,mean_high_water_vari:0,mean_low_water_fix:0,mean_low_water_vari:0,mean_sea_level:0,mean_sea_level_vari:0,measur:[3,6,7],meijendel:4,meter:3,method:[0,3,4,7],mhw:3,mhw_x_fix:[0,3],mhw_x_var:[0,3],mhw_y_var:[0,3],middl:3,middlesex:3,might:5,minimum:3,mix:3,mlw:3,mlw_x_fix:[0,3],mlw_x_var:[0,3],mlw_y_var:3,model:3,modul:[0,3],momentari:1,more:[1,2,3,4,6],morphodynam:3,most:[1,3,7],mostli:3,msl:3,msl_x:[0,3],msl_x_var:[0,3],much:3,multipl:[2,3,4],name:[1,4,5,7],nan:3,navig:[4,5],necessari:[0,2,3,5,6,7],need:[4,5],netcdf4:4,netcdf:7,newer:5,next:4,nice:5,nicha:[1,3],none:3,noorderkwarti:3,normal:[1,3,4],normalize_dimens:[1,3,4],not_nourished_datafram:3,note:[1,2,3,5],nourish:[1,3,4],nourished_datafram:3,nourishment_filt:3,number:[3,7],numpi:[4,5],occur:5,often:5,onc:2,one:[2,3,4,5,7],onli:[0,1,2,3,5],onlin:[4,6],open:[2,3,4,5,7],opendap:1,option:[3,5,6],order:4,org:[3,5],other:[1,4,5],otherwis:3,out:[2,3],outcom:3,outer:3,outpac:2,output:[0,1,2,4,6],outputdir:4,over:3,overflow:5,overheid:4,overview:4,own:6,packag:[2,3,4,5],page:[5,7],panda:[2,4],paper:2,paramet:[1,2,3,4,6,7],part:3,peak:3,peak_promin:3,peopl:5,per:[3,6],percentag:3,period:[2,3],pick:1,picl:3,place:3,plai:[2,5],pleas:[5,7],plot:[2,3,5],plot_til:1,png:3,point:[3,5],posit:3,post:3,pre:3,precis:0,prefer:5,prepar:4,presenc:3,present:[3,4,5],primari:[0,3,4],primary_dune_top:0,problem:5,proce:3,procedur:3,process:3,produc:[0,2],profil:[0,1,3,4,6,7],project:5,promin:3,prompt:[2,4,5],provid:[0,1,2,3,4,5,6,7],publicli:2,puc:4,puc_629858_31:4,purpos:7,pybeach:[0,3,4],python:[1,2,3,4,7],question:[5,7],quickplot:[3,6],raai:4,raainumm:4,rais:7,ranasingh:3,rang:[1,3,4],raw:6,recommen:5,recommend:[2,5],red:3,reduc:2,reduct:3,redund:3,refer:[1,2,3],region:[3,7],relat:[3,4,5],relev:3,remov:[3,4],replic:2,repositori:[2,3,4,6,7],repres:[3,5],request:[3,4,6],requir:4,research:[2,3],result:[2,3],retain:3,retriev:[3,6],revers:3,review:2,rewritten:4,right:4,rijkswaterstaat:[4,6],rise:2,run:[2,5],same:[3,5],sand:4,santinelli:3,save:[2,3,4,5,6],save_elevation_datafram:[3,4],schipper:3,scientif:5,scientist:7,scipi:[3,4],script:[2,5],sea:[0,2,3,4],sea_level_rise_figur:2,seaward:[0,3,4],seaward_point_activeprofil:0,seaward_point_doc:0,seaward_point_foreshor:0,seaward_x:3,seaward_x_ap:[0,3],seaward_x_doc:[0,3],seaward_x_f:[0,3],seaward_x_mindepth:[0,3],second:[3,4],secondari:[0,3,4],secondary_dune_top:0,section:[0,2,3,4,5,6],sediment:3,see:[0,2,4,5],select:[3,4,5],serv:2,set:[1,2,3,5,7],setup:[4,5],sever:5,share:5,shoal:3,shore:[0,1,3],shorefac:3,should:[0,1,2,3,4,5],show:[0,2,3,4,6],sign:5,signal:3,similar:3,simpli:2,sinc:7,singl:[3,4,7],slope:3,smaller:3,softwar:[3,4,7],sourc:[3,4,7],space:[2,4,7],spatial:[3,4,7],specif:[2,4,5],specifi:[3,4],split:3,spyder:[2,5],stabl:3,stack:5,stakehold:7,stand:3,standard:3,start:[2,3,5,6,7],start_yr:3,statement:[1,5],step:[1,2,3,5],stive:3,store:[2,3,4,6],stronkhorst:3,studi:[3,7],sub:3,subsequ:5,subtract:3,suggest:[4,5,6,7],suitabl:1,supl:2,sure:[1,2,3,4,5],surfac:3,surround:3,tabl:0,take:2,tansect:4,task:5,techniqu:[3,7],tempor:7,than:3,them:2,therefor:[2,3],thi:[0,1,2,3,4,5,6,7],thing:5,those:3,three:3,threshold:[3,4],through:[2,3,4,6,7],throughout:3,thu:[0,2],tidal:3,time:[2,3,4],titl:[1,4],toe:[0,3,4,7],togeth:5,toma:3,too:5,toolbox:[2,4,5,6],top:[0,3],tow:2,train:3,transect:[3,6,7],translat:2,trsct_idx:3,tutunji:3,two:[3,4],type:[0,3,4,5],ultim:3,under:[3,4],understand:4,unfilt:2,univers:3,updat:1,use:[1,2,3,4,5,7],used:[0,2,4,5,7],useful:3,user:[0,3,5,6,7],uses:[2,3],using:[2,4,5,6,7],vak:4,vaknumm:4,valu:[1,2,3,4],van:2,variabl:[1,3,4,5,7],variablenam:1,variables_req:3,varianc:[0,1,3,4],variat:7,versa:3,version:[1,2,3,4,5],vertic:3,vice:3,viewer:4,visual:[2,4,5],visualis:6,vnnnnnn:4,volum:[0,3,7],vri:[2,3],wadden:3,wai:[4,5],walkthrough:5,want:[4,5],water:[0,3,4],wave:3,web:5,were:[2,3,4,6,7],westenschouwen:4,what:[2,3,4,5],when:[0,3,4,5],where:[2,3,4,5,6],whether:[2,3,4],which:[0,2,3,4,5,6,7],white:5,wide:3,width:[0,3,7],window:5,within:6,without:2,work:[1,2,3,4,5],world:7,y_valu:3,year:[2,3,4,6],yearli:7,yellow:5,yml:[0,1,2,4,5],you:[1,2,4,5],your:[2,4],yrs_filter:3,zeeland:3,zone:3,zwarenstein:3},titles:["Characteristic parameters","Development","Examples","Functionalities","Getting Started","Help","Method","Jarkus Analysis Toolbox documentation"],titleterms:{"function":3,"new":[1,5],Adding:1,Use:2,Using:4,addit:1,all:2,analysi:[2,3,7],characterist:0,contact:5,content:7,defin:4,depend:[0,4],develop:1,document:7,dune:2,exampl:2,explan:0,extract:[1,2],file:[2,4],filter:3,geometr:3,get:4,help:5,improv:1,input:4,instal:4,jarku:[3,4,7],jat:4,licens:4,method:[1,6],name:0,netcdf:2,number:4,paramet:0,python:5,region:2,set:4,singl:2,start:4,suggest:1,todo:3,toe:2,toolbox:[3,7],transect:[2,4],user:4,variabl:0}}) \ No newline at end of file