Allows DatasetRestoring to act on fields by different name

[jagoosw]

This PR moves variable_name to be a kwarg in DatasetRestoring to allow users to override the default naming. A user would be required to define a struct and getindex method for the name, for example:

struct OceanBioMEAlkalinity end
Base.getindex(fields, i, j, k, ::OceanBioMEAlkalinity) = @inbounds fields.Alk[i, j, k]

[codecov]

Codecov Report

❌ Patch coverage is 0% with 1 line in your changes missing coverage. Please review.

Files with missing lines	Patch %	Lines
src/DataWrangling/ECCO/ECCO.jl	0.00%	1 Missing ⚠️

📢 Thoughts on this report? Let us know!

[simone-silvestri]

I don't think we can pass a varname that is different than the one in metadata, while this keyword argument would allow it. I would probably drop the variable_name kwarg, what you want to achieve can be done just by passing field_name am I right?

[jagoosw]

I don't think we can pass a varname that is different than the one in metadata, while this keyword argument would allow it. I would probably drop the variable_name kwarg, what you want to achieve can be done just by passing field_name am I right?

Oh yes thats true

[jagoosw]

Could I add a scale factor to the dataset? Do you think it would be best to do it in the constructor, or to pass a scale factor to the forcing function?

[simone-silvestri]

there is already the rate and mask kwargs. Would the scale be different?

[jagoosw]

there is already the rate and mask kwargs. Would the scale be different?

I mean if the dataset is different (e.g. in different units) to the field its restoring, so it would go in as s in $r (s\psi_r - \psi)$