add surface flux tutorial to examples #303
Open
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Purpose
This PR adds another example to the EKP docs which details the use of EKP to recover surface flux parameters in a perfect model example.
Content
This PR adds a few files in the examples/SurfaceFluxExample folder:
kappa_calibration.jl
This file implements EKI to recover the von-karman constant, which is used in many MOST equations. It pulls data from the John Hopkins Tubulence Channel Flow, which is used by ensemble members to predict friction velocity u*. The difference in the predicted u* to the observed u* given by the dataset is used to calibrate the von-karman constant. This file is rendered to the documentation through Literate and Documenter along with a few other example Julia files.
This file differs from the file given in the SURF_2023 folder in a few ways:
setup_parameter_set.jl
This file is a helper file used by kappa_calibration.jl to define functions that are helpful for setting parameters necessary for the surface_conditions function from the SurfaceFluxes package.
alt_kappa_calibration.jl
This file is an alternate method of recovering the von-karman constant. Instead of using surface_conditions as the forward model, this example simply uses the wind profile function. The observable used is the mean wind given by the same dataset as kappa_calibration.jl. Although this file is not rendered to the documentation, it can be used by new developers to better understand the EKI pipeline.