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

Restore the default value to the _geom_*.site_symmetry_* items #362

Closed
vaitkus opened this issue Apr 3, 2023 · 4 comments · Fixed by #426
Closed

Restore the default value to the _geom_*.site_symmetry_* items #362

vaitkus opened this issue Apr 3, 2023 · 4 comments · Fixed by #426

Comments

@vaitkus
Copy link
Collaborator

vaitkus commented Apr 3, 2023

During the discussion in #58 it was decided to remove almost all default enumeration values due to them being potentially misleading. However, I would like to propose to restore the default value of 1_555 to the _geom_*.site_symmetry_* data items (e.g. _geom_angle.site_symmetry_1, _geom_hbond.site_symmetry_A, _geom_torsion.site_symmetry_3).

This value indicates that no translation nor symmetry operations were applied and therefore seems like a natural default (it matches the "I know nothing about the symmetry so I will do nothing about the symmetry" approach). Furthemore, data provided in geometry loops is almost always supplementary (i.e. derivable from the coordinates) and thus incorrect assignment of the default does not lead to a serious misinterpretation of the data (or at least to an easily detectable misinterpretation). There are at least two more good reasons to restore the default.

Firstly, there is a well established practice by some popular crystallographic software programs to omit the site symmetry item if all of the looped values are the default value (this practice is probably still ongoing). As a result, the removal of the default values from the dictionary made a large corpus of legacy CIF files a bit more ambiguous when interpreted under DDLm (missing is no longer equal to 1_555).

Secondly, since the site symmetry items serve as category loop keys and have the Encode purpose, the missing key values cannot be automatically elided during the validation process. Having a default values would remediate this.

I understand that the decision on the removal of default values might be final, but I just had to ask before making any sweeping changes to the legacy files (e.g. introducing site symmetry items populated with the default 1_555 values).

@jamesrhester
Copy link
Contributor

I think you make reasonable arguments. I would like to run this past the core CIF group, just for good form as I doubt there will be any objections.

@vaitkus
Copy link
Collaborator Author

vaitkus commented Apr 7, 2023

The core CIF group discussion can be found at https://www.iucr.org/__data/iucr/lists/coredmg/msg00460.html.

@vaitkus
Copy link
Collaborator Author

vaitkus commented Jun 19, 2023

Can this be considered accepted given that there were no objections from core CIF group for over 2 months?

@jamesrhester
Copy link
Contributor

Yes.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging a pull request may close this issue.

2 participants