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

Compare the contents of the parsed CIF files #5

Open
vaitkus opened this issue Nov 9, 2021 · 1 comment
Open

Compare the contents of the parsed CIF files #5

vaitkus opened this issue Nov 9, 2021 · 1 comment

Comments

@vaitkus
Copy link
Member

vaitkus commented Nov 9, 2021

It was suggested a few years ago by Marcin Wojdyr that it might be interesting to compare not only the behaviour of the various CIF parsers, but also to check if the parsed content is understood in the same way. This could be done by outputting the parsed data in some common format (e.g. CIF, CIF-JSON) and comparing it with the reference output.

This seems like a time-consuming endeavour, but it might reveal some additional discrepancies in the way certain rarer syntactic constructs are handled. The initial step could be to implement the comparison for a single chosen parser and document the main features of the expected output format (e.g. CIF file with all tags ordered in alphabetical order, etc/). This would serve as a useful example for other developers who would be willing to implement something similar for the CIF parsers that they maintain.

@merkys
Copy link
Member

merkys commented Nov 10, 2021

I think this is a great idea. Not only would it display the differences in CIF data comprehension, but in CIF writing as well. Pretty-printing CIF outputs to make them comparable might be performed for example using COD CIF writer. By the way, not all CIF parsers have CIF writing capabilities, though.

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