CliMA / CliMA/ParameterEstimocean.jl

Use `.dataset` rather than `.field_time_serieses`?

Open
#280 1 comment 0 reactions 0 assignees View on GitHub
🚰 user experience
Dominant language
Julia
Stars
22
Forks
6
PR merge metrics
No merged PRs in 30d

Description

I'm wondering if we should replace "field_time_serieses" with "dataset" wherever it appears. I think "dataset" rolls of the tongue better and is also sufficiently distinct from `data` so that it won't be confused.

Also Oceananigans has a prototype "`FieldDataset`" designed to represent a _group_ of `FieldTimeSeries`. It's not used much now, but could be developed further:

https://github.com/CliMA/Oceananigans.jl/blob/main/src/OutputReaders/field_dataset.jl

Contributor guide

No contributing guide indexed for this repository

Research direction

Search the ParameterEstimocean.jl tree for occurrences of `field_time_serieses` and review how the term is used. Read Oceananigans' `src/OutputReaders/field_dataset.jl` prototype for context before deciding whether `dataset` is appropriate. Done means the naming decision is resolved and any agreed terminology is applied consistently.

Written by the indexing model from the issue text.

Assessment

Tech stack
julia
Domain
data
Issue type
Refactor
Difficulty
4/5
Estimated time
3-5 days
Activity status
Stale
Clarity
Needs clarification
Newbie friendliness
25/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.