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

Restrict the values of _atom_site_moment_Fourier.wave_vector_seq_id #69

Conversation

vaitkus
Copy link
Collaborator

@vaitkus vaitkus commented Feb 6, 2024

This PR redefines the _atom_site_moment_Fourier.wave_vector_seq_id from Text to a non-negative Integer since such values are expected by various symmform data items (see definition of _atom_site_moment_Fourier_param.cos_symmform and the following comment #67 (comment)).

The non-negative enumeration range of 0: was taken from the definition of the linked _atom_site_Fourier_wave_vector.seq_id data item from the Modulation dictionary. However, I am not completely sure if the authors intended to include 0 into the set of allowed integers or simply though that the enumeration range is exclusive. Please let me know if this should be redefined to exclude the 0.

The values were restricted to non-negative integers since a numeric identifier
values is used when constructing various symmform data item values
(see `_atom_site_moment_Fourier_param.cos_symmform`, 4th component).

The definition range of 0: was taken from the definition of the linked
`_atom_site_Fourier_wave_vector.seq_id` data item from the Modulation
dictionary, however, restricting the range to only positive integers might
also make sense.
@vaitkus vaitkus marked this pull request as ready for review February 6, 2024 17:29
@vaitkus vaitkus requested a review from jamesrhester February 6, 2024 17:29
@brantonc
Copy link
Collaborator

brantonc commented Feb 6, 2024 via email

@jamesrhester
Copy link
Contributor

I will consult with the MS cif people to check what the current usage is.

@jamesrhester
Copy link
Contributor

Gotzon advises that starting from '1' is desirable for this data name.

@vaitkus
Copy link
Collaborator Author

vaitkus commented Feb 15, 2024

Gotzon advises that starting from '1' is desirable for this data name.

Ok, I updated the range to 1:0 in this PR and also made a similar PR in the msCIF dictionary repository (COMCIFS/Modulated_Structures#22).

@jamesrhester jamesrhester merged commit bd9ebdc into COMCIFS:main Feb 15, 2024
2 checks passed
@vaitkus vaitkus deleted the restrict-atom-site-moment-Fourier-wave-vector-seq-id-to-int branch February 16, 2024 09:19
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

Successfully merging this pull request may close these issues.

3 participants