search

CliMA / LESbrary.jl

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

Creating a Oceananigas Utils package or using LESbrary #106

Open tomchor opened 3 years ago

tomchor commented 3 years ago

So, I've been meaning to clean up some of my scripts and possibly creating some utilities for Oceananigans. I'm not sure if I need to do this somewhere else or if I can use LESbrary.jl, though.

I'm not sure because LESbrary.jl has some of those utilities already and it would make sense to use an already-existing repo for that, but supposedly everything here is focused on LES, which is just part of what Oceananigans can do.

For example the nice progress messenger in LESbrary is great. All I have to do to make it general is to change the ν_e line. Other things that would be nice to have stored somewhere are simple common sponge layer options (we could even move the gaussian mask from Oceananigans to avoid code clutter). But these are things that don't necessarily pertain to LES.

Anyway, I was wondering what your thoughts are.

CC: @ali-ramadhan @glwagner

ali-ramadhan commented 3 years ago

There's some precedent for a Utils.jl package, e.g. https://github.com/fonsp/PlutoUtils.jl and https://github.com/JuliaML/MLDataUtils.jl.

I definitely wouldn't be opposed to an OceananigansUtils.jl package to collect user-contributed niceties. I guess right now I can only think of the progress messenger going in there to start, but it could grow organically to include lots of useful stuff.