search

CliMA / ClimaOcean.jl

🌎 Framework for realistic regional-to-global ocean simulations, and coupled ocean + sea-ice simulations based on Oceananigans and ClimaSeaIce. Basis for the ocean and sea-ice component of CliMA's Earth system model.
https://clima.github.io/ClimaOceanDocumentation/dev/
MIT License
31 stars 9 forks source link

Does `ECCOMetadata` have `dates` or a `date`? (Should we use a different design for `ECCOMetadata`?) #224

Open glwagner opened 4 hours ago

glwagner commented 4 hours ago

The docstring says date

https://github.com/CliMA/ClimaOcean.jl/blob/9c858b0152fb5cff53b845878b7c9d68c762f54b/src/DataWrangling/ECCO/ECCO_metadata.jl#L54

but the actual function signature requires dates:

https://github.com/CliMA/ClimaOcean.jl/blob/9c858b0152fb5cff53b845878b7c9d68c762f54b/src/DataWrangling/ECCO/ECCO_metadata.jl#L59

I also want to note that I think this design is confusing. The user interface is confusing, and it also makes the source code confusing.

Another design could be to have ECCOMetadata represent a single instance and then use a vector of ECCOMetadata to represent many of them (if that is even necessary).

Anything to make the design more explicit with less hidden suprises.

glwagner commented 4 hours ago

I guess another possibility is to discontinue "single date" support, so users just have to write [date] if they want one date.