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

Add more metadata to grid file #10

Open
dschwoerer opened this issue Nov 26, 2021 · 2 comments
Open

Add more metadata to grid file #10

dschwoerer opened this issue Nov 26, 2021 · 2 comments

Comments

@dschwoerer
Copy link
Collaborator

Should we include the version of zoidberg in the grid files?

@ZedThree
Copy link
Member

I've spent a fair bit of time this week reading various metadata conventions. My opinion is that we should add the following as global attributes to every file we create:

  • title: something like BOUT++ grid file
  • software_name: zoidberg
  • software_version: full version
  • date_created: ISO 8601 timestamp of this run
  • id: a UUID for this run

And possibly the following:

  • netcdf_version: This is nc_inq_libvers() or netCDF4.getlibversion()
  • Conventions: URL of units/normalisations documentation (not sure this actually exists, but it should!)
  • references: DOI of zoidberg/BOUT++
  • comment: human-friendly description of this run, e.g. W7-X shot #1234

All variables in the file may have the following attributes:

  • units: SI units
  • long_name: human-friendly description

I've based this mostly on the netCDF and CF metadata conventions.

@ZedThree
Copy link
Member

ZedThree commented Feb 1, 2022

Partly done in #13

@dschwoerer dschwoerer changed the title Add zoidberg version to grid file? Add more metadata to grid file Dec 11, 2024
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

2 participants