CliMA / Oceananigans.jl

🌊 Julia software for fast, friendly, flexible, ocean-flavored fluid dynamics on CPUs and GPUs
https://clima.github.io/OceananigansDocumentation/stable
MIT License
993 stars 195 forks source link

Renaming `NetCDFOutputWriter` to `NetCDFWriter` #3936

Open tomchor opened 2 hours ago

tomchor commented 2 hours ago

We've talked about this before, since the "Output" part is pretty redundant and that name is on the verbose side. The same thing applies to JLD2OutputWriter. Should I go ahead and open a PR to make this change?

tomchor commented 2 hours ago

cc @ali-ramadhan @glwagner

ali-ramadhan commented 1 hour ago

I'm in support of this change!

glwagner commented 1 hour ago

Happy for this. It affects #3793, maye we just use add_writer! then.

glwagner commented 1 hour ago

But note that the name of the output writers may not be very important after #3793 which abstracts away that concept. So I don't know if you want to wait for #3793

tomchor commented 11 minutes ago

I wasn't aware of that PR. I like it and I'll interact with it soon :)

I still think this (what I'm proposing) would be a positive change, although I agree its importance will be diminished after that PR is merged (that's part of the point if I understand correctly). Since that PR seems not very close to be merged my thinking is that we should go for this changer in the output writer naming convention. What do you think?