CliMA / LESbrary.jl

📚Generating Oceananigans large eddy simulation (LES) data for calibrating parameterizations
MIT License
28 stars 10 forks source link

Distinguish between "examples" / "tutorials" and "experiments"? #72

Open glwagner opened 3 years ago

glwagner commented 3 years ago

Currently all our scripts are in examples/.

It might be logical to organize files differently. examples/ are probably more appropriately simple scripts that illustrate some of the functionality of LESbrary.jl (eg, how to use the turbulence statistics ComputedField and KernelComputedFields that are defined, how to use the LES model modifications, etc).

experiments/ (or perhaps some other better name) can hold scripts like three_layer_constant_fluxes.jl that are used to produce the LESbrary data. There will be more in the future. These scripts are by necessity a lot longer and more complicated than the examples/.