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

Yasmine shouldn't accept other files import than stationXML #4

Open
jmsaurel opened this issue Mar 1, 2022 · 6 comments
Open

Yasmine shouldn't accept other files import than stationXML #4

jmsaurel opened this issue Mar 1, 2022 · 6 comments
Labels
enhancement New feature or request

Comments

@jmsaurel
Copy link
Collaborator

jmsaurel commented Mar 1, 2022

Because yasmine backend uses ObsPy, the file import support all the metadata files supported by ObsPy read_inventory.
This includes stationXML, but also some version of the SeisComP inventoryXML, dataless and probably some others.

Except stationXML, the other format are partly supported or support is limited to some version.

Yasmine should reject any file that is not a stationXML.

@jmsaurel jmsaurel added the enhancement New feature or request label Mar 1, 2022
@rcasey-earthscope
Copy link
Collaborator

An interesting thought. What will be gained by having Yasmine limit the kinds of metadata files that can be imported? Is it that some formats are not complete? I wonder if that is an issue given that Yasmine would allow the user to fill in the additional information?

The main thing I am thinking of is that seismic metadata comes in a number of different forms and historically, users all have their favorite format, or are trying to convert from one format to another. Would we be closing the door on that feature?

@autumnjohnson
Copy link
Contributor

I don't think you would be closing the door because validation of additional file types may be added when that time comes.

The only way to tell if an XML file is StationXML is to validate it against the StationXML schema. Would someone ever want to import or save an invalid StationXML file that they then continue to work on or edit in the GUI later?

@jmsaurel
Copy link
Collaborator Author

jmsaurel commented Mar 7, 2022

What will be gained by having Yasmine limit the kinds of metadata files that can be imported?

Less weird cases and questions to answer.

So far, we never looked at or though about how to handle other formats at the import into Yasmine.
This idea came when a colleague complained that the import of his XML failed : it was in fact an inventoryXML from SeisComP, in a version not yet supported by ObsPy and Yasmine.

Maybe we could just add one more disclaimer to say that Yasmine using ObsPy, it supports the import of other types of metadata, but we cannot guarantee anything about something else than the stationXML.

@rcasey-earthscope
Copy link
Collaborator

rcasey-earthscope commented Mar 8, 2022 via email

@autumnjohnson
Copy link
Contributor

autumnjohnson commented Mar 8, 2022

Okay. And, just to be clear: it would be easy enough to limit what files we support with ObsPy's command: read_inventory(..).format("STATIONXML")

@rcasey-earthscope
Copy link
Collaborator

Okay, so we leave this as a desired feature, limit import explicitly to StationXML and make sure it's documented so the user understands.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
enhancement New feature or request
Projects
None yet
Development

No branches or pull requests

3 participants