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

Please keep namespaces separate #58

Closed
jsaul opened this issue Jul 1, 2019 · 1 comment
Closed

Please keep namespaces separate #58

jsaul opened this issue Jul 1, 2019 · 1 comment

Comments

@jsaul
Copy link

jsaul commented Jul 1, 2019

Currently the version 3 of libmseed implements a new data format also known under the name "next generation format" or "NGF" [1], following discussions within FDSN Working Group 2, and more recently also under the name "extended miniSEED" or "xSEED" by IRIS [2]. While "NGF" was chosen as a temporary name to avoid confusion with miniSEED, "xSEED" seems like a brilliant name for the new format, as it nicely symbolizes an extension of the SEED family of data formats.

Naming the new data format (NGF, xSEED, miniSEED3, ...) consistently as "xSEED" offers several advantages:

  • Ensure coherency in the naming of the various "SEED" family members.

  • Avoid the ambiguous use of the name "mseed" or "miniSEED" for two very different formats and supporting libraries.

  • Have two separate libraries libmseed and libxseed.

The current use of the name "libmseed" for a library supporting current miniSEED in version 2 and xSEED/NGF in version 3 is not only confusing but also problematic from a technical point of view. Continuation of the version 2 currently takes place somewhat hidden within a branch of libmseed. Whereas the main branch (version 3) libmseed is not compatible with most software that once adopted libmseed in good faith. Using the same name for two different libraries will also make linking against both at least cumbersome if not impossible, whereas separate libmseed and libxseed would allow to more cleanly distinguish between the two libraries and link against both wherever needed.

[1] FDSN/miniSEED3-TechnicalEvaluation#26
[2] https://iris-edu.github.io/xseed-specification

@chad-earthscope
Copy link
Contributor

The FDSN has not decided on what the name of the new format shall be, most of this is moot until that is decided.

Regarding different versions of the library for different formats, it may help to understand that:

  • version 3 of the library supports both formats, it is a superset of version 2 in functionality.

  • given that, the use cases for needing both versions of the library are vanishingly narrow. Porting to version 3 API is required, but after that, version 2 should not be needed by an application.

  • the two formats are quite similar in fit, form, function and will likely be used side by side for a long time. Supporting them seamlessly is necessary and with the branding already established is very valuable. The vast majority of users will not care which is used, just that it works. From this perspective, splitting the name of the library is not only unnecessary but is probably more confusing and more work than it's worth.

Continuation of the version 2 currently takes place somewhat hidden within a branch of libmseed.

It is far from hidden, releases will remain, along with future versions, on the releases page: https://github.com/iris-edu/libmseed/releases.

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