-
Notifications
You must be signed in to change notification settings - Fork 11
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 document for "application/netcdf" media type registration #45
Open
ethanrd
wants to merge
3
commits into
Unidata:main
Choose a base branch
from
ethanrd:media-type-registration
base: main
Could not load branches
Branch not found: {{ refName }}
Loading
Could not load tags
Nothing to show
Loading
Are you sure you want to change the base?
Some commits from the old base branch may be removed from the timeline,
and old review comments may become outdated.
Open
Changes from all commits
Commits
Show all changes
3 commits
Select commit
Hold shift + click to select a range
File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,94 @@ | ||
# Application for registration of Media Types | ||
|
||
## Type name: | ||
application | ||
|
||
## Subtype name: | ||
netcdf -- Standards tree (no prefix) | ||
|
||
## Required parameters: | ||
N/A | ||
|
||
## Optional parameters: | ||
N/A | ||
|
||
Or include a "version" parameter? | ||
- Supported values: "3" and "4" | ||
- Or supported values: "CDF-1", "CDF-2", "CDF-5", and "netCDF-4" | ||
|
||
## Encoding considerations: | ||
binary | ||
|
||
## Security considerations: | ||
(See https://www.rfc-editor.org/rfc/rfc6838.html#section-4.6) | ||
|
||
- no provision for directives that institute actions on a recipient's files or other resources | ||
- Need to review HDF5-UDF: https://hdf5-udf.readthedocs.io/en/latest/ | ||
- HDF5-UDF is an application (?) that supports writing and reading executable code in HDF5 files. Not a function of the file format. So perhaps mention of it is not needed here. | ||
- no provision for directives that lead to disclosure of information | ||
- highlight opportunity for use of compression, highlight that the application layer: netCDF handles decompression on data access | ||
- no need for services for security assurance | ||
|
||
## Interoperability considerations: | ||
|
||
There are two main versions of the netCDF file format, netCDF-3 and netCDF-4, with three minor versions of netCDF-3 and several minor versions(?) of netCDF-4. Current implementations (C and Java libraries) support (automatically identify and handle) all variations. | ||
|
||
Byte ordering is always big endian in netCDF-3 data files. In netCDF-4/HDF5 files, the byte ordering is determined at write time (usually the native form of the writing machine) and stored in the data file. | ||
|
||
(Details on byte order are given in the specifications. So perhaps not needed here.) | ||
|
||
## Published specification: | ||
(See https://www.rfc-editor.org/rfc/rfc6838.html#section-4.10) | ||
|
||
The netCDF file formats are specified in the NetCDF User's Guide (NUG). See the NetCDF File Formats section. | ||
|
||
Both NASA and the Open Geospatial Consortium (OGC) have approved/accepted the netCDF standard. See | ||
- the NASA netCDF Classic page: https://earthdata.nasa.gov/esdis/eso/standards-and-references/netcdf-classic | ||
- the NASA netCDF-4 page: https://earthdata.nasa.gov/esdis/eso/standards-and-references/netcdf-4hdf5-file-format | ||
- the OGC netCDF standards page: https://www.ogc.org/standards/netcdf | ||
|
||
Used by CMIP - reference? | ||
NOAA use for GOES data, reference? | ||
Also WMO efforts? | ||
|
||
Other references: | ||
- G. Davis and R. Rew, "Data Management: NetCDF: an Interface for Scientific Data Access" in IEEE Computer Graphics and Applications, vol. 10, no. 04, pp. 76-82, 1990. https://doi.org/10.1109/38.56302 | ||
|
||
## Applications that use this media type: | ||
- scientific data sharing | ||
- multidimensional arrays of numerical data | ||
|
||
## Fragment identifier considerations: | ||
- no fragment identifier considerations | ||
|
||
## Additional information: | ||
- Deprecated alias names for this type: | ||
- application/x-netcdf | ||
- Magic number(s): | ||
- ‘C’, ‘D’, ‘F’, ‘\001’ at start of file - classic format (CDF-1) | ||
- ‘C’, ‘D’, ‘F’, ‘\002’ at start of file - 64-bit offset format (CDF-2) | ||
- ‘C’, ‘D’, ‘F’, ‘\005’ at start of file - 64-bit data format (CDF-5) | ||
- ‘\211’, ‘H’, ‘D’, ‘F’, ‘\r’, ‘\n’, ‘\032’, ‘\n’ | ||
at start of file (?) - netCDF-4/HDF5 | ||
- File extension(s): .nc, .cdf, .nc3, .nc4 | ||
- Macintosh file type code(s): | ||
|
||
## Person & email address to contact for further information: | ||
|
||
## Intended usage: | ||
Common | ||
|
||
## Restrictions on usage: | ||
no restrictions on usage | ||
|
||
## Author: | ||
|
||
## Change controller: | ||
|
||
## Provisional registration? (standards tree only): | ||
(See https://www.rfc-editor.org/rfc/rfc6838.html#section-5.2.1) | ||
|
||
NOTE: Given registration/standardization might take time, a request can be made to place a media type name on a provisional registry so it can be used for testing and development. See provisional registry: https://www.iana.org/assignments/provisional-standard-media-types/provisional-standard-media-types.xhtml | ||
|
||
## Other Information or Comments | ||
(Any other information that the author deems interesting may be added below this line.) |
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Given how the different versions are actually different encodings (and not backward compatible) if I understand correctly, a version parameter would be very useful, since it's essential for client/server content negotiation.