rs-station / reciprocalspaceship

Tools for exploring reciprocal space
https://rs-station.github.io/reciprocalspaceship/
MIT License
28 stars 12 forks source link

Add `is_polar()` utility for classifying polar space groups #176

Closed JBGreisman closed 2 years ago

JBGreisman commented 2 years ago

Aligning maps of isomorphous structures can benefit from classifying polar space groups. This is useful for distinguishing which cases have a discrete set of alternative origins vs. continuous alternatives (see #174).

This PR implements a reciprocalspaceship.utils.is_polar() utility function that classifies a space group as polar. This function is tested against the 530 spacegroup settings in sgtbx.

codecov-commenter commented 2 years ago

Codecov Report

Merging #176 (baaea46) into main (379bd9e) will increase coverage by 0.00%. The diff coverage is 100.00%.

@@           Coverage Diff           @@
##             main     #176   +/-   ##
=======================================
  Coverage   98.31%   98.31%           
=======================================
  Files          44       44           
  Lines        1718     1724    +6     
=======================================
+ Hits         1689     1695    +6     
  Misses         29       29           
Flag Coverage Δ
unittests 98.31% <100.00%> (+<0.01%) :arrow_up:

Flags with carried forward coverage won't be shown. Click here to find out more.

Impacted Files Coverage Δ
reciprocalspaceship/utils/__init__.py 100.00% <100.00%> (ø)
reciprocalspaceship/utils/asu.py 100.00% <100.00%> (ø)
reciprocalspaceship/utils/phases.py 100.00% <100.00%> (ø)
reciprocalspaceship/utils/symmetry.py 100.00% <100.00%> (ø)

Help us with your feedback. Take ten seconds to tell us how you rate us. Have a feature suggestion? Share it here.