Skip to content

[JOSS] Summary target lay audience better #59

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

Closed
platipodium opened this issue May 27, 2023 · 5 comments
Closed

[JOSS] Summary target lay audience better #59

platipodium opened this issue May 27, 2023 · 5 comments

Comments

@platipodium
Copy link

In your summary section, make sure that it is understandable to people who do not know what netCDF is. This need only a little elaboration.

@platipodium
Copy link
Author

@robertjwilson
Copy link
Member

I've just added a better statement for non-netCDF users. 043cd79

The main issue I'm trying to get across is that netCDF files aren't like csv, and you don't need to reinvent the wheel each time you work with them. This is probably poorly understood outside of groups that work with them all the time.

"Files typically represent spatiotemporal data, such as atmospheric or oceanic temperatures. In contrast to other data formats, such as csv, netCDF files are self-describing and typically follow universally agreed conventions for coordinate names and file structure etc. As a result, it is possible to write software that can work with almost all netCDF files that follow those conventions, and there is no automatic need to burden users with the need to identify the names given to coordinates such as time with the files themselves. A key consequence is that software can carry out operations, such as calculating spatial averages, in one line of code that might otherwise require users to write multiple lines of code, and for these operations to largely work on any netCDF file."

The fact that nctoolkit is more format agnostic than xarray is a plus that could maybe be mentioned explicitly, but I'll maybe avoid that as xarray could easily evolve and make any statement false.

@malmans2
Copy link

FYI, this xarray accessor might be relevant: https://cf-xarray.readthedocs.io

It decodes CF conventions, so things like ds.cf.mean(("X", "Y")) or ds.cf.mean(("latitude", "longitude")) work on any dataset, regardless of the arbitrary variable names used.

@robertjwilson
Copy link
Member

robertjwilson commented Jul 25, 2023

Hi @malmans2. I had that package in mind when I was talking about how xarray could evolve.

I've just added a quick sentence to the paper mentioning cf-xarray.

"This ecosystem also includes specialist software such as xesmf for processes such as regridding and cf-xarray which makes xarray more format-agnostic."

@platipodium
Copy link
Author

Thanks, closed as sufficiently addressed.

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

No branches or pull requests

3 participants