-
Notifications
You must be signed in to change notification settings - Fork 82
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
[registry] AVS .fld data files #333
Conversation
BTW, I'd be happy to have AVSfldIO.jl housed under JuliaIO. Please advise. |
Yes, it should be v1.9.0 since it's a new feature. But given that there're also other new formats registered as pending PRs, it's better to modify the version number outside of these PRs as an independent commit. Can you revert the version change in Project.toml?
Adding minimal tests to FileIO could help make sure the future development of FileIO does not break the normal functionality of fld data read/write. BTW, 100% coverage is usually a "fake" number as the coverage test only count if this line gets called:
Yes, I think a header check is needed as a detector. See comments in : #222 (comment)
ping @IanButterworth, do we need to invite @JeffFessler as a member first? |
Codecov Report
@@ Coverage Diff @@
## master #333 +/- ##
=======================================
Coverage 88.01% 88.01%
=======================================
Files 10 10
Lines 626 626
=======================================
Hits 551 551
Misses 75 75
Continue to review full report at Codecov.
|
@johnnychen94 I realized that actually this format does have magic bytes, namely "# AVS" so I have updated the PR to include that. So now I think that no further header check is needed. |
A good question... The current situation from my understanding is that some add tests and some don't. I prefer to have tests because it makes things more reliable. People add |
@@ -0,0 +1,9 @@ | |||
# AVS field file (ascii variant) |
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.
Just a question. Does all AVS field file has this # AVS
?
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.
Every one that I have seen. This format was never blessed by any standards organization and I have been unable to find online documentation of it. (I learned the format from a paper manual before the WWW existed!) So I think we will not find any 100% definitive answer to the question.
I already added a comment about this assumption in the long README here:
https://github.com/JeffFessler/AVSfldIO.jl
That README is probably more complete documentation than you will find anywhere on the web!
It is trivial to add that header if someone (1) has a file without it and (2) wants to read it with Julia.
If at some later point there is someone who has a big pile of the data format without that header then I am happy to write a fancier format detector function if needed.
I have added the query test in the most recent commit.
I also changed the format name from "FLD" to "AVSfld" to be more specific.
This PR adds support for AVS .fld data files, using the new library
https://github.com/JeffFessler/AVSfldIO.jl
(File format etc. is documented there with links to many software frameworks that support it.)
The library is in the middle of the 3-day waiting period for the registry.
I have 100% code coverage in the library but I'm unsure if I need to add any tests to FileIO.jl.
Update: I added magic bytes.