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

Document the GVRS file format, introduce some revisions #26

Closed
gwlucastrig opened this issue Sep 24, 2022 · 2 comments
Closed

Document the GVRS file format, introduce some revisions #26

gwlucastrig opened this issue Sep 24, 2022 · 2 comments

Comments

@gwlucastrig
Copy link
Owner

gwlucastrig commented Sep 24, 2022

I am currently writing a specification document for the GVRS File Format. To document the GVRS format, I am converting my hand-written notes into a Word document and adding text to clarify the underlying concepts.

Changes to the GVRS format
One of the consequences of this kind of review is that has revealed a few shortcomings in the existing specification. Therefore, I am also making changes to some aspects of the format. The revised format will be designated version 1.4. The Java-based API will be changing to write data in the new format. So far, I have been able to maintain the ability for the API to read files written in the 1.2 format. Frankly, I am not really sure that maintaining backwards compatibility is worth the effort. So far, the GVRS user base remains very small and I am unaware of anyone who has invested effort in creating GVRS data products.

I welcome feedback regarding this issue. If you have any questions about the GVRS format, please let me know.

As a preview, I've attached one of the diagrams from the document to illustrate the overall structure of the GVRS format.
Layout1a

@gwlucastrig
Copy link
Owner Author

gwlucastrig commented Oct 27, 2022

I have posted a preliminary draft of the GVRS file format specification version 1.4.

You may view it at https://gwlucastrig.github.io/GridfourDocs/notes/GvrsFileFormat_1_04.pdf

In conjunction with this effort, I am preparing a new release of the GVRS software.

Finally, the document is a preliminary draft. If you find any errors (technical or typographical), or have suggestions for improvements, please let me know.

Thanks.

Gary

@gwlucastrig
Copy link
Owner Author

The Version 1.0.4 release of Gridfour includes the updates to the grid format specification.

With the Gridfour 1.0.4 release, version 1.4 of the GVRS file format will be treated as stable going forward. The API will continue to support the earlier 1.2 version of the file format on a read-only basis. But that feature may be retired in the future.

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

1 participant