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 missing note about CDF-5 format #1044

Merged
merged 3 commits into from Jul 23, 2018
Merged

add missing note about CDF-5 format #1044

merged 3 commits into from Jul 23, 2018

Conversation

wkliao
Copy link
Contributor

@wkliao wkliao commented Jul 6, 2018

The PR adds information about the CDF-5 format in user documents.
I also propose to use "classic format" to refer CDF-1, 2, and 5 format.
Hope this is acceptable for the NetCDF community.

@edhartnett
Copy link
Contributor

In all the other docs, "classic" means CDF-1 only.

@wkliao
Copy link
Contributor Author

wkliao commented Jul 6, 2018

It is a proposal. If we agree, those documents can be revised accordingly.
Any suggestion that we don't end up saying "classic, 64-bit offset, and CDF-5" all over the places?

@edhartnett
Copy link
Contributor

I guess I would call those the CDF formats, if I were referring to them collectively.

@wkliao
Copy link
Contributor Author

wkliao commented Jul 6, 2018

That is a good suggestion. We can use it when referring a file format.
As for referring models, I can see "classic model" is used to refer CDF-1 and 2 (vs. "enhanced model" for HDF5). Do we want to keep "classic model" and include CDF-5 or just replace it with "CDF model"?

@edhartnett
Copy link
Contributor

Well I noticed that the CDF5 model is not actually the classic model, it includes some data types from the enhanced model.

So I would say that CDF1 and 2 used the classic model, and CDF5 uses classic model plus extra atomic types.

@wkliao
Copy link
Contributor Author

wkliao commented Jul 6, 2018

To me, a data model is about the objects/structures that can be represented in a file.

In NetCDF-C tutorial, The NetCDF Data Model points out the classic model consists of variables, dimensions, and attributes, while the enhanced model adds two additional components: groups and user-defined types. The CDF-5 shares the same 3 components with the classic model and none from the enhanced model.

@WardF
Copy link
Member

WardF commented Jul 9, 2018

I think this represents a point we're going to need to clarify in the documentation; since the variable types represented with CDF5 are different than those in the 'classic' model, we have to differentiate and make it clear that those files using CDF5-enabled variable types are not 'classic netcdf model' in the typical use of the term. To that end, we need to come up with a new identifier; perhaps classic+CDF5? I'm just back from PTO, sorry, that isn't very good, let me warm my brain up. But the larger point, I think, is that we do need to differentiate and not just lump CDF5 in with 'classic'.

@WardF WardF added this to the 4.7.0 milestone Jul 9, 2018
@WardF WardF self-assigned this Jul 9, 2018
@WardF WardF merged commit d6ed282 into Unidata:master Jul 23, 2018
@wkliao wkliao deleted the doc-cdf5 branch September 15, 2018 16:24
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

Successfully merging this pull request may close these issues.

None yet

3 participants