Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Expose a public interface for CF encoding/decoding functions #155

Open
shoyer opened this issue Jun 12, 2014 · 3 comments
Open

Expose a public interface for CF encoding/decoding functions #155

shoyer opened this issue Jun 12, 2014 · 3 comments

Comments

@shoyer
Copy link
Member

shoyer commented Jun 12, 2014

Relevant discussion: #153

@stale
Copy link

stale bot commented Feb 3, 2019

In order to maintain a list of currently relevant issues, we mark issues as stale after a period of inactivity

If this issue remains relevant, please comment here or remove the stale label; otherwise it will be marked as closed automatically

@stale stale bot added the stale label Feb 3, 2019
@jhamman
Copy link
Member

jhamman commented Feb 4, 2019

@shoyer - I know we've made some steps towards addressing some of this issue (e.g. #1752, #1803). What do you think it would take to make that the coding module public API?

@jhamman jhamman removed the stale label Feb 4, 2019
@shoyer
Copy link
Member Author

shoyer commented Feb 4, 2019

I think the eventual interface we want is something like this:

  • CF decoding in open_dataset is controlled by a coders argument, which takes a list of coders to apply in order.
  • CF encoding in to_netcdf is also controlled by a coders argument, which takes a list of coders to apply in reversed order.
  • Helper functions (get_coders()?) make it easy to construct the default coders, e.g., with boolean options for disabling particular coders.

To complete this, we'll need to get all CF encoding/decoding happening in Coder classes. VariableCoder might not suffice -- we also need a way to indicate transformations of a full dataset (e.g., for coding/decoding coordinates).

Eventually, it should be possible to read a dataset without any CF decoding (e.g., by setting coders=[]).

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
Development

No branches or pull requests

2 participants