# -*- coding: utf-8 -*-
"""
# Third-party code. No Schrodinger Copyright.
*GSASIIspc: Space group module*
-------------------------------
Space group interpretation routines. Note that space group information is
stored in a :ref:`Space Group (SGData)<SGData_table>` object.
"""
########### SVN repository information ###################
# $Date: 2019-09-20 15:45:35 -0400 (Fri, 20 Sep 2019) $
# $Author: vondreele $
# $Revision: 4157 $
# $URL: https://subversion.xray.aps.anl.gov/pyGSAS/trunk/GSASIIspc.py $
# $Id: GSASIIspc.py 4157 2019-09-20 19:45:35Z vondreele $
########### SVN repository information ###################
# flake8: noqa
import copy
import os.path as ospath
import sys
import numpy as np
import numpy.linalg as nl
import scipy.optimize as so
npsind = lambda x: np.sin(x * np.pi / 180.)
npcosd = lambda x: np.cos(x * np.pi / 180.)
nxs = np.newaxis
twopi = 2.0 * np.pi
DEBUG = False
################################################################################
#### Space group codes
################################################################################
[docs]def SpcGroup(SGSymbol):
    """
    Determines cell and symmetry information from a short H-M space group name
    :param SGSymbol: space group symbol (string) with spaces between axial fields
    :returns: (SGError,SGData)
       * SGError = 0 for no errors; >0 for errors (see SGErrors below for details)
       * SGData - is a dict (see :ref:`Space Group object<SGData_table>`) with entries:
             * 'SpGrp': space group symbol, slightly cleaned up
             * 'SGFixed': True if space group data can not be changed, e.g. from magnetic cif; otherwise False
             * 'SGGray': True if 1' in symbol - gray group for mag. incommensurate phases
             * 'SGLaue':  one of '-1', '2/m', 'mmm', '4/m', '4/mmm', '3R',
               '3mR', '3', '3m1', '31m', '6/m', '6/mmm', 'm3', 'm3m'
             * 'SGInv': boolean; True if centrosymmetric, False if not
             * 'SGLatt': one of 'P', 'A', 'B', 'C', 'I', 'F', 'R'
             * 'SGUniq': one of 'a', 'b', 'c' if monoclinic, '' otherwise
             * 'SGCen': cell centering vectors [0,0,0] at least
             * 'SGOps': symmetry operations as [M,T] so that M*x+T = x'
             * 'SGSys': one of 'triclinic', 'monoclinic', 'orthorhombic',
               'tetragonal', 'rhombohedral', 'trigonal', 'hexagonal', 'cubic'
             * 'SGPolax': one of ' ', 'x', 'y', 'x y', 'z', 'x z', 'y z',
               'xyz', '111' for arbitrary axes
             * 'SGPtGrp': one of 32 point group symbols (with some permutations), which
                is filled by SGPtGroup, is external (KE) part of supersymmetry point group
             * 'SSGKl': default internal (Kl) part of supersymmetry point group; modified
                in supersymmetry stuff depending on chosen modulation vector for Mono & Ortho
             * 'BNSlattsym': BNS lattice symbol & cenering op - used for magnetic structures
    """
    LaueSym = ('-1', '2/m', 'mmm', '4/m', '4/mmm', '3R', '3mR', '3', '3m1',
               '31m', '6/m', '6/mmm', 'm3', 'm3m')
    LattSym = ('P', 'A', 'B', 'C', 'I', 'F', 'R')
    UniqSym = (
        '',
        '',
        'a',
        'b',
        'c',
        '',
    )
    SysSym = ('triclinic', 'monoclinic', 'orthorhombic', 'tetragonal',
              'rhombohedral', 'trigonal', 'hexagonal', 'cubic')
    SGData = {}
    if len(SGSymbol.split()) < 2:
        return SGErrors(0), SGData
    if ':R' in SGSymbol:
        SGSymbol = SGSymbol.replace(
            ':',
            ' ')  #get rid of ':' in R space group symbols from some cif files
    SGData['SGGray'] = False
    if "1'" in SGSymbol:  #set for incommensurate magnetic
        SGData['SGGray'] = True
        SGSymbol = SGSymbol.replace("1'", '')
    SGSymbol = SGSymbol.split(':')[
        0]  #remove :1/2 setting symbol from some cif files
    if '-2' in SGSymbol:  #replace bad but legal symbols with correct equivalents
        SGSymbol = SGSymbol.replace('-2', 'm')
    if SGSymbol.split()[1] == '3/m':
        SGSymbol = SGSymbol.replace('3/m', '-6')
    import pyspg
    SGInfo = pyspg.sgforpy(SGSymbol)
    SGData['SpGrp'] = SGSymbol.strip().lower().capitalize()
    SGData['SGLaue'] = LaueSym[SGInfo[0] - 1]
    SGData['SGInv'] = bool(SGInfo[1])
    SGData['SGLatt'] = LattSym[SGInfo[2] - 1]
    SGData['SGUniq'] = UniqSym[SGInfo[3] + 1]
    SGData['SGFixed'] = False
    SGData['SGOps'] = []
    SGData['SGGen'] = []
    for i in range(SGInfo[5]):
        Mat = np.array(SGInfo[6][i])
        Trns = np.array(SGInfo[7][i])
        SGData['SGOps'].append([Mat, Trns])
        if 'array' in str(type(SGInfo[8])):  #patch for old fortran bin?
            SGData['SGGen'].append(int(SGInfo[8][i]))
    SGData['BNSlattsym'] = [LattSym[SGInfo[2] - 1], [0, 0, 0]]
    lattSpin = []
    if SGData['SGLatt'] == 'P':
        SGData['SGCen'] = np.array(([0, 0, 0],))
    elif SGData['SGLatt'] == 'A':
        SGData['SGCen'] = np.array(([0, 0, 0], [0, .5, .5]))
        lattSpin += [
            1,
        ]
    elif SGData['SGLatt'] == 'B':
        SGData['SGCen'] = np.array(([0, 0, 0], [.5, 0, .5]))
        lattSpin += [
            1,
        ]
    elif SGData['SGLatt'] == 'C':
        SGData['SGCen'] = np.array(([0, 0, 0], [
            .5,
            .5,
            0,
        ]))
        lattSpin += [
            1,
        ]
    elif SGData['SGLatt'] == 'I':
        SGData['SGCen'] = np.array(([0, 0, 0], [.5, .5, .5]))
        lattSpin += [
            1,
        ]
    elif SGData['SGLatt'] == 'F':
        SGData['SGCen'] = np.array(([0, 0, 0], [0, .5, .5], [.5, 0, .5], [
            .5,
            .5,
            0,
        ]))
        lattSpin += [1, 1, 1, 1]
    elif SGData['SGLatt'] == 'R':
        SGData['SGCen'] = np.array(
            ([0, 0, 0], [2. / 3, 1. / 3, 1. / 3], [1. / 3, 2. / 3, 2. / 3]))
    if SGData['SGInv']:
        if SGData['SGLaue'] in ['-1', '2/m', 'mmm']:
            Ibar = 7
        elif SGData['SGLaue'] in ['4/m', '4/mmm']:
            Ibar = 1
        elif SGData['SGLaue'] in [
                '3R', '3mR', '3', '3m1', '31m', '6/m', '6/mmm'
        ]:
            Ibar = 15  #8+4+2+1
        else:
            Ibar = 4
        Ibarx = Ibar & 14
    else:
        Ibarx = 8
        if SGData['SGLaue'] in ['-1', '2/m', 'mmm', 'm3', 'm3m']:
            Ibarx = 0
    moregen = []
    for i, gen in enumerate(SGData['SGGen']):
        if SGData['SGLaue'] in ['m3', 'm3m']:
            if gen in [1, 2, 4]:
                SGData['SGGen'][i] = 4
            elif gen < 7:
                SGData['SGGen'][i] = 0
        elif SGData['SGLaue'] in [
                '4/m', '4/mmm', '3R', '3mR', '3', '3m1', '31m', '6/m', '6/mmm'
        ]:
            if gen == 2:
                SGData['SGGen'][i] = 4
            elif gen in [3, 5]:
                SGData['SGGen'][i] = 3
            elif gen == 6:
                if SGData['SGLaue'] in ['4/m', '4/mmm']:
                    SGData['SGGen'][i] = 128
                else:
                    SGData['SGGen'][i] = 16
            elif not SGData['SGInv'] and gen == 12:
                SGData['SGGen'][i] = 8
            elif (not SGData['SGInv']) and (SGData['SGLaue'] in [
                    '3', '3m1', '31m', '6/m', '6/mmm'
            ]) and (gen == 1):
                SGData['SGGen'][i] = 24
        gen = SGData['SGGen'][i]
        if gen == 99:
            gen = 8
            if SGData['SGLaue'] in ['3m1', '31m', '6/m', '6/mmm']:
                gen = 3
            elif SGData['SGLaue'] == 'm3m':
                gen = 12
            SGData['SGGen'][i] = gen
        elif gen == 98:
            gen = 8
            if SGData['SGLaue'] in ['3m1', '31m', '6/m', '6/mmm']:
                gen = 4
            SGData['SGGen'][i] = gen
        elif not SGData['SGInv'] and gen in [
                23,
        ] and SGData['SGLaue'] in ['m3', 'm3m']:
            SGData['SGGen'][i] = 24
        elif gen >= 16 and gen != 128:
            if not SGData['SGInv']:
                gen = 31
            else:
                gen ^= Ibarx
            SGData['SGGen'][i] = gen
        if SGData['SGInv']:
            if gen < 128:
                moregen.append(SGData['SGGen'][i] ^ Ibar)
            else:
                moregen.append(1)
    SGData['SGGen'] += moregen
    if SGData['SGLaue'] in '-1':
        SGData['SGSys'] = SysSym[0]
    elif SGData['SGLaue'] in '2/m':
        SGData['SGSys'] = SysSym[1]
    elif SGData['SGLaue'] in 'mmm':
        SGData['SGSys'] = SysSym[2]
    elif SGData['SGLaue'] in ['4/m', '4/mmm']:
        SGData['SGSys'] = SysSym[3]
    elif SGData['SGLaue'] in ['3R', '3mR']:
        SGData['SGSys'] = SysSym[4]
    elif SGData['SGLaue'] in ['3', '3m1', '31m']:
        SGData['SGSys'] = SysSym[5]
    elif SGData['SGLaue'] in ['6/m', '6/mmm']:
        SGData['SGSys'] = SysSym[6]
    elif SGData['SGLaue'] in ['m3', 'm3m']:
        SGData['SGSys'] = SysSym[7]
    SGData['SGPolax'] = SGpolar(SGData)
    SGData['SGPtGrp'], SGData['SSGKl'] = SGPtGroup(SGData)
    if SGData['SGLatt'] == 'R':
        if SGData['SGPtGrp'] in [
                '3',
        ]:
            SGData['SGSpin'] = 3 * [
                1,
            ]
        elif SGData['SGPtGrp'] in ['-3', '32', '3m']:
            SGData['SGSpin'] = 4 * [
                1,
            ]
        elif SGData['SGPtGrp'] in [
                '-3m',
        ]:
            SGData['SGSpin'] = 5 * [
                1,
            ]
    else:
        if SGData['SGPtGrp'] in [
                '1',
                '3',
                '23',
        ]:
            SGData['SGSpin'] = lattSpin + [
                1,
            ]
        elif SGData['SGPtGrp'] in [
                '-1', '2', 'm', '4', '-4', '-3', '312', '321', '3m1', '31m',
                '6', '-6', '432', '-43m'
        ]:
            SGData['SGSpin'] = lattSpin + [
                1,
                1,
            ]
        elif SGData['SGPtGrp'] in [
                '2/m', '4/m', '422', '4mm', '-42m', '-4m2', '-3m1', '-31m',
                '6/m', '622', '6mm', '-6m2', '-62m', 'm3', 'm3m'
        ]:
            SGData['SGSpin'] = lattSpin + [
                1,
                1,
                1,
            ]
        else:  #'222'-'mmm','4/mmm','6/mmm'
            SGData['SGSpin'] = lattSpin + [
                1,
                1,
                1,
                1,
            ]
    return SGInfo[-1], SGData 
[docs]def SGErrors(IErr):
    '''
    Interprets the error message code from SpcGroup. Used in SpaceGroup.
    :param IErr: see SGError in :func:`SpcGroup`
    :returns:
        ErrString - a string with the error message or "Unknown error"
    '''
    ErrString = [
        ' ',
        'Less than 2 operator fields were found',
        'Illegal Lattice type, not P, A, B, C, I, F or R',
        'Rhombohedral lattice requires a 3-axis',
        'Minus sign does not preceed 1, 2, 3, 4 or 6',
        'Either a 5-axis anywhere or a 3-axis in field not allowed',
        ' ',
        'I for COMPUTED GO TO out of range.',
        'An a-glide mirror normal to A not allowed',
        'A b-glide mirror normal to B not allowed',
        'A c-glide mirror normal to C not allowed',
        'D-glide in a primitive lattice not allowed',
        'A 4-axis not allowed in the 2nd operator field',
        'A 6-axis not allowed in the 2nd operator field',
        'More than 24 matrices needed to define group',
        ' ',
        'Improper construction of a rotation operator',
        'Mirror following a / not allowed',
        'A translation conflict between operators',
        'The 2bar operator is not allowed',
        '3 fields are legal only in R & m3 cubic groups',
        'Syntax error. Expected I -4 3 d at this point',
        ' ',
        'A or B centered tetragonal not allowed',
        ' ',
        'unknown error in sgroup',
        ' ',
        ' ',
        ' ',
        'Illegal character in the space group symbol',
    ]
    try:
        return ErrString[IErr]
    except:
        return "Unknown error" 
[docs]def SGpolar(SGData):
    '''
    Determine identity of polar axes if any
    '''
    POL = ('', 'x', 'y', 'x y', 'z', 'x z', 'y z', 'xyz', '111')
    NP = [1, 2, 4]
    NPZ = [0, 1]
    for M, T in SGData['SGOps']:
        for i in range(3):
            if M[i][i] <= 0.:
                NP[i] = 0
        if M[0][2] > 0:
            NPZ[0] = 8
        if M[1][2] > 0:
            NPZ[1] = 0
    NPol = (NP[0] + NP[1] + NP[2] + NPZ[0] * NPZ[1]) * (1 -
                                                        int(SGData['SGInv']))
    return POL[NPol] 
[docs]def SGPtGroup(SGData):
    '''
    Determine point group of the space group - done after space group symbol has
    been evaluated by SpcGroup. Only short symbols are allowed
    :param SGData: from :func SpcGroup
    :returns: SSGPtGrp & SSGKl (only defaults for Mono & Ortho)
    '''
    Flds = SGData['SpGrp'].split()
    if len(Flds) < 2:
        return '', []
    if SGData['SGLaue'] == '-1':  #triclinic
        if '-' in Flds[1]:
            return '-1', [
                -1,
            ]
        else:
            return '1', [
                1,
            ]
    elif SGData[
            'SGLaue'] == '2/m':  #monoclinic - default for 2D modulation vector
        if '/' in SGData['SpGrp']:
            return '2/m', [-1, 1]
        elif '2' in SGData['SpGrp']:
            return '2', [
                -1,
            ]
        else:
            return 'm', [
                1,
            ]
    elif SGData['SGLaue'] == 'mmm':  #orthorhombic
        if SGData['SpGrp'].count('2') == 3:
            return '222', [-1, -1, -1]
        elif SGData['SpGrp'].count('2') == 1:
            if SGData['SGPolax'] == 'x':
                return '2mm', [-1, 1, 1]
            elif SGData['SGPolax'] == 'y':
                return 'm2m', [1, -1, 1]
            elif SGData['SGPolax'] == 'z':
                return 'mm2', [1, 1, -1]
        else:
            return 'mmm', [1, 1, 1]
    elif SGData['SGLaue'] == '4/m':  #tetragonal
        if '/' in SGData['SpGrp']:
            return '4/m', [1, -1]
        elif '-' in Flds[1]:
            return '-4', [
                -1,
            ]
        else:
            return '4', [
                1,
            ]
    elif SGData['SGLaue'] == '4/mmm':
        if '/' in SGData['SpGrp']:
            return '4/mmm', [1, -1, 1, 1]
        elif '-' in Flds[1]:
            if '2' in Flds[2]:
                return '-42m', [-1, -1, 1]
            else:
                return '-4m2', [-1, 1, -1]
        elif '2' in Flds[2:]:
            return '422', [1, -1, -1]
        else:
            return '4mm', [1, 1, 1]
    elif SGData['SGLaue'] in ['3', '3R']:  #trigonal/rhombohedral
        if '-' in Flds[1]:
            return '-3', [
                -1,
            ]
        else:
            return '3', [
                1,
            ]
    elif SGData['SGLaue'] == '3mR' or 'R' in Flds[0]:
        if '2' in Flds[2]:
            return '32', [1, -1]
        elif '-' in Flds[1]:
            return '-3m', [-1, 1]
        else:
            return '3m', [1, 1]
    elif SGData['SGLaue'] == '3m1':
        if '2' in Flds[2]:
            return '321', [1, -1, 1]
        elif '-' in Flds[1]:
            return '-3m1', [-1, 1, 1]
        else:
            return '3m1', [1, 1, 1]
    elif SGData['SGLaue'] == '31m':
        if '2' in Flds[3]:
            return '312', [1, 1, -1]
        elif '-' in Flds[1]:
            return '-31m', [-1, 1, 1]
        else:
            return '31m', [1, 1, 1]
    elif SGData['SGLaue'] == '6/m':  #hexagonal
        if '/' in SGData['SpGrp']:
            return '6/m', [1, -1]
        elif '-' in SGData['SpGrp']:
            return '-6', [
                -1,
            ]
        else:
            return '6', [
                1,
            ]
    elif SGData['SGLaue'] == '6/mmm':
        if '/' in SGData['SpGrp']:
            return '6/mmm', [1, -1, 1, 1]
        elif '-' in Flds[1]:
            if '2' in Flds[2]:
                return '-62m', [-1, -1, 1]
            else:
                return '-6m2', [-1, 1, -1]
        elif '2' in Flds[2:]:
            return '622', [1, -1, -1]
        else:
            return '6mm', [1, 1, 1]
    elif SGData['SGLaue'] == 'm3':  #cubic - no (3+1) supersymmetry
        if '2' in Flds[1]:
            return '23', []
        else:
            return 'm3', []
    elif SGData['SGLaue'] == 'm3m':
        if '4' in Flds[1]:
            if '-' in Flds[1]:
                return '-43m', []
            else:
                return '432', []
        else:
            return 'm3m', [] 
[docs]def SGPrint(SGData, AddInv=False):
    '''
    Print the output of SpcGroup in a nicely formatted way. Used in SpaceGroup
    :param SGData: from :func:`SpcGroup`
    :returns:
        SGText - list of strings with the space group details
        SGTable - list of strings for each of the operations
    '''
    if SGData.get('SGFixed', False):  #inverses included in ops for cif fixed
        Mult = len(SGData['SGCen']) * len(SGData['SGOps'])
    else:
        Mult = len(SGData['SGCen']) * len(
            SGData['SGOps']) * (int(SGData['SGInv']) + 1)
    SGText = []
    SGText.append(' Space Group: ' + SGData['SpGrp'])
    if SGData.get('SGGray', False):
        SGText[-1] += " 1'"
        if SGData.get('SGFixed', False):
            Mult //= 2
    CentStr = 'centrosymmetric'
    if not SGData['SGInv']:
        CentStr = 'non' + CentStr
    if SGData['SGLatt'] in 'ABCIFR':
        SGText.append(' The lattice is ' + CentStr + ' ' + SGData['SGLatt'] +
                      '-centered ' + SGData['SGSys'].lower())
    else:
        SGText.append(' The lattice is ' + CentStr + ' ' + 'primitive ' +
                      SGData['SGSys'].lower())
    SGText.append(' The Laue symmetry is ' + SGData['SGLaue'])
    if 'SGPtGrp' in SGData:  #patch
        SGText.append(' The lattice point group is ' + SGData['SGPtGrp'])
    SGText.append(' Multiplicity of a general site is ' + str(Mult))
    if SGData['SGUniq'] in ['a', 'b', 'c']:
        SGText.append(' The unique monoclinic axis is ' + SGData['SGUniq'])
    if SGData['SGInv']:
        SGText.append(' The inversion center is located at 0,0,0')
    if SGData['SGPolax']:
        SGText.append(' The location of the origin is arbitrary in ' +
                      SGData['SGPolax'])
    SGText.append(' ')
    if len(SGData['SGCen']) == 1:
        SGText.append(' The equivalent positions are:\n')
    else:
        SGText.append(' The equivalent positions are:\n')
        SGText.append(' (' + Latt2text(SGData['SGCen']) + ')+\n')
    SGTable = []
    for i, Opr in enumerate(SGData['SGOps']):
        SGTable.append('(%2d) %s' % (i + 1, MT2text(Opr)))
    if AddInv and SGData['SGInv']:
        for i, Opr in enumerate(SGData['SGOps']):
            IOpr = [-Opr[0], -Opr[1]]
            SGTable.append('(%2d) %s' % (i + 1, MT2text(IOpr)))
#    if SGData.get('SGGray',False) and not SGData.get('SGFixed',False):
#        SGTable.append("     for 1'")
#        for i,Opr in enumerate(SGData['SGOps']):
#            SGTable.append('(%2d) %s'%(i+1,MT2text(Opr)))
#        if AddInv and SGData['SGInv']:
#            for i,Opr in enumerate(SGData['SGOps']):
#                IOpr = [-Opr[0],-Opr[1]]
#                SGTable.append('(%2d) %s'%(i+1,MT2text(IOpr)))
    return SGText, SGTable 
[docs]def AllOps(SGData):
    '''
    Returns a list of all operators for a space group, including those for
    centering and a center of symmetry
    :param SGData: from :func:`SpcGroup`
    :returns: (SGTextList,offsetList,symOpList,G2oprList) where
      * SGTextList: a list of strings with formatted and normalized
        symmetry operators.
      * offsetList: a tuple of (dx,dy,dz) offsets that relate the GSAS-II
        symmetry operation to the operator in SGTextList and symOpList.
        these dx (etc.) values are added to the GSAS-II generated
        positions to provide the positions that are generated
        by the normalized symmetry operators.
      * symOpList: a list of tuples with the normalized symmetry
        operations as (M,T) values
        (see ``SGOps`` in the :ref:`Space Group object<SGData_table>`)
      * G2oprList: The GSAS-II operations for each symmetry operation as
        a tuple with (center,mult,opnum,opcode), where center is (0,0,0), (0.5,0,0),
        (0.5,0.5,0.5),...; where mult is 1 or -1 for the center of symmetry
        where opnum is the number for the symmetry operation, in ``SGOps``
        (starting with 0) and opcode is mult*(100*icen+j+1).
    '''
    SGTextList = []
    offsetList = []
    symOpList = []
    G2oprList = []
    G2opcodes = []
    onebar = (1,)
    if SGData['SGInv']:
        onebar += (-1,)
    for icen, cen in enumerate(SGData['SGCen']):
        for mult in onebar:
            for j, (M, T) in enumerate(SGData['SGOps']):
                offset = [0, 0, 0]
                Tprime = (mult * T) + cen
                for i in range(3):
                    while Tprime[i] < 0:
                        Tprime[i] += 1
                        offset[i] += 1
                    while Tprime[i] >= 1:
                        Tprime[i] += -1
                        offset[i] += -1
                Opr = [mult * M, Tprime]
                OPtxt = MT2text(Opr)
                SGTextList.append(OPtxt.replace(' ', ''))
                offsetList.append(tuple(offset))
                symOpList.append((mult * M, Tprime))
                G2oprList.append((cen, mult, j))
                G2opcodes.append(mult * (100 * icen + j + 1))
    return SGTextList, offsetList, symOpList, G2oprList, G2opcodes 
[docs]def TextOps(text, table, reverse=False):
    ''' Makes formatted operator list
        :param text,table: arrays of text made by SGPrint
        :param reverse: True for x+1/2 form; False for 1/2+x form
        :returns: OpText: full list of symmetry operators; one operation per line
        generally printed to console for use via cut/paste in other programs, but
        could be used for direct input
    '''
    OpText = []
    Inv = True
    if 'noncentro' in text[1]:
        Inv = False
    Cent = [
        [0, 0, 0],
    ]
    if '0,0,0' in text[-1]:
        Cent = np.array(eval(text[-1].split('+')[0].replace(';', '),(')))
    OpsM = []
    OpsT = []
    for item in table:
        if 'for' in item:
            continue
        M, T = Text2MT(item.split(')')[1].replace(' ', ''), CIF=True)
        OpsM.append(M)
        OpsT.append(T)
    OpsM = np.array(OpsM)
    OpsT = np.array(OpsT)
    if Inv:
        OpsM = np.concatenate((OpsM, -OpsM))
        OpsT = np.concatenate((OpsT, -OpsT % 1.))
    for cent in Cent:
        for iop, opM in enumerate(list(OpsM)):
            txt = MT2text([opM, (OpsT[iop] + cent[:3]) % 1.], reverse)
            OpText.append(txt.replace(' ', '').lower())
    return OpText 
[docs]def TextGen(SGData,
            reverse=False):  #does not always work correctly - not used anyway
    GenSym, GenFlg, BNSsym = GetGenSym(SGData)
    SGData['GenSym'] = GenSym
    SGData['GenFlg'] = GenFlg
    text, table = SGPrint(SGData)
    GenText = []
    OprNames = GetOprNames(SGData)
    OpText = TextOps(text, table, reverse)
    for name in SGData['GenSym']:
        gid = OprNames.index(name.replace(' ', ''))
        GenText.append(OpText[gid])
    if len(SGData['SGCen']) > 1:
        GenText.append(OpText[-1])
    return GenText 
[docs]def GetOprNames(SGData):
    OprNames = [GetOprPtrName(str(irtx)) for irtx in PackRot(SGData['SGOps'])]
    if SGData['SGInv']:
        OprNames += [
            GetOprPtrName(str(-irtx)) for irtx in PackRot(SGData['SGOps'])
        ]
    return OprNames 
[docs]def MT2text(Opr, reverse=False):
    "From space group matrix/translation operator returns text version"
    XYZ = ('-Z', '-Y', '-X', 'X-Y', 'ERR', 'Y-X', 'X', 'Y', 'Z')
    TRA = ('   ', 'ERR', '1/6', '1/4', '1/3', 'ERR', '1/2', 'ERR', '2/3', '3/4',
           '5/6', 'ERR')
    Fld = ''
    M, T = Opr
    for j in range(3):
        IJ = int(round(2 * M[j][0] + 3 * M[j][1] + 4 * M[j][2] + 4)) % 12
        IK = int(round(T[j] * 12)) % 12
        if IK:
            if IJ < 3:
                if reverse:
                    Fld += (XYZ[IJ] + '+' + TRA[IK]).rjust(5)
                else:
                    Fld += (TRA[IK] + XYZ[IJ]).rjust(5)
            else:
                if reverse:
                    Fld += (XYZ[IJ] + '+' + TRA[IK]).rjust(5)
                else:
                    Fld += (TRA[IK] + '+' + XYZ[IJ]).rjust(5)
        else:
            Fld += XYZ[IJ].rjust(5)
        if j != 2:
            Fld += ', '
    return Fld 
[docs]def Latt2text(Cen):
    "From lattice centering vectors returns ';' delimited cell centering vectors"
    lattTxt = ''
    fracList = [
        '1/2', '1/3', '2/3', '1/4', '3/4', '1/5', '2/5', '3/5', '4/5', '1/6',
        '5/6', '1/7', '2/7', '3/7', '4/7', '5/7', '6/7', '1/8', '3/8', '5/8',
        '7/8', '1/9', '2/9', '4/9', '5/9', '7/9', '8/9'
    ]
    mulList = [
        2, 3, 3, 4, 4, 5, 5, 5, 5, 6, 6, 7, 7, 7, 7, 7, 7, 8, 8, 8, 8, 9, 9, 9,
        9, 9, 9
    ]
    prodList = [
        1., 1., 2., 1., 3., 1., 2., 3., 4., 1., 5., 1., 2., 3., 4., 5., 6., 1.,
        3., 5., 7., 1., 2., 4., 5., 7., 8.
    ]
    nCen = len(Cen)
    for i, cen in enumerate(Cen):
        txt = ''
        for icen in cen:
            if icen == 1:
                txt += '1,'
                continue
            if not icen:
                txt += '0,'
                continue
            if icen < 0:
                txt += '-'
                icen *= -1
            for mul, prod, frac in zip(mulList, prodList, fracList):
                if abs(icen * mul - prod) < 1.e-5:
                    txt += frac + ','
                    break
        lattTxt += txt[:-1] + '; '
        if i and not i % 8 and i < nCen - 1:  #not for the last cen!
            lattTxt += '\n     '
    return lattTxt[:-2] 
[docs]def SpaceGroup(SGSymbol):
    '''
    Print the output of SpcGroup in a nicely formatted way.
    :param SGSymbol: space group symbol (string) with spaces between axial fields
    :returns: nothing
    '''
    E, A = SpcGroup(SGSymbol)
    if E > 0:
        print(SGErrors(E))
        return
    for l in SGPrint(A):
        print(l) 
################################################################################
#### Magnetic space group stuff
################################################################################
[docs]def SetMagnetic(SGData):
    GenSym, GenFlg, BNSsym = GetGenSym(SGData)
    SGData['GenSym'] = GenSym
    SGData['GenFlg'] = GenFlg
    OprNames, SpnFlp = GenMagOps(SGData)
    SGData['SpnFlp'] = SpnFlp
    SGData['MagSpGrp'] = MagSGSym(SGData) 
[docs]def GetGenSym(SGData):
    '''
    Get the space group generator symbols
    :param SGData: from :func:`SpcGroup`
    LaueSym = ('-1','2/m','mmm','4/m','4/mmm','3R','3mR','3','3m1','31m','6/m','6/mmm','m3','m3m')
    LattSym = ('P','A','B','C','I','F','R')
    '''
    OprNames = [GetOprPtrName(str(irtx)) for irtx in PackRot(SGData['SGOps'])]
    if SGData['SGInv']:
        OprNames += [
            GetOprPtrName(str(-irtx)) for irtx in PackRot(SGData['SGOps'])
        ]
    Nsyms = len(SGData['SGOps'])
    if SGData['SGInv'] and not SGData['SGFixed']:
        Nsyms *= 2
    UsymOp = [
        '1',
    ]
    OprFlg = [
        0,
    ]
    if Nsyms == 2:  #Centric triclinic or acentric monoclinic
        UsymOp.append(OprNames[1])
        OprFlg.append(SGData['SGGen'][1])
    elif Nsyms == 4:  #Point symmetry 2/m, 222, 22m, or 4
        if '4z' in OprNames[1]:  #Point symmetry 4 or -4
            UsymOp.append(OprNames[1])
            OprFlg.append(SGData['SGGen'][1])
        elif not SGData['SGInv']:  #Acentric Orthorhombic
            if 'm' in OprNames[1:4]:  #22m, 2m2 or m22
                if '2' in OprNames[1]:  #Acentric orthorhombic, 2mm
                    UsymOp.append(OprNames[2])
                    OprFlg.append(SGData['SGGen'][2])
                    UsymOp.append(OprNames[3])
                    OprFlg.append(SGData['SGGen'][3])
                elif '2' in OprNames[2]:  #Acentric orthorhombic, m2m
                    UsymOp.append(OprNames[1])
                    OprFlg.append(SGData['SGGen'][1])
                    UsymOp.append(OprNames[3])
                    OprFlg.append(SGData['SGGen'][3])
                else:  #Acentric orthorhombic, mm2
                    UsymOp.append(OprNames[1])
                    OprFlg.append(SGData['SGGen'][1])
                    UsymOp.append(OprNames[2])
                    OprFlg.append(SGData['SGGen'][2])
            else:  #Acentric orthorhombic, 222
                SGData['SGGen'][1:] = [4, 2, 1]
                UsymOp.append(OprNames[1])
                OprFlg.append(SGData['SGGen'][1])
                UsymOp.append(OprNames[2])
                OprFlg.append(SGData['SGGen'][2])
                UsymOp.append(OprNames[3])
                OprFlg.append(SGData['SGGen'][3])
        else:  #Centric Monoclinic
            UsymOp.append(OprNames[1])
            OprFlg.append(SGData['SGGen'][1])
            UsymOp.append(OprNames[3])
            OprFlg.append(SGData['SGGen'][3])
    elif Nsyms == 6:  #Point symmetry 32, 3m or 6
        if '6' in OprNames[1]:  #Hexagonal 6/m Laue symmetry
            UsymOp.append(OprNames[1])
            OprFlg.append(SGData['SGGen'][1])
        else:  #Trigonal
            UsymOp.append(OprNames[4])
            OprFlg.append(SGData['SGGen'][3])
            if '2110' in OprNames[1]:
                UsymOp[-1] = ' 2100 '
    elif Nsyms == 8:  #Point symmetry mmm, 4/m, or 422, etc
        if '4' in OprNames[1]:  #Tetragonal
            if SGData['SGInv']:  #4/m
                UsymOp.append(OprNames[1])
                OprFlg.append(SGData['SGGen'][1])
                UsymOp.append(OprNames[6])
                OprFlg.append(SGData['SGGen'][6])
            else:
                if 'x' in OprNames[4]:  #4mm type group
                    UsymOp.append(OprNames[4])
                    OprFlg.append(6)
                    UsymOp.append(OprNames[7])
                    OprFlg.append(8)
                else:  #-42m, -4m2, and 422 type groups
                    UsymOp.append(OprNames[5])
                    OprFlg.append(8)
                    UsymOp.append(OprNames[6])
                    OprFlg.append(19)
        else:  #Orthorhombic, mmm
            UsymOp.append(OprNames[1])
            OprFlg.append(SGData['SGGen'][1])
            UsymOp.append(OprNames[2])
            OprFlg.append(SGData['SGGen'][2])
            UsymOp.append(OprNames[7])
            OprFlg.append(SGData['SGGen'][7])
    elif Nsyms == 12 and '3' in OprNames[
            1] and SGData['SGSys'] != 'cubic':  #Trigonal
        UsymOp.append(OprNames[3])
        OprFlg.append(SGData['SGGen'][3])
        UsymOp.append(OprNames[9])
        OprFlg.append(SGData['SGGen'][9])
    elif Nsyms == 12 and '6' in OprNames[1]:  #Hexagonal
        if 'mz' in OprNames[9]:  #6/m
            UsymOp.append(OprNames[1])
            OprFlg.append(SGData['SGGen'][1])
            UsymOp.append(OprNames[6])
            OprFlg.append(SGData['SGGen'][6])
        else:  #6mm, -62m, -6m2 or 622
            UsymOp.append(OprNames[6])
            OprFlg.append(18)
            if 'm' in UsymOp[-1]:
                OprFlg[-1] = 20
            UsymOp.append(OprNames[7])
            OprFlg.append(24)
    elif Nsyms in [16, 24]:
        if '3' in OprNames[1]:
            UsymOp.append('')
            OprFlg.append(SGData['SGGen'][3])
            for i in range(Nsyms):
                if 'mx' in OprNames[i]:
                    UsymOp[-1] = OprNames[i]
                elif 'm11' in OprNames[i]:
                    UsymOp[-1] = OprNames[i]
                elif '211' in OprNames[i]:
                    UsymOp[-1] = OprNames[i]
                    OprFlg[-1] = 24
        else:  #4/mmm or 6/mmm
            UsymOp.append('  mz  ')
            OprFlg.append(1)
            if '4' in OprNames[1]:  #4/mmm
                UsymOp.append('  mx  ')
                OprFlg.append(20)
                UsymOp.append(' m110 ')
                OprFlg.append(24)
            else:  #6/mmm
                UsymOp.append(' m110 ')
                OprFlg.append(4)
                UsymOp.append(' m+-0 ')
                OprFlg.append(8)
    else:  #System is cubic
        if Nsyms == 48:
            UsymOp.append('  mx  ')
            OprFlg.append(4)
            UsymOp.append(' m110 ')
            OprFlg.append(24)
    if 'P' in SGData['SGLatt']:
        if SGData['SGSys'] == 'triclinic':
            BNSsym = {'P_a': [.5, 0, 0], 'P_b': [0, .5, 0], 'P_c': [0, 0, .5]}
        elif SGData['SGSys'] == 'monoclinic':
            BNSsym = {
                'P_a': [.5, 0, 0],
                'P_b': [0, .5, 0],
                'P_c': [0, 0, .5],
                'P_I': [.5, .5, .5]
            }
            if SGData['SGUniq'] == 'a':
                BNSsym.update({'P_B': [.5, 0, .5], 'P_C': [.5, .5, 0]})
            elif SGData['SGUniq'] == 'b':
                BNSsym.update({'P_A': [.5, .5, 0], 'P_C': [0, .5, .5]})
            elif SGData['SGUniq'] == 'c':
                BNSsym.update({'P_A': [0, .5, .5], 'P_B': [.5, 0, .5]})
        elif SGData['SGSys'] == 'orthorhombic':
            BNSsym = {
                'P_a': [.5, 0, 0],
                'P_b': [0, .5, 0],
                'P_c': [0, 0, .5],
                'P_A': [0, .5, .5],
                'P_B': [.5, 0, .5],
                'P_C': [.5, .5, 0],
                'P_I': [.5, .5, .5]
            }
        elif SGData['SGSys'] == 'tetragonal':
            BNSsym = {
                'P_c': [0, 0, .5],
                'P_C': [.5, .5, 0],
                'P_I': [.5, .5, .5]
            }
        elif SGData['SGSys'] in ['trigonal', 'hexagonal']:
            BNSsym = {'P_c': [0, 0, .5]}
        elif SGData['SGSys'] == 'cubic':
            BNSsym = {'P_I': [.5, .5, .5]}
    elif 'A' in SGData['SGLatt']:
        if SGData['SGSys'] == 'monoclinic':
            BNSsym = {}
            if SGData['SGUniq'] == 'b':
                BNSsym.update({'A_a': [.5, 0, 0], 'A_c': [0, 0, .5]})
            elif SGData['SGUniq'] == 'c':
                BNSsym.update({'A_a': [.5, 0, 0], 'A_b': [0, .5, 0]})
        elif SGData['SGSys'] == 'orthorhombic':
            BNSsym = {
                'A_a': [.5, 0, 0],
                'A_b': [0, .5, 0],
                'A_c': [0, 0, .5],
                'A_B': [.5, 0, .5],
                'A_C': [.5, .5, 0]
            }
        elif SGData['SGSys'] == 'triclinic':
            BNSsym = {'A_a': [.5, 0, 0], 'A_b': [0, .5, 0], 'A_c': [0, 0, .5]}
    elif 'B' in SGData['SGLatt']:
        if SGData['SGSys'] == 'monoclinic':
            BNSsym = {}
            if SGData['SGUniq'] == 'a':
                BNSsym.update({'B_b': [0, .5, 0], 'B_c': [0, 0, .5]})
            elif SGData['SGUniq'] == 'c':
                BNSsym.update({'B_a': [.5, 0, 0], 'B_b': [0, .5, 0]})
        elif SGData['SGSys'] == 'orthorhombic':
            BNSsym = {
                'B_a': [.5, 0, 0],
                'B_b': [0, .5, 0],
                'B_c': [0, 0, .5],
                'B_A': [0, .5, .5],
                'B_C': [.5, .5, 0]
            }
        elif SGData['SGSys'] == 'triclinic':
            BNSsym = {'B_a': [.5, 0, 0], 'B_b': [0, .5, 0], 'B_c': [0, 0, .5]}
    elif 'C' in SGData['SGLatt']:
        if SGData['SGSys'] == 'monoclinic':
            BNSsym = {}
            if SGData['SGUniq'] == 'a':
                BNSsym.update({'C_b': [0, .5, .0], 'C_c': [0, 0, .5]})
            elif SGData['SGUniq'] == 'b':
                BNSsym.update({
                    'C_a': [.5, 0, 0],
                    'C_c': [0, 0, .5],
                    'C_B': [.5, 0., .5]
                })
        elif SGData['SGSys'] == 'orthorhombic':
            BNSsym = {
                'C_a': [.5, 0, 0],
                'C_b': [0, .5, 0],
                'C_c': [0, 0, .5],
                'C_A': [0, .5, .5],
                'C_B': [.5, 0, .5]
            }
        elif SGData['SGSys'] == 'triclinic':
            BNSsym = {'C_a': [.5, 0, 0], 'C_b': [0, .5, 0], 'C_c': [0, 0, .5]}
    elif 'I' in SGData['SGLatt']:
        if SGData['SGSys'] in ['monoclinic', 'orthorhombic', 'triclinic']:
            BNSsym = {'I_a': [.5, 0, 0], 'I_b': [0, .5, 0], 'I_c': [0, 0, .5]}
        elif SGData['SGSys'] == 'tetragonal':
            BNSsym = {'I_c': [0, 0, .5]}
        elif SGData['SGSys'] == 'cubic':
            BNSsym = {}
    elif 'F' in SGData['SGLatt']:
        if SGData['SGSys'] in [
                'monoclinic', 'orthorhombic', 'cubic', 'triclinic'
        ]:
            BNSsym = {'F_S': [.5, .5, .5]}
    elif 'R' in SGData['SGLatt']:
        BNSsym = {'R_I': [0, 0, .5]}
    if SGData['SGGray']:
        for bns in BNSsym:
            BNSsym[bns].append(0.5)
    return UsymOp, OprFlg, BNSsym 
[docs]def ApplyBNSlatt(SGData, BNSlatt):
    Tmat = np.eye(3)
    BNS = BNSlatt[0]
    A = np.array(BNSlatt[1])
    Laue = SGData['SGLaue']
    SGCen = SGData['SGCen']
    if '_a' in BNS:
        Tmat[0, 0] = 2.0
    elif '_b' in BNS:
        Tmat[1, 1] = 2.0
    elif '_c' in BNS:
        Tmat[2, 2] = 2.0
    elif '_A' in BNS:
        Tmat[0, 0] = 2.0
    elif '_B' in BNS:
        Tmat[1, 1] = 2.0
    elif '_C' in BNS:
        Tmat[2, 2] = 2.0
    elif '_I' in BNS:
        Tmat *= 2.0
        if 'R' in Laue:
            SGData['SGSpin'][-1] = -1
        else:
            SGData['SGSpin'].append(-1)
    elif '_S' in BNS:
        SGData['SGSpin'][-1] = -1
        SGData['SGSpin'] += [
            -1,
            -1,
            -1,
        ]
        Tmat *= 2.0
    else:
        return Tmat
    SGData['SGSpin'].append(-1)  #BNS centering are spin invrsion
    C = SGCen + A[:3]
    SGData['SGCen'] = np.vstack((SGCen, C)) % 1.
    return Tmat 
[docs]def CheckSpin(isym, SGData):
    ''' Check for exceptions in spin rules
    '''
    if SGData['SGPtGrp'] in ['222', 'mm2', '2mm',
                             'm2m']:  #only 2/3 can be red; not 1/3 or 3/3
        if SGData['SGSpin'][1] * SGData['SGSpin'][2] * SGData['SGSpin'][3] < 0:
            SGData['SGSpin'][(isym + 1) % 3 + 1] *= -1
        if SGData['SpGrp'][0] == 'F' and isym > 2:
            SGData['SGSpin'][(isym + 1) % 3 + 3] == 1
    elif SGData['SGPtGrp'] == 'mmm':
        if SGData['SpGrp'][0] == 'F' and isym > 2:
            SGData['SGSpin'][(isym + 1) % 3 + 3] == 1 
[docs]def MagSGSym(SGData):  #needs to use SGPtGrp not SGLaue!
    SGLaue = SGData['SGLaue']
    if '1' not in SGData['GenSym']:  #patch for old gpx files
        SGData['GenSym'] = [
            '1',
        ] + SGData['GenSym']
        SGData['SGSpin'] = [
            1,
        ] + list(SGData['SGSpin'])
    if len(SGData['SGSpin']) < len(SGData['GenSym']):
        SGData['SGSpin'] = [
            1,
        ] + list(SGData['SGSpin'])  #end patch
    GenSym = SGData['GenSym'][1:]  #skip identity
    SpnFlp = SGData['SGSpin']
    #    print('SpnFlp',SpnFlp)
    SGPtGrp = SGData['SGPtGrp']
    if len(SpnFlp) == 1:
        SGData['MagPtGp'] = SGPtGrp
        return SGData['SpGrp']
    magSym = SGData['SpGrp'].split()
    if SGLaue in [
            '-1',
    ]:
        SGData['MagPtGp'] = SGPtGrp
        if SpnFlp[1] == -1:
            magSym[1] += "'"
            SGData['MagPtGp'] += "'"
    elif SGLaue in ['2/m', '4/m', '6/m']:  #all ok
        Uniq = {'a': 1, 'b': 2, 'c': 3, '': 1}
        Id = [0, 1]
        if len(magSym) > 2:
            Id = [0, Uniq[SGData['SGUniq']]]
        sym = magSym[Id[1]].split('/')
        Ptsym = SGLaue.split('/')
        if len(GenSym) == 3:
            for i in [0, 1, 2]:
                if SpnFlp[i + 1] < 0:
                    sym[i] += "'"
                    Ptsym[i] += "'"
        else:
            for i in range(len(GenSym)):
                if SpnFlp[i + 1] < 0:
                    sym[i] += "'"
                    Ptsym[i] += "'"
        SGData['MagPtGp'] = '/'.join(Ptsym)
        magSym[Id[1]] = '/'.join(sym)
    elif SGPtGrp in ['mmm', 'mm2', 'm2m', '2mm', '222']:
        SGData['MagPtGp'] = ''
        for i in [0, 1, 2]:
            SGData['MagPtGp'] += SGPtGrp[i]
            if SpnFlp[i + 1] < 0:
                magSym[i + 1] += "'"
                SGData['MagPtGp'] += "'"
    elif SGLaue == '6/mmm':  #ok
        magPtGp = list(SGPtGrp)
        if len(GenSym) == 2:
            for i in [0, 1]:
                if SpnFlp[i + 1] < 0:
                    magSym[i + 2] += "'"
                    magPtGp[i + 1] += "'"
            if SpnFlp[1] * SpnFlp[2] < 0:
                magSym[1] += "'"
                magPtGp[0] += "'"
        else:
            sym = magSym[1].split('/')
            Ptsym = ['6', 'm']
            magPtGp = ['', 'm', 'm']
            for i in [0, 1, 2]:
                if SpnFlp[i + 1] < 0:
                    if i:
                        magSym[i + 1] += "'"
                        magPtGp[i] += "'"
                    else:
                        sym[1] += "'"
                        Ptsym[0] += "'"
            if SpnFlp[2] * SpnFlp[3] < 0:
                sym[0] += "'"
                Ptsym[0] += "'"
            magSym[1] = '/'.join(sym)
            magPtGp[0] = '/'.join(Ptsym)
        SGData['MagPtGp'] = ''.join(magPtGp)
    elif SGLaue == '4/mmm':
        magPtGp = list(SGPtGrp)
        if len(GenSym) == 2:
            for i in [0, 1]:
                if SpnFlp[i + 1] < 0:
                    magSym[i + 2] += "'"
                    magPtGp[i + 1] += "'"
            if SpnFlp[1] * SpnFlp[2] < 0:
                magSym[1] += "'"
                magPtGp[0] += "'"
        else:
            if '/' in magSym[1]:  #P 4/m m m, etc.
                sym = magSym[1].split('/')
                Ptsym = ['4', 'm']
                magPtGp = ['', 'm', 'm']
                for i in [0, 1, 2]:
                    if SpnFlp[i + 1] < 0:
                        if i:
                            magSym[i + 1] += "'"
                            magPtGp[i] += "'"
                        else:
                            sym[1] += "'"
                            Ptsym[1] += "'"
                if SpnFlp[2] * SpnFlp[3] < 0:
                    sym[0] += "'"
                    Ptsym[0] += "'"
                magSym[1] = '/'.join(sym)
                magPtGp[0] = '/'.join(Ptsym)
            else:
                for i in [0, 1]:
                    if SpnFlp[i + 1] < 0:
                        magSym[i + 2] += "'"
                if SpnFlp[1] * SpnFlp[2] < 0:
                    magSym[1] += "'"
        SGData['MagPtGp'] = ''.join(magPtGp)
    elif SGLaue in ['3', '3m1', '31m']:  #ok
        Ptsym = list(SGPtGrp)
        if len(GenSym) == 1:  #all ok
            Id = 2
            if (len(magSym) == 4) and (magSym[2] == '1'):
                Id = 3
            if '3' in GenSym[0]:
                Id = 1
            magSym[Id].strip("'")
            if SpnFlp[1] < 0:
                magSym[Id] += "'"
                Ptsym[Id - 1] += "'"
        elif len(GenSym) == 2:
            if 'R' in GenSym[1]:
                magSym[-1].strip("'")
                if SpnFlp[1] < 0:
                    magSym[-1] += "'"
                    Ptsym[-1] += "'"
            else:
                i, j = [1, 2]
                if magSym[2] == '1':
                    i, j = [1, 3]
                magSym[i].strip("'")
                Ptsym[i - 1].strip("'")
                magSym[j].strip("'")
                Ptsym[j - 1].strip("'")
                if SpnFlp[1:3] == [1, -1]:
                    magSym[i] += "'"
                    Ptsym[i - 1] += "'"
                elif SpnFlp[1:3] == [-1, -1]:
                    magSym[j] += "'"
                    Ptsym[j - 1] += "'"
                elif SpnFlp[1:3] == [-1, 1]:
                    magSym[i] += "'"
                    Ptsym[i - 1] += "'"
                    magSym[j] += "'"
                    Ptsym[j - 1] += "'"
        elif len(GenSym):
            if 'c' not in magSym[2]:
                i, j = [1, 2]
                magSym[i].strip("'")
                Ptsym[i - 1].strip("'")
                magSym[j].strip("'")
                Ptsym[j - 1].strip("'")
                if SpnFlp[1:3] == [1, -1]:
                    magSym[i] += "'"
                    Ptsym[i - 1] += "'"
                elif SpnFlp[1:3] == [-1, -1]:
                    magSym[j] += "'"
                    Ptsym[j - 1] += "'"
                elif SpnFlp[2] == [-1, 1]:
                    magSym[i] += "'"
                    Ptsym[i - 1] += "'"
                    magSym[j] += "'"
                    Ptsym[j - 1] += "'"
        SGData['MagPtGp'] = ''.join(Ptsym)
    elif SGData['SGPtGrp'] == '23' and len(magSym):
        SGData['MagPtGp'] = '23'
    elif SGData['SGPtGrp'] == 'm3':
        SGData['MagPtGp'] = "m3"
        if SpnFlp[1] < 0:
            magSym[1] += "'"
            magSym[2] += "'"
            SGData['MagPtGp'] = "m'3'"
        if SpnFlp[1] < 0:
            if not 'm' in magSym[1]:  #only Ia3
                magSym[1].strip("'")
                SGData['MagPtGp'] = "m3'"
    elif SGData['SGPtGrp'] in ['432', '-43m']:
        Ptsym = SGData['SGPtGrp'].split('3')
        if SpnFlp[1] < 0:
            magSym[1] += "'"
            Ptsym[0] += "'"
            magSym[3] += "'"
            Ptsym[1] += "'"
        SGData['MagPtGp'] = '3'.join(Ptsym)
    elif SGData['SGPtGrp'] == 'm3m':
        Ptsym = ['m', '3', 'm']
        if SpnFlp[1:3] == [-1, 1]:
            magSym[1] += "'"
            Ptsym[0] += "'"
            magSym[2] += "'"
            Ptsym[1] += "'"
        elif SpnFlp[1:3] == [1, -1]:
            magSym[3] += "'"
            Ptsym[2] += "'"
        elif SpnFlp[1:3] == [-1, -1]:
            magSym[1] += "'"
            Ptsym[0] += "'"
            magSym[2] += "'"
            Ptsym[1] += "'"
            magSym[3] += "'"
            Ptsym[2] += "'"
        SGData['MagPtGp'] = ''.join(Ptsym)
#    print SpnFlp
    magSym[0] = SGData.get('BNSlattsym', [SGData['SGLatt'], [0, 0, 0]])[0]
    return ' '.join(magSym) 
[docs]def fixMono(SpGrp):
    'fixes b-unique monoclinics in e.g. P 1 2/1c 1 --> P 21/c '
    Flds = SpGrp.split()
    if len(Flds) == 4:
        if Flds[2] != '1':
            return '%s %s' % (Flds[0], Flds[2])
        else:
            return None
    else:
        return SpGrp 
[docs]def Trans2Text(Trans):
    "from transformation matrix to text"
    cells = ['a', 'b', 'c']
    Text = ''
    for row in Trans:
        Fld = ''
        for i in [0, 1, 2]:
            if row[i]:
                if Fld and row[i] > 0.:
                    Fld += '+'
                Fld += '%3.1f' % (row[i]) + cells[i]
        Text += Fld
        Text += ','
        Text = Text.replace('1.0', '').replace('.0', '').replace('0.5', '1/2')
    return Text[:-1] 
[docs]def getlattSym(Trans):
    Fives = {
        'ababc': 'abc',
        'bcbca': 'cba',
        'acacb': 'acb',
        'cabab': 'cab',
        'abcab': 'acb'
    }
    transText = Trans2Text(Trans)
    lattSym = ''
    for fld in transText.split(','):
        if 'a' in fld:
            lattSym += 'a'
        if 'b' in fld:
            lattSym += 'b'
        if 'c' in fld:
            lattSym += 'c'
    if len(lattSym) != 3:
        lattSym = 'abc'
#        lattSym = Fives[lattSym]
    return lattSym 
[docs]def Text2MT(mcifOpr, CIF=True):
    "From space group cif text returns matrix/translation"
    XYZ = {
        'x': [1, 0, 0],
        '+x': [1, 0, 0],
        '-x': [-1, 0, 0],
        'y': [0, 1, 0],
        '+y': [0, 1, 0],
        '-y': [0, -1, 0],
        'z': [0, 0, 1],
        '+z': [0, 0, 1],
        '-z': [0, 0, -1],
        'x-y': [1, -1, 0],
        '-x+y': [-1, 1, 0],
        'y-x': [-1, 1, 0],
        '+x-y': [1, -1, 0],
        '+y-x': [-1, 1, 0]
    }
    ops = mcifOpr.split(",")
    M = []
    T = []
    for op in ops[:3]:
        ip = len(op)
        if '/' in op:
            try:  #mcif format
                nP = op.count('+')
                opMT = op.split('+')
                T.append(eval(opMT[nP]))
                if nP == 2:
                    opMT[0] = '+'.join(opMT[0:2])
            except NameError:  #normal cif format
                ip = op.index('/')
                T.append(eval(op[:ip + 2]))
                opMT = [op[ip + 2:], '']
        else:
            opMT = [op, '']
            T.append(0.)
        M.append(XYZ[opMT[0].lower()])
    return np.array(M), np.array(T) 
[docs]def MagText2MTS(mcifOpr, CIF=True):
    "From magnetic space group cif text returns matrix/translation + spin flip"
    XYZ = {
        'x': [1, 0, 0],
        '+x': [1, 0, 0],
        '-x': [-1, 0, 0],
        'y': [0, 1, 0],
        '+y': [0, 1, 0],
        '-y': [0, -1, 0],
        'z': [0, 0, 1],
        '+z': [0, 0, 1],
        '-z': [0, 0, -1],
        'x-y': [1, -1, 0],
        '-x+y': [-1, 1, 0],
        'y-x': [-1, 1, 0],
        '+x-y': [1, -1, 0],
        '+y-x': [-1, 1, 0]
    }
    ops = mcifOpr.split(",")
    M = []
    T = []
    for op in ops[:3]:
        ip = len(op)
        if '/' in op:
            try:  #mcif format
                nP = op.count('+')
                opMT = op.split('+')
                T.append(eval(opMT[nP]))
                if nP == 2:
                    opMT[0] = '+'.join(opMT[0:2])
            except NameError:  #normal cif format
                ip = op.index('/')
                T.append(eval(op[:ip + 2]))
                opMT = [op[ip + 2:], '']
        else:
            opMT = [op, '']
            T.append(0.)
        M.append(XYZ[opMT[0].lower()])
    spnflp = 1
    if '-1' in ops[3]:
        spnflp = -1
    return np.array(M), np.array(T), spnflp 
[docs]def MagSSText2MTS(mcifOpr):
    "From magnetic super space group cif text returns matrix/translation + spin flip"
    XYZ = {
        'x1': [1, 0, 0, 0],
        '-x1': [-1, 0, 0, 0],
        'x2': [0, 1, 0, 0],
        '-x2': [0, -1, 0, 0],
        'x3': [0, 0, 1, 0],
        '-x3': [0, 0, -1, 0],
        'x4': [0, 0, 0, 1],
        '-x4': [0, 0, 0, -1],
        'x1-x2': [1, -1, 0, 0],
        '-x1+x2': [-1, 1, 0, 0],
        'x1-x4': [1, 0, 0, -1],
        '-x1+x4': [-1, 0, 0, 1],
        'x2-x4': [0, 1, 0, -1],
        '-x2+x4': [0, -1, 0, 1],
        '-x1-x2+x4': [-1, -1, 0, 1],
        'x1+x2-x4': [1, 1, 0, -1]
    }
    ops = mcifOpr.split(",")
    M = []
    T = []
    for op in ops[:4]:
        ip = len(op)
        if '/' in op:
            ip = op.index('/') - 2
            T.append(eval(op[ip:]))
        else:
            T.append(0.)
        M.append(XYZ[op[:ip]])
    spnflp = 1
    if '-1' in ops[4]:
        spnflp = -1
    return np.array(M), np.array(T), spnflp 
[docs]def GetSGSpin(SGData, MSgSym):
    'get spin generators from magnetic space group symbol'
    SpGrp = SGData['SpGrp']
    mSgSym = MSgSym + ' '
    Flds = SpGrp.split()
    iB = 0
    Spn = [
        1,
    ]  #for identity generator
    if len(Flds) == 2:  #-1,  2/m, 4/m & 6/m; 1 or 2 generators
        fld = Flds[1]
        iF = mSgSym[iB:].index(fld[0]) + iB
        jF = mSgSym[iF:].index(fld[-1]) + iF
        if '/' in mSgSym[iF:jF]:
            if "'" in mSgSym[iF:jF]:
                Spn.append(-1)
            else:
                Spn.append(1)
        if "'" == mSgSym[jF + 1]:
            Spn.append(-1)
        else:
            Spn.append(1)
    elif len(Flds) == 3:  # 3m & m3; 1 or 2 generator
        if SGData['SGPtGrp'] == '-3m':
            if not mSgSym.count("'"):
                Spn += [
                    1,
                    1,
                ]
            elif mSgSym.count("'") == 2:
                Spn += [
                    -1,
                    1,
                ]
            elif "3'" in mSgSym:
                Spn += [
                    1,
                    -1,
                ]
            else:
                Spn += [
                    -1,
                    -1,
                ]
        else:
            if "'" in mSgSym:  #could be 1 or 2 '; doesn't matter.
                Spn.append(-1)
            else:
                Spn.append(1)
    else:  #the rest; 3 generators. NB:  any ' before / in 1st field ignored
        for fld in Flds[1:]:
            iF = mSgSym[iB:].index(fld[0]) + iB
            jF = mSgSym[iF:].index(fld[-1]) + iF
            if "'" == mSgSym[jF + 1]:
                Spn.append(-1)
                iB = jF + 2
            else:
                Spn.append(1)
                iB = jF + 1
    Spn.append(1)
    return Spn 
[docs]def GenMagOps(SGData):
    FlpSpn = SGData['SGSpin']
    Nsym = len(SGData['SGOps'])
    Ncv = len(SGData['SGCen'])
    sgOp = [M for M, T in SGData['SGOps']]
    oprName = [GetOprPtrName(str(irtx)) for irtx in PackRot(SGData['SGOps'])]
    if SGData['SGInv'] and not SGData['SGFixed']:
        Nsym *= 2
        sgOp += [-M for M, T in SGData['SGOps']]
        oprName += [
            GetOprPtrName(str(-irtx)) for irtx in PackRot(SGData['SGOps'])
        ]
    Nsyms = 0
    sgOps = []
    OprNames = []
    for incv in range(Ncv):
        Nsyms += Nsym
        sgOps += sgOp
        OprNames += oprName
    if SGData['SGFixed']:
        SpnFlp = SGData['SpnFlp']
    else:
        SpnFlp = np.ones(Nsym, dtype=np.int)
        GenFlg = SGData.get('GenFlg', [0])
        Ngen = len(SGData['SGGen'])
        Nfl = len(GenFlg)
        for ieqv in range(Nsym):
            for iunq in range(Nfl):
                if SGData['SGGen'][ieqv % Ngen] & GenFlg[iunq]:
                    SpnFlp[ieqv] *= FlpSpn[iunq]
        for incv in range(Ncv):
            if incv:
                try:
                    SpnFlp = np.concatenate(
                        (SpnFlp, SpnFlp[:Nsym] * FlpSpn[Nfl + incv - 1]))
                except IndexError:
                    FlpSpn = [
                        1,
                    ] + FlpSpn
                    SpnFlp = np.concatenate(
                        (SpnFlp, SpnFlp[:Nsym] * FlpSpn[Nfl + incv - 1]))
    detM = [nl.det(M) for M in sgOp]
    MagMom = SpnFlp * np.array(Ncv * detM)  #duplicate for no. centerings
    SGData['MagMom'] = MagMom
    return OprNames, SpnFlp 
[docs]def GetOpNum(Opr, SGData):
    Nops = len(SGData['SGOps'])
    opNum = abs(Opr) % 100
    cent = abs(Opr) // 100
    if Opr < 0 and not SGData['SGFixed']:
        opNum += Nops
    if SGData['SGInv'] and not SGData['SGFixed']:
        Nops *= 2
    opNum += cent * Nops
    return opNum 
################################################################################
#### Superspace group codes
################################################################################
[docs]def SSpcGroup(SGData, SSymbol):
    """
    Determines supersymmetry information from superspace group name; currently only for (3+1) superlattices
    :param SGData: space group data structure as defined in SpcGroup above (see :ref:`SGData<SGData_table>`).
    :param SSymbol: superspace group symbol extension (string) defining modulation direction & generator info.
    :returns: (SSGError,SSGData)
       * SGError = 0 for no errors; >0 for errors (see SGErrors below for details)
       * SSGData - is a dict (see :ref:`Superspace Group object<SSGData_table>`) with entries:
             * 'SSpGrp': full superspace group symbol, accidental spaces removed; for display only
             * 'SSGCen': 4D cell centering vectors [0,0,0,0] at least
             * 'SSGOps': 4D symmetry operations as [M,T] so that M*x+T = x'
    """
    def fixMonoOrtho():
        mod = ''.join(modsym).replace('1/2', '0').replace('1', '0')
        if SGData['SGPtGrp'] in ['2', 'm']:  #OK
            if mod in ['a00', '0b0', '00g']:
                result = [i * -1 for i in SGData['SSGKl']]
            else:
                result = SGData['SSGKl'][:]
            if '/' in mod:
                return [i * -1 for i in result]
            else:
                return result
        elif SGData['SGPtGrp'] == '2/m':  #OK
            if mod in ['a00', '0b0', '00g']:
                result = SGData['SSGKl'][:]
            else:
                result = [i * -1 for i in SGData['SSGKl']]
            if '/' in mod:
                return [i * -1 for i in result]
            else:
                return result
        else:  #orthorhombic
            return [
                -SSGKl[i] if mod[i] in ['a', 'b', 'g'] else SSGKl[i]
                for i in range(3)
            ]
    def extendSSGOps(SSGOps):
        for OpA in SSGOps:
            OpAtxt = SSMT2text(OpA)
            if 't' not in OpAtxt:
                continue
            for OpB in SSGOps:
                OpBtxt = SSMT2text(OpB)
                if 't' not in OpBtxt:
                    continue
                OpC = list(SGProd(OpB, OpA))
                OpC[1] %= 1.
                OpCtxt = SSMT2text(OpC)
                #                print OpAtxt.replace(' ','')+' * '+OpBtxt.replace(' ','')+' = '+OpCtxt.replace(' ','')
                for k, OpD in enumerate(SSGOps):
                    OpDtxt = SSMT2text(OpD)
                    OpDtxt2 = ''
                    if SGData['SGGray']:
                        OpDtxt2 = SSMT2text(
                            [OpD[0], OpD[1] + np.array([0., 0., 0., .5])])
#                    print '    ('+OpCtxt.replace(' ','')+' = ? '+OpDtxt.replace(' ','')+')'
                    if OpCtxt == OpDtxt:
                        continue
                    elif OpCtxt == OpDtxt2:
                        continue
                    elif OpCtxt.split(',')[:3] == OpDtxt.split(',')[:3]:
                        if 't' not in OpDtxt:
                            SSGOps[k] = OpC
                            #                            print k,'   new:',OpCtxt.replace(' ','')
                            break
                        else:
                            OpCtxt = OpCtxt.replace(' ', '')
                            OpDtxt = OpDtxt.replace(' ', '')
                            Txt = OpCtxt + ' conflicts with ' + OpDtxt
                            #                            print (Txt)
                            return False, Txt
        return True, SSGOps
    def findMod(modSym):
        for a in ['a', 'b', 'g']:
            if a in modSym:
                return a
    def genSSGOps():
        SSGOps = SSGData['SSGOps'][:]
        iFrac = {}
        for i, frac in enumerate(SSGData['modSymb']):
            if frac in ['1/2', '1/3', '1/4', '1/6', '1']:
                iFrac[i] = frac + '.'
#        print SGData['SpGrp']+SSymbol
#        print 'SSGKl',SSGKl,'genQ',genQ,'iFrac',iFrac,'modSymb',SSGData['modSymb']
# set identity & 1,-1; triclinic
        SSGOps[0][0][3, 3] = 1.
        ## expand if centrosymmetric
        #        if SGData['SGInv']:
        #            SSGOps += [[-1*M,V] for M,V in SSGOps[:]]
        # monoclinic - all done & all checked
        if SGData['SGPtGrp'] in ['2', 'm']:  #OK
            SSGOps[1][0][3, 3] = SSGKl[0]
            SSGOps[1][1][3] = genQ[0]
            for i in iFrac:
                SSGOps[1][0][3, i] = -SSGKl[0]
        elif SGData['SGPtGrp'] == '2/m':  #OK
            SSGOps[1][0][3, 3] = SSGKl[1]
            if 's' in gensym:
                SSGOps[1][1][3] = 0.5
            for i in iFrac:
                SSGOps[1][0][3, i] = SSGKl[0]
# orthorhombic - all OK not fully checked
        elif SGData['SGPtGrp'] in ['222', 'mm2', 'm2m', '2mm']:  #OK
            if SGData['SGPtGrp'] == '222':
                OrOps = {
                    'g': {
                        0: [1, 3],
                        1: [2, 3]
                    },
                    'a': {
                        1: [1, 2],
                        2: [1, 3]
                    },
                    'b': {
                        2: [3, 2],
                        0: [1, 2]
                    }
                }  #OK
            elif SGData['SGPtGrp'] == 'mm2':
                OrOps = {
                    'g': {
                        0: [1, 3],
                        1: [2, 3]
                    },
                    'a': {
                        1: [2, 1],
                        2: [3, 1]
                    },
                    'b': {
                        0: [1, 2],
                        2: [3, 2]
                    }
                }  #OK
            elif SGData['SGPtGrp'] == 'm2m':
                OrOps = {
                    'b': {
                        0: [1, 2],
                        2: [3, 2]
                    },
                    'g': {
                        0: [1, 3],
                        1: [2, 3]
                    },
                    'a': {
                        1: [2, 1],
                        2: [3, 1]
                    }
                }  #OK
            elif SGData['SGPtGrp'] == '2mm':
                OrOps = {
                    'a': {
                        1: [2, 1],
                        2: [3, 1]
                    },
                    'b': {
                        0: [1, 2],
                        2: [3, 2]
                    },
                    'g': {
                        0: [1, 3],
                        1: [2, 3]
                    }
                }  #OK
            a = findMod(SSGData['modSymb'])
            OrFrac = OrOps[a]
            for j in iFrac:
                for i in OrFrac[j]:
                    SSGOps[i][0][3, j] = -2. * eval(iFrac[j]) * SSGKl[i - 1]
            for i in [0, 1, 2]:
                SSGOps[i + 1][0][3, 3] = SSGKl[i]
                SSGOps[i + 1][1][3] = genQ[i]
                E, SSGOps = extendSSGOps(SSGOps)
                if not E:
                    return E, SSGOps
        elif SGData['SGPtGrp'] == 'mmm':  #OK
            OrOps = {
                'g': {
                    0: [1, 3],
                    1: [2, 3]
                },
                'a': {
                    1: [2, 1],
                    2: [3, 1]
                },
                'b': {
                    0: [1, 2],
                    2: [3, 2]
                }
            }
            a = findMod(SSGData['modSymb'])
            if a == 'g':
                SSkl = [1, 1, 1]
            elif a == 'a':
                SSkl = [-1, 1, -1]
            else:
                SSkl = [1, -1, -1]
            OrFrac = OrOps[a]
            for j in iFrac:
                for i in OrFrac[j]:
                    SSGOps[i][0][3, j] = -2. * eval(iFrac[j]) * SSkl[i - 1]
            for i in [0, 1, 2]:
                SSGOps[i + 1][0][3, 3] = SSkl[i]
                SSGOps[i + 1][1][3] = genQ[i]
                E, SSGOps = extendSSGOps(SSGOps)
                if not E:
                    return E, SSGOps
# tetragonal - all done & checked
        elif SGData['SGPtGrp'] == '4':  #OK
            SSGOps[1][0][3, 3] = SSGKl[0]
            SSGOps[1][1][3] = genQ[0]
            if '1/2' in SSGData['modSymb']:
                SSGOps[1][0][3, 1] = -1
        elif SGData['SGPtGrp'] == '-4':  #OK
            SSGOps[1][0][3, 3] = SSGKl[0]
            if '1/2' in SSGData['modSymb']:
                SSGOps[1][0][3, 1] = 1
        elif SGData['SGPtGrp'] in [
                '4/m',
        ]:  #OK
            if '1/2' in SSGData['modSymb']:
                SSGOps[1][0][3, 1] = -SSGKl[0]
            for i, j in enumerate([1, 3]):
                SSGOps[j][0][3, 3] = 1
                if genQ[i]:
                    SSGOps[j][1][3] = genQ[i]
                E, SSGOps = extendSSGOps(SSGOps)
                if not E:
                    return E, SSGOps
        elif SGData['SGPtGrp'] in [
                '422',
                '4mm',
                '-42m',
                '-4m2',
        ]:  #OK
            iGens = [1, 4, 5]
            if SGData['SGPtGrp'] in [
                    '4mm',
                    '-4m2',
            ]:
                iGens = [1, 6, 7]
            for i, j in enumerate(iGens):
                if '1/2' in SSGData['modSymb'] and i < 2:
                    SSGOps[j][0][3, 1] = SSGKl[i]
                SSGOps[j][0][3, 3] = SSGKl[i]
                if genQ[i]:
                    if 's' in gensym and j == 6:
                        SSGOps[j][1][3] = -genQ[i]
                    else:
                        SSGOps[j][1][3] = genQ[i]
                E, SSGOps = extendSSGOps(SSGOps)
                if not E:
                    return E, SSGOps
        elif SGData['SGPtGrp'] in [
                '4/mmm',
        ]:  #OK
            if '1/2' in SSGData['modSymb']:
                SSGOps[1][0][3, 1] = -SSGKl[0]
                SSGOps[6][0][3, 1] = SSGKl[1]
                if modsym:
                    SSGOps[1][1][3] = -genQ[3]
            for i, j in enumerate([1, 2, 6, 7]):
                SSGOps[j][0][3, 3] = 1
                SSGOps[j][1][3] = genQ[i]
                E, Result = extendSSGOps(SSGOps)
                if not E:
                    return E, Result
                else:
                    SSGOps = Result
# trigonal - all done & checked
        elif SGData['SGPtGrp'] == '3':  #OK
            SSGOps[1][0][3, 3] = SSGKl[0]
            if '1/3' in SSGData['modSymb']:
                SSGOps[1][0][3, 1] = -1
            SSGOps[1][1][3] = genQ[0]
        elif SGData['SGPtGrp'] == '-3':  #OK
            SSGOps[1][0][3, 3] = -SSGKl[0]
            if '1/3' in SSGData['modSymb']:
                SSGOps[1][0][3, 1] = -1
            SSGOps[1][1][3] = genQ[0]
        elif SGData['SGPtGrp'] in ['312', '3m', '-3m', '-3m1', '3m1']:  #OK
            if '1/3' in SSGData['modSymb']:
                SSGOps[1][0][3, 1] = -1
            for i, j in enumerate([1, 5]):
                if SGData['SGPtGrp'] in ['3m', '-3m']:
                    SSGOps[j][0][3, 3] = 1
                else:
                    SSGOps[j][0][3, 3] = SSGKl[i + 1]
                if genQ[i]:
                    SSGOps[j][1][3] = genQ[i]
        elif SGData['SGPtGrp'] in ['321', '32']:  #OK
            for i, j in enumerate([1, 4]):
                SSGOps[j][0][3, 3] = SSGKl[i]
                if genQ[i]:
                    SSGOps[j][1][3] = genQ[i]
        elif SGData['SGPtGrp'] in ['31m', '-31m']:  #OK
            ids = [1, 3]
            if SGData['SGPtGrp'] == '-31m':
                ids = [1, 3]
            if '1/3' in SSGData['modSymb']:
                SSGOps[ids[0]][0][3, 1] = -SSGKl[0]
            for i, j in enumerate(ids):
                SSGOps[j][0][3, 3] = 1
                if genQ[i + 1]:
                    SSGOps[j][1][3] = genQ[i + 1]
# hexagonal all done & checked
        elif SGData['SGPtGrp'] == '6':  #OK
            SSGOps[1][0][3, 3] = SSGKl[0]
            SSGOps[1][1][3] = genQ[0]
        elif SGData['SGPtGrp'] == '-6':  #OK
            SSGOps[1][0][3, 3] = SSGKl[0]
        elif SGData['SGPtGrp'] in [
                '6/m',
        ]:  #OK
            SSGOps[1][0][3, 3] = -SSGKl[1]
            SSGOps[1][1][3] = genQ[0]
            SSGOps[2][1][3] = genQ[1]
        elif SGData['SGPtGrp'] in [
                '622',
        ]:  #OK
            for i, j in enumerate([1, 9, 8]):
                SSGOps[j][0][3, 3] = SSGKl[i]
                if genQ[i]:
                    SSGOps[j][1][3] = -genQ[i]
                E, SSGOps = extendSSGOps(SSGOps)
        elif SGData['SGPtGrp'] in [
                '6mm',
                '-62m',
                '-6m2',
        ]:  #OK
            for i, j in enumerate([1, 6, 7]):
                SSGOps[j][0][3, 3] = SSGKl[i]
                if genQ[i]:
                    SSGOps[j][1][3] = genQ[i]
                E, SSGOps = extendSSGOps(SSGOps)
        elif SGData['SGPtGrp'] in [
                '6/mmm',
        ]:  # OK
            for i, j in enumerate([1, 2, 10, 11]):
                SSGOps[j][0][3, 3] = 1
                if genQ[i]:
                    SSGOps[j][1][3] = genQ[i]
                E, SSGOps = extendSSGOps(SSGOps)
        elif SGData['SGPtGrp'] in ['1', '-1']:  #triclinic - done
            return True, SSGOps
        E, SSGOps = extendSSGOps(SSGOps)
        return E, SSGOps
    def specialGen(gensym, modsym):
        sym = ''.join(gensym)
        if SGData['SGPtGrp'] in [
                '2/m',
        ] and 'n' in SGData['SpGrp']:
            if 's' in sym:
                gensym = 'ss'
        if SGData['SGPtGrp'] in [
                '-62m',
        ] and sym == '00s':
            gensym = '0ss'
        elif SGData['SGPtGrp'] in [
                '222',
        ]:
            if sym == '00s':
                gensym = '0ss'
            elif sym == '0s0':
                gensym = 'ss0'
            elif sym == 's00':
                gensym = 's0s'
        elif SGData['SGPtGrp'] in [
                'mmm',
        ]:
            if 'g' in modsym:
                if sym == 's00':
                    gensym = 's0s'
                elif sym == '0s0':
                    gensym = '0ss'
            elif 'a' in modsym:
                if sym == '0s0':
                    gensym = 'ss0'
                elif sym == '00s':
                    gensym = 's0s'
            elif 'b' in modsym:
                if sym == '00s':
                    gensym = '0ss'
                elif sym == 's00':
                    gensym = 'ss0'
        return gensym
    Fracs = {
        '1/2': 0.5,
        '1/3': 1. / 3,
        '1': 1.0,
        '0': 0.,
        's': .5,
        't': 1. / 3,
        'q': .25,
        'h': -1. / 6,
        'a': 0.,
        'b': 0.,
        'g': 0.
    }
    if SGData['SGLaue'] in ['m3', 'm3m']:
        return '(3+1) superlattices not defined for cubic space groups', None
    elif SGData['SGLaue'] in ['3R', '3mR']:
        return '(3+1) superlattices not defined for rhombohedral settings - use hexagonal setting', None
    try:
        modsym, gensym = splitSSsym(SSymbol)
    except ValueError:
        return 'Error in superspace symbol ' + SSymbol, None
    modQ = [Fracs[mod] for mod in modsym]
    SSGKl = SGData['SSGKl'][:]
    if SGData['SGLaue'] in ['2/m', 'mmm']:
        SSGKl = fixMonoOrtho()
    Ngen = len(gensym)
    if SGData.get('SGGray', False):
        Ngen -= 1
    if len(gensym) and Ngen != len(SSGKl):
        return 'Wrong number of items in generator symbol ' + ''.join(
            gensym), None
    gensym = specialGen(gensym[:Ngen], modsym)
    genQ = [Fracs[mod] for mod in gensym[:Ngen]]
    if not genQ:
        genQ = [0, 0, 0, 0]
    SSgSpc = SGData['SpGrp'] + SSymbol
    if SGData['SGGray']:
        SSgSpc = SSgSpc.replace('(', " 1'(")
    SSGData = {
        'SSpGrp': SSgSpc,
        'modQ': modQ,
        'modSymb': modsym,
        'SSGKl': SSGKl
    }
    SSCen = np.zeros((len(SGData['SGCen']), 4))
    for icen, cen in enumerate(SGData['SGCen']):
        SSCen[icen, 0:3] = cen
    if 'BNSlattsym' in SGData and '_' in SGData['BNSlattsym'][0]:
        Ncen = len(SGData['SGCen'])
        for icen in range(Ncen // 2, Ncen):
            SSCen[icen, 3] = 0.5
    SSGData['SSGCen'] = SSCen % 1.
    SSGData['SSGOps'] = []
    for iop, op in enumerate(SGData['SGOps']):
        T = np.zeros(4)
        ssop = np.zeros((4, 4))
        ssop[:3, :3] = op[0]
        T[:3] = op[1]
        SSGData['SSGOps'].append([ssop, T])
    E, Result = genSSGOps()
    if E:
        SSGData['SSGOps'] = Result
        if DEBUG:
            print('Super spacegroup operators for ' + SSGData['SSpGrp'])
            for Op in Result:
                print(SSMT2text(Op).replace(' ', ''))
            if SGData['SGInv']:
                for Op in Result:
                    Op = [-Op[0], -Op[1] % 1.]
                    print(SSMT2text(Op).replace(' ', ''))
        return None, SSGData
    else:
        return Result + '\nOperator conflict - incorrect superspace symbol', None 
[docs]def SSChoice(SGData):
    '''
    Gets the unique set of possible super space groups for a given space group
    '''
    ptgpSS = {
        '1': ['(abg)',],
        '-1': ['(abg)',],
        '2': ['(a0g)', '(a1/2g)', '(0b0)', '(1/2b0)', '(0b1/2)', '(1/2b1/2)'],
        'm': ['(a0g)', '(a1/2g)', '(0b0)', '(1/2b0)', '(0b1/2)', '(1/2b1/2)'],
        '2/m': ['(a0g)', '(a1/2g)', '(0b0)', '(1/2b0)', '(0b1/2)', '(1/2b1/2)'],
        '222': [
            '(00g)',
            '(1/20g)',
            '(01/2g)',
            '(1/21/2g)',
            '(10g)',
            '(01g)',
            '(a00)',
            '(a1/20)',
            '(a01/2)',
            '(a1/21/2)',
            '(a10)',
            '(a01)',
            '(0b0)',
            '(1/2b0)',
            '(0b1/2)',
            '(1/2b1/2)',
            '(1b0)',
            '(0b1)',
        ],
        'mm2': [
            '(00g)',
            '(1/20g)',
            '(01/2g)',
            '(1/21/2g)',
            '(10g)',
            '(01g)',
            '(a00)',
            '(a1/20)',
            '(a01/2)',
            '(a1/21/2)',
            '(a10)',
            '(a01)',
            '(0b0)',
            '(1/2b0)',
            '(0b1/2)',
            '(1/2b1/2)',
            '(1b0)',
            '(0b1)',
        ],
        'm2m': [
            '(00g)',
            '(1/20g)',
            '(01/2g)',
            '(1/21/2g)',
            '(10g)',
            '(01g)',
            '(a00)',
            '(a1/20)',
            '(a01/2)',
            '(a1/21/2)',
            '(a10)',
            '(a01)',
            '(0b0)',
            '(1/2b0)',
            '(0b1/2)',
            '(1/2b1/2)',
            '(1b0)',
            '(0b1)',
        ],
        '2mm': [
            '(00g)',
            '(1/20g)',
            '(01/2g)',
            '(1/21/2g)',
            '(10g)',
            '(01g)',
            '(a00)',
            '(a1/20)',
            '(a01/2)',
            '(a1/21/2)',
            '(a10)',
            '(a01)',
            '(0b0)',
            '(1/2b0)',
            '(0b1/2)',
            '(1/2b1/2)',
            '(1b0)',
            '(0b1)',
        ],
        'mmm': [
            '(00g)',
            '(1/20g)',
            '(01/2g)',
            '(1/21/2g)',
            '(10g)',
            '(01g)',
            '(a00)',
            '(a1/20)',
            '(a01/2)',
            '(a1/21/2)',
            '(a10)',
            '(a01)',
            '(0b0)',
            '(1/2b0)',
            '(0b1/2)',
            '(1/2b1/2)',
            '(1b0)',
            '(0b1)',
        ],
        '4': ['(00g)', '(1/21/2g)'],
        '4mm': ['(00g)', '(1/21/2g)'],
        '4/m': ['(00g)', '(1/21/2g)'],
        '422': ['(00g)', '(1/21/2g)'],
        '-4m2': ['(00g)', '(1/21/2g)'],
        '-42m': ['(00g)', '(1/21/2g)'],
        '4/mmm': ['(00g)', '(1/21/2g)'],
        '3': ['(00g)', '(1/31/3g)'],
        '-3': ['(00g)', '(1/31/3g)'],
        '32': ['(00g)'],
        '3m': ['(00g)'],
        '-3m': ['(00g)'],
        '321': ['(00g)'],
        '3m1': ['(00g)'],
        '-3m1': ['(00g)'],
        '312': ['(00g)', '(1/31/3g)'],
        '31m': ['(00g)', '(1/31/3g)'],
        '-31m': ['(00g)', '(1/31/3g)'],
        '6': ['(00g)',],
        '6/m': ['(00g)',],
        '-62m': ['(00g)',],
        '-6m2': ['(00g)',],
        '622': ['(00g)',],
        '6/mmm': ['(00g)',],
        '6mm': ['(00g)',],
        '23': ['',],
        'm3': ['',],
        '432': ['',],
        '-43m': ['',],
        'm3m': ['',]
    }
    ptgpTS = {
        '1': ['0',],
        '-1': ['0',],
        '2': ['0', 's'],
        'm': ['0', 's'],
        '2/m': ['00', '0s', 'ss', 's0'],
        '222': [
            '000',
            's00',
            '0s0',
            '00s',
        ],
        'mm2': [
            '000', 's00', '0s0', '00s', 'ss0', 's0s', '0ss', 'q00', '0q0',
            '00q', '0qq', 'q0q', 'qq0'
        ],
        'm2m': [
            '000', 's00', '0s0', '00s', 'ss0', 's0s', '0ss', 'q00', '0q0',
            '00q', '0qq', 'q0q', 'qq0'
        ],
        '2mm': [
            '000', 's00', '0s0', '00s', 'ss0', 's0s', '0ss', 'q00', '0q0',
            '00q', '0qq', 'q0q', 'qq0'
        ],
        'mmm': [
            '000', 's00', '0s0', '00s', 'ss0', 's0s', '0ss', 'q00', '0q0',
            '00q', '0qq', 'q0q', 'qq0'
        ],
        '4': ['0', 'q', 's'],
        '4mm': ['000', 'q00', 's00', 's0s', 'ss0', '0ss', 'qq0', 'qqs'],
        '4/m': ['00', 's0'],
        '-4m2': ['000', '0s0', '0q0'],
        '-42m': ['000', '00s'],
        '422': ['000', 'q00', 's00', 's0s', 'ss0', '0ss', 'qq0', 'qqs', '0q0'],
        '4/mmm': ['0000', 's0s0', '00ss', 's00s', 'ss00', '0ss0', '0s0s'],
        '3': ['0', 't'],
        '-3': ['0', 't'],
        '32': ['00', 't0'],
        '3m': ['00', '0s'],
        '-3m': ['00', '0s'],
        '321': ['000', 't00'],
        '3m1': ['000', '0s0'],
        '-3m1': ['000', '0s0'],
        '312': ['000', 't00'],
        '31m': ['000', '00s'],
        '-31m': ['000', '00s'],
        '6': ['0', 'h', 't', 's'],
        '6/m': ['00', 's0'],
        '-62m': ['000', '00s'],
        '-6m2': ['000', '0s0'],
        '622': [
            '000',
            'h00',
            't00',
            's00',
        ],
        '6mm': [
            '000',
            'ss0',
            's0s',
            '0ss',
        ],
        '6/mmm': ['0000', 's0s0', '00ss', 's00s', 'ss00', '0ss0', '0s0s'],
        '23': ['',],
        'm3': ['',],
        '432': ['',],
        '-43m': ['',],
        'm3m': ['',]
    }
    ptgp = SGData['SGPtGrp']
    SSChoice = []
    for ax in ptgpSS[ptgp]:
        for sx in ptgpTS[ptgp]:
            SSChoice.append(ax + sx)
            if SGData['SGGray']:
                SSChoice[-1] += 's'
    ssChoice = []
    ssHash = []
    for item in SSChoice:
        E, SSG = SSpcGroup(SGData, item)
        if SSG:
            sshash = hash(str(SSGPrint(SGData, SSG)[1]))
            if sshash not in ssHash:
                ssHash.append(sshash)
                ssChoice.append(item)
    return ssChoice 
[docs]def splitSSsym(SSymbol):
    '''
    Splits supersymmetry symbol into two lists of strings
    '''
    mssym = SSymbol.replace(' ', '').split(')')
    if len(mssym) > 1:
        modsym, gensym = mssym
    else:
        modsym = mssym[0]
        gensym = ''
    modsym = modsym.replace(',', '')
    if "1'" in modsym:
        gensym = gensym[:-1]
    modsym = modsym.replace("1'", '')
    if gensym in ['0', '00', '000', '0000']:  #get rid of extraneous symbols
        gensym = ''
    nfrac = modsym.count('/')
    modsym = modsym.lstrip('(')
    if nfrac == 0:
        modsym = list(modsym)
    elif nfrac == 1:
        pos = modsym.find('/')
        if pos == 1:
            modsym = [modsym[:3], modsym[3], modsym[4]]
        elif pos == 2:
            modsym = [modsym[0], modsym[1:4], modsym[4]]
        else:
            modsym = [modsym[0], modsym[1], modsym[2:]]
    else:
        lpos = modsym.find('/')
        rpos = modsym.rfind('/')
        if lpos == 1 and rpos == 4:
            modsym = [modsym[:3], modsym[3:6], modsym[6]]
        elif lpos == 1 and rpos == 5:
            modsym = [modsym[:3], modsym[3], modsym[4:]]
        else:
            modsym = [modsym[0], modsym[1:4], modsym[4:]]
    gensym = list(gensym)
    return modsym, gensym 
[docs]def SSGPrint(SGData, SSGData, AddInv=False):
    '''
    Print the output of SSpcGroup in a nicely formatted way. Used in SSpaceGroup
    :param SGData: space group data structure as defined in SpcGroup above.
    :param SSGData: from :func:`SSpcGroup`
    :returns:
        SSGText - list of strings with the superspace group details
        SGTable - list of strings for each of the operations
    '''
    nCen = len(SSGData['SSGCen'])
    Mult = nCen * len(SSGData['SSGOps']) * (int(SGData['SGInv']) + 1)
    if SGData.get('SGFixed', False):
        Mult = len(SSGData['SSGCen']) * len(SSGData['SSGOps'])
    SSsymb = SSGData['SSpGrp']
    if 'BNSlattsym' in SGData and '_' in SGData['BNSlattsym'][0]:
        SSsymb = SGData['BNSlattsym'][0] + SSsymb[1:]
    if SGData.get('SGGray', False):
        if SGData.get('SGFixed', False):
            Mult //= 2
    else:
        if "1'" in SSsymb:  #leftover in nonmag phase in mcif file
            nCen //= 2
            Mult //= 2
            SSsymb = SSsymb.replace("1'", '')[:-1]
    SSGText = []
    SSGText.append(' Superspace Group: ' + SSsymb)
    CentStr = 'centrosymmetric'
    if not SGData['SGInv']:
        CentStr = 'non' + CentStr
    if SGData['SGLatt'] in 'ABCIFR':
        SSGText.append(' The lattice is ' + CentStr + ' ' + SGData['SGLatt'] +
                       '-centered ' + SGData['SGSys'].lower())
    else:
        SSGText.append(' The superlattice is ' + CentStr + ' ' + 'primitive ' +
                       SGData['SGSys'].lower())
    SSGText.append(' The Laue symmetry is ' + SGData['SGLaue'])
    SGptGp = SGData['SGPtGrp']
    if SGData['SGGray']:
        SGptGp += "1'"
    SSGText.append(' The superlattice point group is ' + SGptGp + ', ' +
                   ''.join([str(i) for i in SSGData['SSGKl']]))
    SSGText.append(' The number of superspace group generators is ' +
                   str(len(SGData['SSGKl'])))
    SSGText.append(' Multiplicity of a general site is ' + str(Mult))
    if SGData['SGUniq'] in ['a', 'b', 'c']:
        SSGText.append(' The unique monoclinic axis is ' + SGData['SGUniq'])
    if SGData['SGInv']:
        SSGText.append(' The inversion center is located at 0,0,0')
    if SGData['SGPolax']:
        SSGText.append(' The location of the origin is arbitrary in ' +
                       SGData['SGPolax'])
    SSGText.append(' ')
    if len(SSGData['SSGCen']) > 1:
        SSGText.append(' The equivalent positions are:')
        SSGText.append(' (' + SSLatt2text(SSGData['SSGCen'][:nCen]) + ')+\n')
    else:
        SSGText.append(' The equivalent positions are:\n')
    SSGTable = []
    for i, Opr in enumerate(SSGData['SSGOps']):
        SSGTable.append('(%2d) %s' % (i + 1, SSMT2text(Opr)))
    if AddInv and SGData['SGInv']:
        for i, Opr in enumerate(SSGData['SSGOps']):
            IOpr = [-Opr[0], -Opr[1]]
            SSGTable.append('(%2d) %s' %
                            (i + 1 + len(SSGData['SSGOps']), SSMT2text(IOpr)))
    return SSGText, SSGTable 
[docs]def SSGModCheck(Vec, modSymb, newMod=True):
    ''' Checks modulation vector compatibility with supersymmetry space group symbol.
    if newMod: Superspace group symbol takes precidence & the vector will be modified accordingly
    '''
    Fracs = {
        '1/2': 0.5,
        '1/3': 1. / 3,
        '1': 1.0,
        '0': 0.,
        'a': 0.,
        'b': 0.,
        'g': 0.
    }
    modQ = [Fracs[mod] for mod in modSymb]
    if newMod:
        newVec = Vec
        if not np.any(Vec):
            newVec = [
                0.1 if (vec == 0.0 and mod in ['a', 'b', 'g']) else vec
                for [vec, mod] in zip(Vec, modSymb)
            ]
        return [Q if mod not in ['a','b','g'] and vec != Q else vec for [vec,mod,Q] in zip(newVec,modSymb,modQ)],  \
            
[True if mod in ['a','b','g'] else False for mod in modSymb]
    else:
        return Vec, [
            True if mod in ['a', 'b', 'g'] else False for mod in modSymb
        ] 
[docs]def SSMT2text(Opr):
    "From superspace group matrix/translation operator returns text version"
    XYZS = ('x', 'y', 'z', 't')  #Stokes, Campbell & van Smaalen notation
    TRA = ('   ', 'ERR', '1/6', '1/4', '1/3', 'ERR', '1/2', 'ERR', '2/3', '3/4',
           '5/6', 'ERR')
    Fld = ''
    M, T = Opr
    for j in range(4):
        IJ = ''
        for k in range(4):
            txt = str(int(round(M[j][k])))
            txt = txt.replace('1', XYZS[k]).replace('0', '')
            if '2' in txt:
                txt += XYZS[k]
            if IJ and M[j][k] > 0:
                IJ += '+' + txt
            else:
                IJ += txt
        IK = int(round(T[j] * 12)) % 12
        if IK:
            if not IJ:
                break
            if IJ[0] == '-':
                Fld += (TRA[IK] + IJ).rjust(8)
            else:
                Fld += (TRA[IK] + '+' + IJ).rjust(8)
        else:
            Fld += IJ.rjust(8)
        if j != 3:
            Fld += ', '
    return Fld 
[docs]def SSLatt2text(SSGCen):
    "Lattice centering vectors to text"
    lattTxt = ''
    lattDir = {4: '1/3', 6: '1/2', 8: '2/3', 0: '0'}
    for vec in SSGCen:
        lattTxt += ' '
        for item in vec:
            lattTxt += '%s,' % (lattDir[int(item * 12)])
        lattTxt = lattTxt.rstrip(',')
        lattTxt += ';'
    lattTxt = lattTxt.rstrip(';').lstrip(' ')
    return lattTxt 
[docs]def SSpaceGroup(SGSymbol, SSymbol):
    '''
    Print the output of SSpcGroup in a nicely formatted way.
    :param SGSymbol: space group symbol with spaces between axial fields.
    :param SSymbol: superspace group symbol extension (string).
    :returns: nothing
    '''
    E, A = SpcGroup(SGSymbol)
    if E > 0:
        print(SGErrors(E))
        return
    E, B = SSpcGroup(A, SSymbol)
    if E > 0:
        print(E)
        return
    for l in SSGPrint(B):
        print(l) 
[docs]def SGProd(OpA, OpB):
    '''
    Form space group operator product. OpA & OpB are [M,V] pairs;
        both must be of same dimension (3 or 4). Returns [M,V] pair
    '''
    A, U = OpA
    B, V = OpB
    M = np.inner(B, A.T)
    W = np.inner(B, U) + V
    return M, W 
[docs]def GetLittleGrpOps(SGData, vec):
    ''' Find rotation part of operators that leave vec unchanged
    :param SGData: space group data structure as defined in SpcGroup above.
    :param vec: a numpy array of fractional vector coordinates
    :returns: Little - list of operators [M,T] that form the little gropu
    '''
    Little = []
    Ops = SGData['SGOps'][:]
    if SGData['SGInv']:
        Ops += [[-M, -T] for [M, T] in Ops]
    for [M, T] in Ops:
        tvec = np.inner(M, vec) % 1.
        if np.allclose(tvec, vec % 1.):
            Little.append([M, T])
    return Little 
[docs]def MoveToUnitCell(xyz):
    '''
    Translates a set of coordinates so that all values are >=0 and < 1
    :param xyz: a list or numpy array of fractional coordinates
    :returns: XYZ - numpy array of new coordinates now 0 or greater and less than 1
    '''
    XYZ = (np.array(xyz) + 10.) % 1.
    cell = np.asarray(np.rint(XYZ - xyz), dtype=np.int32)
    return XYZ, cell 
[docs]def Opposite(XYZ, toler=0.0002):
    '''
    Gives opposite corner, edge or face of unit cell for position within tolerance.
        Result may be just outside the cell within tolerance
    :param XYZ: 0 >= np.array[x,y,z] > 1 as by MoveToUnitCell
    :param toler: unit cell fraction tolerance making opposite
    :returns:
        XYZ: dict of opposite positions; key=unit cell & always contains XYZ
    '''
    perm3 = [[1, 1, 1], [0, 1, 1], [1, 0, 1], [1, 1, 0], [1, 0, 0], [0, 1, 0],
             [0, 0, 1], [0, 0, 0]]
    TB = np.where(abs(XYZ - 1) < toler, -1, 0) + np.where(
        abs(XYZ) < toler, 1, 0)
    perm = TB * perm3
    cperm = ['%d,%d,%d' % (i, j, k) for i, j, k in perm]
    D = dict(zip(cperm, perm))
    new = {}
    for key in D:
        new[key] = np.array(D[key]) + np.array(XYZ)
    return new 
[docs]def GenAtom(XYZ, SGData, All=False, Uij=[], Move=True):
    '''
    Generates the equivalent positions for a specified coordinate and space group
    :param XYZ: an array, tuple or list containing 3 elements: x, y & z
    :param SGData: from :func:`SpcGroup`
    :param All: True return all equivalent positions including duplicates;
      False return only unique positions
    :param Uij: [U11,U22,U33,U12,U13,U23] or [] if no Uij
    :param Move: True move generated atom positions to be inside cell
      False do not move atoms
    :return: [[XYZEquiv],Idup,[UijEquiv],spnflp]
      *  [XYZEquiv] is list of equivalent positions (XYZ is first entry)
      *  Idup = [-][C]SS where SS is the symmetry operator number (1-24), C (if not 0,0,0)
      * is centering operator number (1-4) and - is for inversion
        Cell = unit cell translations needed to put new positions inside cell
        [UijEquiv] - equivalent Uij; absent if no Uij given
      * +1/-1 for spin inversion of operator - empty if not magnetic
    '''
    XYZEquiv = []
    UijEquiv = []
    Idup = []
    Cell = []
    inv = int(SGData['SGInv'] + 1)
    icen = SGData['SGCen']
    if SGData.get('SGFixed', False):
        inv = 1
    SpnFlp = SGData.get('SpnFlp', [])
    spnflp = []
    X = np.array(XYZ)
    mj = 0
    cell0 = np.zeros(3, dtype=np.int32)
    if Move:
        X, cell0 = MoveToUnitCell(X)
    for ic, cen in enumerate(icen):
        C = np.array(cen)
        for invers in range(inv):
            for io, [M, T] in enumerate(SGData['SGOps']):
                idup = ((io + 1) + 100 * ic) * (1 - 2 * invers)
                XT = np.inner(M, X) + T
                if len(Uij):
                    U = Uij2U(Uij)
                    U = np.inner(M, np.inner(U, M).T)
                    newUij = U2Uij(U)
                if invers:
                    XT = -XT
                XT += C
                cell = np.zeros(3, dtype=np.int32) + cell0
                cellj = np.zeros(3, dtype=np.int32)
                if Move:
                    newX, cellj = MoveToUnitCell(XT)
                else:
                    newX = XT
                cell += cellj
                if All:
                    if np.allclose(newX, X, atol=0.0002):
                        idup = False
                else:
                    if True in [
                            np.allclose(newX, oldX, atol=0.0002)
                            for oldX in XYZEquiv
                    ]:
                        idup = False
                if All or idup:
                    XYZEquiv.append(newX)
                    Idup.append(idup)
                    Cell.append(cell)
                    if len(Uij):
                        UijEquiv.append(newUij)
                    if len(SpnFlp):
                        spnflp.append(SpnFlp[mj])
                    else:
                        spnflp.append(1)
                mj += 1
    if len(Uij):
        return zip(XYZEquiv, UijEquiv, Idup, Cell, spnflp)
    else:
        return zip(XYZEquiv, Idup, Cell, spnflp) 
[docs]def GenHKL(HKL, SGData):
    ''' Generates all equivlent reflections including Friedel pairs
    :param HKL:  [h,k,l] must be integral values
    :param SGData: space group data obtained from SpcGroup
    :returns: array Uniq: equivalent reflections
    '''
    Ops = SGData['SGOps']
    OpM = np.array([op[0] for op in Ops])
    Uniq = np.inner(OpM, HKL)
    Uniq = list(Uniq) + list(-1 * Uniq)
    return np.array(Uniq) 
[docs]def GenHKLf(HKL, SGData):
    '''
    Uses old GSAS Fortran routine genhkl.for
    :param HKL:  [h,k,l] must be integral values for genhkl.for to work
    :param SGData: space group data obtained from SpcGroup
    :returns: iabsnt,mulp,Uniq,phi
     *   iabsnt = True if reflection is forbidden by symmetry
     *   mulp = reflection multiplicity including Friedel pairs
     *   Uniq = numpy array of equivalent hkl in descending order of h,k,l
     *   phi = phase offset for each equivalent h,k,l
    '''
    hklf = list(HKL) + [
        0,
    ]  #could be numpy array!
    Ops = SGData['SGOps']
    OpM = np.array([op[0] for op in Ops], order='F')
    OpT = np.array([op[1] for op in Ops])
    Cen = np.array([cen for cen in SGData['SGCen']], order='F')
    import pyspg
    Nuniq, Uniq, iabsnt, mulp = pyspg.genhklpy(hklf, len(Ops), OpM, OpT,
                                               SGData['SGInv'], len(Cen), Cen)
    h, k, l, f = Uniq
    Uniq = np.array(list(zip(h[:Nuniq], k[:Nuniq], l[:Nuniq])))
    phi = f[:Nuniq]
    return iabsnt, mulp, Uniq, phi 
[docs]def checkSSLaue(HKL, SGData, SSGData):
    #Laue check here - Toss HKL if outside unique Laue part
    h, k, l, m = HKL
    if SGData['SGLaue'] == '2/m':
        if SGData['SGUniq'] == 'a':
            if 'a' in SSGData['modSymb'] and h == 0 and m < 0:
                return False
            elif 'b' in SSGData['modSymb'] and k == 0 and l == 0 and m < 0:
                return False
            else:
                return True
        elif SGData['SGUniq'] == 'b':
            if 'b' in SSGData['modSymb'] and k == 0 and m < 0:
                return False
            elif 'a' in SSGData['modSymb'] and h == 0 and l == 0 and m < 0:
                return False
            else:
                return True
        elif SGData['SGUniq'] == 'c':
            if 'g' in SSGData['modSymb'] and l == 0 and m < 0:
                return False
            elif 'a' in SSGData['modSymb'] and h == 0 and k == 0 and m < 0:
                return False
            else:
                return True
    elif SGData['SGLaue'] == 'mmm':
        if 'a' in SSGData['modSymb']:
            if h == 0 and m < 0:
                return False
            else:
                return True
        elif 'b' in SSGData['modSymb']:
            if k == 0 and m < 0:
                return False
            else:
                return True
        elif 'g' in SSGData['modSymb']:
            if l == 0 and m < 0:
                return False
            else:
                return True
    else:  #tetragonal, trigonal, hexagonal (& triclinic?)
        if l == 0 and m < 0:
            return False
        else:
            return True 
[docs]def checkHKLextc(HKL, SGData):
    '''
    Checks if reflection extinct - does not check centering
    :param HKL:  [h,k,l]
    :param SGData: space group data obtained from SpcGroup
    :returns: True if extinct; False if allowed
    '''
    Ops = SGData['SGOps']
    OpM = np.array([op[0] for op in Ops])
    OpT = np.array([op[1] for op in Ops])
    HKLS = np.array([HKL, -HKL])  #Freidel's Law
    DHKL = np.reshape(np.inner(HKLS, OpM) - HKL, (-1, 3))
    PHKL = np.reshape(np.inner(HKLS, OpT), (-1,))
    for dhkl, phkl in zip(DHKL, PHKL)[1:]:  #skip identity
        if dhkl.any():
            continue
        else:
            if phkl % 1.:
                return True
    return False 
[docs]def checkMagextc(HKL, SGData):
    '''
    Checks if reflection magnetically extinct; does fullcheck (centering, too)
    uses algorthm from Gallego, et al., J. Appl. Cryst. 45, 1236-1247 (2012)
    :param HKL:  [h,k,l]
    :param SGData: space group data obtained from SpcGroup; must have magnetic symmetry SpnFlp data
    :returns: True if magnetically extinct; False if allowed (to match GenHKLf)
    '''
    Ops = SGData['SGOps']
    Ncen = len(SGData['SGCen'])
    OpM = np.array([op[0] for op in Ops])
    OpT = np.array([op[1] for op in Ops])
    if SGData['SGInv'] and not SGData['SGFixed']:
        OpM = np.vstack((OpM, -OpM))
        OpT = np.vstack((OpT, -OpT)) % 1.
    OpM = np.reshape(np.array(list(OpM) * Ncen), (-1, 3, 3))
    OpT = np.reshape(np.array([OpT + cen for cen in SGData['SGCen']]), (-1, 3))
    Spn = SGData['SpnFlp'][:len(OpM)]
    Mag = np.array([nl.det(opm) for opm in OpM]) * Spn
    DHKL = np.reshape(np.inner(HKL, OpM), (-1, 3))
    PHKL = np.reshape(np.cos(twopi * np.inner(HKL, OpT)) * Mag,
                      (-1,))[:, nxs, nxs] * OpM  #compute T(R,theta) eq(7)
    Ftest = np.random.rand(3)  #random magnetic moment
    Psum = np.zeros(3)
    nsum = 0.
    nA = 0
    for dhkl, phkl in zip(DHKL, PHKL):
        if not np.allclose(dhkl, HKL):  #test for eq(5)
            continue
        else:
            nA += 1
            nsum += np.trace(phkl)  #eq(8)
            pterm = np.inner(Ftest, phkl)  #eq(9)
            Psum += pterm
    if nsum / nA > 1.:  #only need to look at nA=1 frok eq(8)
        return False
    if np.allclose(Psum, np.zeros(3)):
        return True
    else:
        if np.inner(HKL, Psum):
            return True
        return False 
[docs]def checkSSextc(HKL, SSGData):
    Ops = SSGData['SSGOps']
    OpM = np.array([op[0] for op in Ops])
    OpT = np.array([op[1] for op in Ops])
    HKLS = np.array([HKL, -HKL])  #Freidel's Law
    DHKL = np.reshape(np.inner(HKLS, OpM) - HKL, (-1, 4))
    PHKL = np.reshape(np.inner(HKLS, OpT), (-1,))
    for dhkl, phkl in list(zip(DHKL, PHKL))[1:]:  #skip identity
        if dhkl.any():
            continue
        else:
            if phkl % 1.:
                return False
    return True 
################################################################################
#### Site symmetry tables
################################################################################
OprName = {
    '-6643': ['-1', 1],
    '6479': ['2(z)', 2],
    '-6479': ['m(z)', 3],
    '6481': ['m(y)', 4],
    '-6481': ['2(y)', 5],
    '6641': ['m(x)', 6],
    '-6641': ['2(x)', 7],
    '6591': ['m(+-0)', 8],
    '-6591': ['2(+-0)', 9],
    '6531': ['m(110)', 10],
    '-6531': ['2(110)', 11],
    '6537': ['4(z)', 12],
    '-6537': ['-4(z)', 13],
    '975': ['3(111)', 14],
    '6456': ['3', 15],
    '-489': ['3(+--)', 16],
    '483': ['3(-+-)', 17],
    '-969': ['3(--+)', 18],
    '819': ['m(+0-)', 19],
    '-819': ['2(+0-)', 20],
    '2431': ['m(0+-)', 21],
    '-2431': ['2(0+-)', 22],
    '-657': ['m(xz)', 23],
    '657': ['2(xz)', 24],
    '1943': ['-4(x)', 25],
    '-1943': ['4(x)', 26],
    '-2429': ['m(yz)', 27],
    '2429': ['2(yz)', 28],
    '639': ['-4(y)', 29],
    '-639': ['4(y)', 30],
    '-6484': ['2(010)', 4],
    '6484': ['m(010)', 5],
    '-6668': ['2(100)', 6],
    '6668': ['m(100)', 7],
    '-6454': ['2(120)', 18],
    '6454': ['m(120)', 19],
    '-6638': ['2(210)', 20],
    '6638': ['m(210)', 21],  #search in SytSym ends at m(210)
    '2223': ['3(+++)2', 39],
    '6538': ['6(z)1', 40],
    '-2169': ['3(--+)2', 41],
    '2151': ['3(+--)2', 42],
    '2205': ['-3(-+-)2', 43],
    '-2205': [' (-+-)2', 44],
    '489': ['-3(+--)1', 45],
    '801': ['4(y)1', 46],
    '1945': ['4(x)3', 47],
    '-6585': ['-4(z)3 ', 48],
    '6585': ['4(z)3', 49],
    '6584': ['3(z)2', 50],
    '6666': ['6(z)5 ', 51],
    '6643': ['1', 52],
    '-801': ['-4(y)1', 53],
    '-1945': ['-4(x)3 ', 54],
    '-6666': ['-6(z)5', 55],
    '-6538': ['-6(z)1', 56],
    '-2223': ['-3(+++)2', 57],
    '-975': ['-3(+++)1', 58],
    '-6456': ['-3(z)1', 59],
    '-483': ['-3(-+-)1', 60],
    '969': ['-3(--+)1', 61],
    '-6584': ['-3(z)2', 62],
    '2169': ['-3(--+)2', 63],
    '-2151': ['-3(+--)2', 64],
}
KNsym = {
    '0': '    1   ',
    '1': '   -1   ',
    '64': '    2(x)',
    '32': '    m(x)',
    '97': '  2/m(x)',
    '16': '    2(y)',
    '8': '    m(y)',
    '25': '  2/m(y)',
    '2': '    2(z)',
    '4': '    m(z)',
    '7': '  2/m(z)',
    '134217728': '   2(yz)',
    '67108864': '   m(yz)',
    '201326593': ' 2/m(yz)',
    '2097152': '  2(0+-)',
    '1048576': '  m(0+-)',
    '3145729': '2/m(0+-)',
    '8388608': '   2(xz)',
    '4194304': '   m(xz)',
    '12582913': ' 2/m(xz)',
    '524288': '  2(+0-)',
    '262144': '  m(+0-)',
    '796433': '2/m(+0-)',
    '1024': '   2(xy)',
    '512': '   m(xy)',
    '1537': ' 2/m(xy)',
    '256': '  2(+-0)',
    '128': '  m(+-0)',
    '385': '2/m(+-0)',
    '76': '  mm2(x)',
    '52': '  mm2(y)',
    '42': '  mm2(z)',
    '135266336': ' mm2(yz)',
    '69206048': 'mm2(0+-)',
    '8650760': ' mm2(xz)',
    '4718600': 'mm2(+0-)',
    '1156': ' mm2(xy)',
    '772': 'mm2(+-0)',
    '82': '  222   ',
    '136314944': '  222(x)',
    '8912912': '  222(y)',
    '1282': '  222(z)',
    '127': '  mmm   ',
    '204472417': '  mmm(x)',
    '13369369': '  mmm(y)',
    '1927': '  mmm(z)',
    '33554496': '  4(x)',
    '16777280': ' -4(x)',
    '50331745': '4/m(x)',
    '169869394': '422(x)',
    '84934738': '-42m(x)',
    '101711948': '4mm(x)',
    '254804095': '4/mmm(x)',
    '536870928 ': '  4(y)',
    '268435472': ' -4(y)',
    '805306393': '4/m(y)',
    '545783890': '422(y)',
    '272891986': '-42m(y)',
    '541327412': '4mm(y)',
    '818675839': '4/mmm(y)',
    '2050': '  4(z)',
    '4098': ' -4(z)',
    '6151': '4/m(z)',
    '3410': '422(z)',
    '4818': '-42m(z)',
    '2730': '4mm(z)',
    '8191': '4/mmm(z)',
    '8192': '  3(111)',
    '8193': ' -3(111)',
    '2629888': ' 32(111)',
    '1319040': ' 3m(111)',
    '3940737': '-3m(111)',
    '32768': '  3(+--)',
    '32769': ' -3(+--)',
    '10519552': ' 32(+--)',
    '5276160': ' 3m(+--)',
    '15762945': '-3m(+--)',
    '65536': '  3(-+-)',
    '65537': ' -3(-+-)',
    '134808576': ' 32(-+-)',
    '67437056': ' 3m(-+-)',
    '202180097': '-3m(-+-)',
    '131072': '  3(--+)',
    '131073': ' -3(--+)',
    '142737664': ' 32(--+)',
    '71434368': ' 3m(--+)',
    '214040961': '-3m(--+)',
    '237650': '   23   ',
    '237695': '   m3   ',
    '715894098': '   432  ',
    '358068946': '  -43m  ',
    '1073725439': '   m3m  ',
    '68157504': ' mm2(d100)',
    '4456464': ' mm2(d010)',
    '642': ' mm2(d001)',
    '153092172': '-4m2(x)',
    '277348404': '-4m2(y)',
    '5418': '-4m2(z)',
    '1075726335': '  6/mmm ',
    '1074414420': '-6m2(100)',
    '1075070124': '-6m2(120)',
    '1075069650': '   6mm  ',
    '1074414890': '   622  ',
    '1073758215': '   6/m  ',
    '1073758212': '   -6   ',
    '1073758210': '    6   ',
    '1073759865': '-3m(100)',
    '1075724673': '-3m(120)',
    '1073758800': ' 3m(100)',
    '1075069056': ' 3m(120)',
    '1073759272': ' 32(100)',
    '1074413824': ' 32(120)',
    '1073758209': '   -3   ',
    '1073758208': '    3   ',
    '1074135143': 'mmm(100)',
    '1075314719': 'mmm(010)',
    '1073743751': 'mmm(110)',
    '1074004034': ' mm2(z100)',
    '1074790418': ' mm2(z010)',
    '1073742466': ' mm2(z110)',
    '1074004004': 'mm2(100)',
    '1074790412': 'mm2(010)',
    '1073742980': 'mm2(110)',
    '1073872964': 'mm2(120)',
    '1074266132': 'mm2(210)',
    '1073742596': 'mm2(+-0)',
    '1073872930': '222(100)',
    '1074266122': '222(010)',
    '1073743106': '222(110)',
    '1073741831': '2/m(001)',
    '1073741921': '2/m(100)',
    '1073741849': '2/m(010)',
    '1073743361': '2/m(110)',
    '1074135041': '2/m(120)',
    '1075314689': '2/m(210)',
    '1073742209': '2/m(+-0)',
    '1073741828': ' m(001) ',
    '1073741888': ' m(100) ',
    '1073741840': ' m(010) ',
    '1073742336': ' m(110) ',
    '1074003968': ' m(120) ',
    '1074790400': ' m(210) ',
    '1073741952': ' m(+-0) ',
    '1073741826': ' 2(001) ',
    '1073741856': ' 2(100) ',
    '1073741832': ' 2(010) ',
    '1073742848': ' 2(110) ',
    '1073872896': ' 2(120) ',
    '1074266112': ' 2(210) ',
    '1073742080': ' 2(+-0) ',
    '1073741825': '   -1   ',
}
NXUPQsym = {
    '1': (28, 29, 28, 28),
    '-1': (1, 29, 28, 0),
    '2(x)': (12, 18, 12, 25),
    'm(x)': (25, 18, 12, 25),
    '2/m(x)': (1, 18, 0, -1),
    '2(y)': (13, 17, 13, 24),
    'm(y)': (24, 17, 13, 24),
    '2/m(y)': (1, 17, 0, -1),
    '2(z)': (14, 16, 14, 23),
    'm(z)': (23, 16, 14, 23),
    '2/m(z)': (1, 16, 0, -1),
    '2(yz)': (10, 23, 10, 22),
    'm(yz)': (22, 23, 10, 22),
    ' 2/m(yz)': (1, 23, 0, -1),
    '2(0+-)': (11, 24, 11, 21),
    'm(0+-)': (21, 24, 11, 21),
    '2/m(0+-)': (1, 24, 0, -1),
    '2(xz)': (8, 21, 8, 20),
    'm(xz)': (20, 21, 8, 20),
    '2/m(xz)': (1, 21, 0, -1),
    '2(+0-)': (9, 22, 9, 19),
    'm(+0-)': (19, 22, 9, 19),
    '2/m(+0-)': (1, 22, 0, -1),
    '2(xy)': (6, 19, 6, 18),
    'm(xy)': (18, 19, 6, 18),
    ' 2/m(xy)': (1, 19, 0, -1),
    '2(+-0)': (7, 20, 7, 17),
    'm(+-0)': (17, 20, 7, 17),
    '2/m(+-0)': (1, 20, 17, -1),
    'mm2(x)': (12, 10, 0, -1),
    'mm2(y)': (13, 10, 0, -1),
    'mm2(z)': (14, 10, 0, -1),
    'mm2(yz)': (10, 13, 0, -1),
    'mm2(0+-)': (11, 13, 0, -1),
    'mm2(xz)': (8, 12, 0, -1),
    'mm2(+0-)': (9, 12, 0, -1),
    'mm2(xy)': (6, 11, 0, -1),
    'mm2(+-0)': (7, 11, 0, -1),
    '222': (1, 10, 0, -1),
    '222(x)': (1, 13, 0, -1),
    '222(y)': (1, 12, 0, -1),
    '222(z)': (1, 11, 0, -1),
    'mmm': (1, 10, 0, -1),
    'mmm(x)': (1, 13, 0, -1),
    'mmm(y)': (1, 12, 0, -1),
    'mmm(z)': (1, 11, 0, -1),
    '4(x)': (12, 4, 12, 0),
    '-4(x)': (1, 4, 12, 0),
    '4/m(x)': (1, 4, 12, -1),
    '422(x)': (1, 4, 0, -1),
    '-42m(x)': (1, 4, 0, -1),
    '4mm(x)': (12, 4, 0, -1),
    '4/mmm(x)': (1, 4, 0, -1),
    '4(y)': (13, 3, 13, 0),
    '-4(y)': (1, 3, 13, 0),
    '4/m(y)': (1, 3, 13, -1),
    '422(y)': (1, 3, 0, -1),
    '-42m(y)': (1, 3, 0, -1),
    '4mm(y)': (13, 3, 0, -1),
    '4/mmm(y)': (
        1,
        3,
        0,
        -1,
    ),
    '4(z)': (14, 2, 14, 0),
    '-4(z)': (1, 2, 14, 0),
    '4/m(z)': (1, 2, 14, -1),
    '422(z)': (1, 2, 0, -1),
    '-42m(z)': (1, 2, 0, -1),
    '4mm(z)': (14, 2, 0, -1),
    '4/mmm(z)': (1, 2, 0, -1),
    '3(111)': (2, 5, 2, 0),
    '-3(111)': (1, 5, 2, 0),
    '32(111)': (1, 5, 0, 2),
    '3m(111)': (2, 5, 0, 2),
    '-3m(111)': (1, 5, 0, -1),
    '3(+--)': (5, 8, 5, 0),
    '-3(+--)': (1, 8, 5, 0),
    '32(+--)': (1, 8, 0, 5),
    '3m(+--)': (5, 8, 0, 5),
    '-3m(+--)': (1, 8, 0, -1),
    '3(-+-)': (4, 7, 4, 0),
    '-3(-+-)': (1, 7, 4, 0),
    '32(-+-)': (1, 7, 0, 4),
    '3m(-+-)': (4, 7, 0, 4),
    '-3m(-+-)': (1, 7, 0, -1),
    '3(--+)': (3, 6, 3, 0),
    '-3(--+)': (1, 6, 3, 0),
    '32(--+)': (1, 6, 0, 3),
    '3m(--+)': (3, 6, 0, 3),
    '-3m(--+)': (1, 6, 0, -1),
    '23': (1, 1, 0, 0),
    'm3': (1, 1, 0, 0),
    '432': (1, 1, 0, 0),
    '-43m': (1, 1, 0, 0),
    'm3m': (1, 1, 0, 0),
    'mm2(d100)': (12, 13, 0, -1),
    'mm2(d010)': (13, 12, 0, -1),
    'mm2(d001)': (14, 11, 0, -1),
    '-4m2(x)': (1, 4, 0, -1),
    '-4m2(y)': (1, 3, 0, -1),
    '-4m2(z)': (1, 2, 0, -1),
    '6/mmm': (1, 9, 0, -1),
    '-6m2(100)': (1, 9, 0, -1),
    '-6m2(120)': (1, 9, 0, -1),
    '6mm': (14, 9, 0, -1),
    '622': (1, 9, 0, -1),
    '6/m': (1, 9, 14, -1),
    '-6': (1, 9, 14, 0),
    '6': (14, 9, 14, 0),
    '-3m(100)': (1, 9, 0, -1),
    '-3m(120)': (1, 9, 0, -1),
    '3m(100)': (14, 9, 0, 14),
    '3m(120)': (14, 9, 0, 14),
    '32(100)': (1, 9, 0, 14),
    '32(120)': (1, 9, 0, 14),
    '-3': (1, 9, 14, 0),
    '3': (14, 9, 14, 0),
    'mmm(100)': (1, 14, 0, -1),
    'mmm(010)': (1, 15, 0, -1),
    'mmm(110)': (1, 11, 0, -1),
    'mm2(z100)': (14, 14, 0, -1),
    'mm2(z010)': (14, 15, 0, -1),
    'mm2(z110)': (14, 11, 0, -1),
    'mm2(100)': (12, 14, 0, -1),
    'mm2(010)': (13, 15, 0, -1),
    'mm2(110)': (6, 11, 0, -1),
    'mm2(120)': (15, 14, 0, -1),
    'mm2(210)': (16, 15, 0, -1),
    'mm2(+-0)': (7, 11, 0, -1),
    '222(100)': (1, 14, 0, -1),
    '222(010)': (1, 15, 0, -1),
    '222(110)': (1, 11, 0, -1),
    '2/m(001)': (1, 16, 14, -1),
    '2/m(100)': (1, 25, 12, -1),
    '2/m(010)': (1, 28, 13, -1),
    '2/m(110)': (1, 19, 6, -1),
    '2/m(120)': (1, 27, 15, -1),
    '2/m(210)': (1, 26, 16, -1),
    '2/m(+-0)': (1, 20, 17, -1),
    'm(001)': (23, 16, 14, 23),
    'm(100)': (26, 25, 12, 26),
    'm(010)': (27, 28, 13, 27),
    'm(110)': (18, 19, 6, 18),
    'm(120)': (24, 27, 15, 24),
    'm(210)': (25, 26, 16, 25),
    'm(+-0)': (17, 20, 7, 17),
    '2(001)': (14, 16, 14, 23),
    '2(100)': (12, 25, 12, 26),
    '2(010)': (13, 28, 13, 27),
    '2(110)': (6, 19, 6, 18),
    '2(120)': (15, 27, 15, 24),
    '2(210)': (16, 26, 16, 25),
    '2(+-0)': (7, 20, 7, 17),
    '-1': (1, 29, 28, 0)
}
CSxinel = [
    [],  # 0th empty - indices are Fortran style
    [[0, 0, 0], [0.0, 0.0, 0.0]],  #1  0  0  0
    [[1, 1, 1], [1.0, 1.0, 1.0]],  #2  X  X  X
    [[1, 1, 1], [1.0, 1.0, -1.0]],  #3  X  X -X
    [[1, 1, 1], [1.0, -1.0, 1.0]],  #4  X -X  X
    [[1, 1, 1], [1.0, -1.0, -1.0]],  #5 -X  X  X
    [[1, 1, 0], [1.0, 1.0, 0.0]],  #6  X  X  0
    [[1, 1, 0], [1.0, -1.0, 0.0]],  #7  X -X  0
    [[1, 0, 1], [1.0, 0.0, 1.0]],  #8  X  0  X
    [[1, 0, 1], [1.0, 0.0, -1.0]],  #9  X  0 -X
    [[0, 1, 1], [0.0, 1.0, 1.0]],  #10  0  Y  Y
    [[0, 1, 1], [0.0, 1.0, -1.0]],  #11 0  Y -Y
    [[1, 0, 0], [1.0, 0.0, 0.0]],  #12  X  0  0
    [[0, 1, 0], [0.0, 1.0, 0.0]],  #13  0  Y  0
    [[0, 0, 1], [0.0, 0.0, 1.0]],  #14  0  0  Z
    [[1, 1, 0], [1.0, 2.0, 0.0]],  #15  X 2X  0
    [[1, 1, 0], [2.0, 1.0, 0.0]],  #16 2X  X  0
    [[1, 1, 2], [1.0, 1.0, 1.0]],  #17  X  X  Z
    [[1, 1, 2], [1.0, -1.0, 1.0]],  #18  X -X  Z
    [[1, 2, 1], [1.0, 1.0, 1.0]],  #19  X  Y  X
    [[1, 2, 1], [1.0, 1.0, -1.0]],  #20  X  Y -X
    [[1, 2, 2], [1.0, 1.0, 1.0]],  #21  X  Y  Y
    [[1, 2, 2], [1.0, 1.0, -1.0]],  #22  X  Y -Y
    [[1, 2, 0], [1.0, 1.0, 0.0]],  #23  X  Y  0
    [[1, 0, 2], [1.0, 0.0, 1.0]],  #24  X  0  Z
    [[0, 1, 2], [0.0, 1.0, 1.0]],  #25  0  Y  Z
    [[1, 1, 2], [1.0, 2.0, 1.0]],  #26  X 2X  Z
    [[1, 1, 2], [2.0, 1.0, 1.0]],  #27 2X  X  Z
    [[1, 2, 3], [1.0, 1.0, 1.0]],  #28  X  Y  Z
]
CSuinel = [
    [],  # 0th empty - indices are Fortran style
    [[1, 1, 1, 0, 0, 0], [1.0, 1.0, 1.0, 0.0, 0.0, 0.0], [1, 0, 0, 0, 0, 0],
     [1.0, 1.0, 1.0, 0.0, 0.0, 0.0]],  #1  A  A  A  0  0  0
    [[1, 1, 2, 0, 0, 0], [1.0, 1.0, 1.0, 0.0, 0.0, 0.0], [1, 0, 1, 0, 0, 0],
     [1.0, 1.0, 1.0, 0.0, 0.0, 0.0]],  #2  A  A  C  0  0  0
    [[1, 2, 1, 0, 0, 0], [1.0, 1.0, 1.0, 0.0, 0.0, 0.0], [1, 1, 0, 0, 0, 0],
     [1.0, 1.0, 1.0, 0.0, 0.0, 0.0]],  #3  A  B  A  0  0  0
    [[1, 2, 2, 0, 0, 0], [1.0, 1.0, 1.0, 0.0, 0.0, 0.0], [1, 1, 0, 0, 0, 0],
     [1.0, 1.0, 1.0, 0.0, 0.0, 0.0]],  #4  A  B  B  0  0  0
    [[1, 1, 1, 2, 2, 2], [1.0, 1.0, 1.0, 1.0, 1.0, 1.0], [1, 0, 0, 1, 0, 0],
     [1.0, 1.0, 1.0, 0.0, 0.0, 0.0]],  #5  A  A  A  D  D  D
    [[1, 1, 1, 2, 2, 2], [1.0, 1.0, 1.0, 1.0, -1.0, -1.0], [1, 0, 0, 1, 0, 0],
     [1.0, 1.0, 1.0, 0.0, 0.0, 0.0]],  #6  A  A  A  D -D -D
    [[1, 1, 1, 2, 2, 2], [1.0, 1.0, 1.0, 1.0, -1.0, 1.0], [1, 0, 0, 1, 0, 0],
     [1.0, 1.0, 1.0, 0.0, 0.0, 0.0]],  #7  A  A  A  D -D  D
    [[1, 1, 1, 2, 2, 2], [1.0, 1.0, 1.0, 1.0, 1.0, -1.0], [1, 0, 0, 1, 0, 0],
     [1.0, 1.0, 1.0, 0.0, 0.0, 0.0]],  #8  A  A  A  D  D -D
    [[1, 1, 2, 1, 0, 0], [1.0, 1.0, 1.0, 0.5, 0.0, 0.0], [1, 0, 1, 0, 0, 0],
     [1.0, 1.0, 1.0, 0.5, 0.0, 0.0]],  #9  A  A  C A/2 0  0
    [[1, 2, 3, 0, 0, 0], [1.0, 1.0, 1.0, 0.0, 0.0, 0.0], [1, 1, 1, 0, 0, 0],
     [1.0, 1.0, 1.0, 0.0, 0.0, 0.0]],  #10  A  B  C  0  0  0
    [[1, 1, 2, 3, 0, 0], [1.0, 1.0, 1.0, 1.0, 0.0, 0.0], [1, 0, 1, 1, 0, 0],
     [1.0, 1.0, 1.0, 0.0, 0.0, 0.0]],  #11  A  A  C  D  0  0
    [[1, 2, 1, 0, 3, 0], [1.0, 1.0, 1.0, 0.0, 1.0, 0.0], [1, 1, 0, 0, 1, 0],
     [1.0, 1.0, 1.0, 0.0, 0.0, 0.0]],  #12  A  B  A  0  E  0
    [[1, 2, 2, 0, 0, 3], [1.0, 1.0, 1.0, 0.0, 0.0, 1.0], [1, 1, 0, 0, 0, 1],
     [1.0, 1.0, 1.0, 0.0, 0.0, 0.0]],  #13  A  B  B  0  0  F
    [[1, 2, 3, 2, 0, 0], [1.0, 1.0, 1.0, 0.5, 0.0, 0.0], [1, 1, 1, 0, 0, 0],
     [1.0, 1.0, 1.0, 0.0, 0.5, 0.0]],  #14  A  B  C B/2 0  0
    [[1, 2, 3, 1, 0, 0], [1.0, 1.0, 1.0, 0.5, 0.0, 0.0], [1, 1, 1, 0, 0, 0],
     [1.0, 1.0, 1.0, 0.0, 0.5, 0.0]],  #15  A  B  C A/2 0  0
    [[1, 2, 3, 4, 0, 0], [1.0, 1.0, 1.0, 1.0, 0.0, 0.0], [1, 1, 1, 1, 0, 0],
     [1.0, 1.0, 1.0, 0.0, 0.0, 0.0]],  #16  A  B  C  D  0  0
    [[1, 2, 3, 0, 4, 0], [1.0, 1.0, 1.0, 0.0, 1.0, 0.0], [1, 1, 1, 0, 1, 0],
     [1.0, 1.0, 1.0, 0.0, 0.0, 0.0]],  #17  A  B  C  0  E  0
    [[1, 2, 3, 0, 0, 4], [1.0, 1.0, 1.0, 0.0, 0.0, 1.0], [1, 1, 1, 0, 0, 1],
     [1.0, 1.0, 1.0, 0.0, 0.0, 0.0]],  #18  A  B  C  0  0  F
    [[1, 1, 2, 3, 4, 4], [1.0, 1.0, 1.0, 1.0, 1.0, -1.0], [1, 0, 1, 1, 1, 0],
     [1.0, 1.0, 1.0, 0.0, 0.0, 0.0]],  #19  A  A  C  D  E -E
    [[1, 1, 2, 3, 4, 4], [1.0, 1.0, 1.0, 1.0, 1.0, 1.0], [1, 0, 1, 1, 1, 0],
     [1.0, 1.0, 1.0, 0.0, 0.0, 0.0]],  #20  A  A  C  D  E  E
    [[1, 2, 1, 3, 4, 3], [1.0, 1.0, 1.0, 1.0, 1.0, -1.0], [1, 1, 0, 1, 1, 0],
     [1.0, 1.0, 1.0, 0.0, 0.0, 0.0]],  #21  A  B  A  D  E -D
    [[1, 2, 1, 3, 4, 3], [1.0, 1.0, 1.0, 1.0, 1.0, 1.0], [1, 1, 0, 1, 1, 0],
     [1.0, 1.0, 1.0, 0.0, 0.0, 0.0]],  #22  A  B  A  D  E  D
    [[1, 2, 2, 3, 3, 4], [1.0, 1.0, 1.0, 1.0, -1.0, 1.0], [1, 1, 0, 1, 0, 1],
     [1.0, 1.0, 1.0, 0.0, 0.0, 0.0]],  #23  A  B  B  D -D  F
    [[1, 2, 2, 3, 3, 4], [1.0, 1.0, 1.0, 1.0, 1.0, 1.0], [1, 1, 0, 1, 0, 1],
     [1.0, 1.0, 1.0, 0.0, 0.0, 0.0]],  #24  A  B  B  D  D  F
    [[1, 2, 3, 2, 4, 4], [1.0, 1.0, 1.0, 0.5, 1.0, 2.0], [1, 1, 1, 0, 0, 1],
     [1.0, 1.0, 1.0, 0.5, 0.0, 0.0]],  #25  A  B  C B/2 F/2 F
    [[1, 2, 3, 1, 0, 4], [1.0, 1.0, 1.0, 0.5, 0.0, 1.0], [1, 1, 1, 0, 0, 1],
     [1.0, 1.0, 1.0, 0.5, 0.0, 0.0]],  #26  A  B  C A/2  0  F
    [[1, 2, 3, 2, 4, 0], [1.0, 1.0, 1.0, 0.5, 1.0, 0.0], [1, 1, 1, 0, 1, 0],
     [1.0, 1.0, 1.0, 0.5, 0.0, 0.0]],  #27  A  B  C B/2  E  0
    [[1, 2, 3, 1, 4, 4], [1.0, 1.0, 1.0, 0.5, 1.0, 0.5], [1, 1, 1, 0, 1, 0],
     [1.0, 1.0, 1.0, 0.5, 0.0, 0.0]],  #28  A  B  C A/2  E E/2
    [[1, 2, 3, 4, 5, 6], [1.0, 1.0, 1.0, 1.0, 1.0, 1.0], [1, 1, 1, 1, 1, 1],
     [1.0, 1.0, 1.0, 0.0, 0.0, 0.0]],  #29  A  B  C  D  E   F
]
################################################################################
#### Site symmetry routines
################################################################################
[docs]def GetOprPtrName(key):
    'Needs a doc string'
    try:
        oprName = OprName[key][0]
    except KeyError:
        return key
    return oprName.replace('(', '').replace(')', '') 
[docs]def GetOprPtrNumber(key):
    'Needs a doc string'
    try:
        return OprName[key][1]
    except KeyError:
        return key 
[docs]def GetOprName(key):
    'Needs a doc string'
    return OprName[key][0] 
[docs]def GetKNsym(key):
    'Needs a doc string'
    try:
        return KNsym[key].strip()
    except KeyError:
        return 'sp' 
[docs]def GetNXUPQsym(siteSym):
    '''
    The codes XUPQ are for lookup of symmetry constraints for position(X), thermal parm(U) & magnetic moments (P & Q)
    '''
    return NXUPQsym[siteSym] 
[docs]def GetCSxinel(siteSym):
    "returns Xyz terms, multipliers, GUI flags"
    indx = GetNXUPQsym(siteSym.strip())
    return CSxinel[indx[0]] 
[docs]def GetCSuinel(siteSym):
    "returns Uij terms, multipliers, GUI flags & Uiso2Uij multipliers"
    indx = GetNXUPQsym(siteSym.strip())
    return CSuinel[indx[1]] 
[docs]def GetCSpqinel(SpnFlp, dupDir):
    "returns Mxyz terms, multipliers, GUI flags"
    CSI = [[1, 2, 3], [1.0, 1.0, 1.0]]
    for sopr in dupDir:
        #        print (sopr,dupDir[sopr])
        opr = sopr.replace("'", '')
        indx = GetNXUPQsym(opr)
        if SpnFlp[dupDir[sopr]] > 0:
            csi = CSxinel[indx[2]]  #P
        else:
            csi = CSxinel[indx[3]]  #Q
#        print(opr,indx,csi,CSI)
        if not len(csi):
            return [[0, 0, 0], [0., 0., 0.]]
        for kcs in [0, 1, 2]:
            if csi[0][kcs] == 0 and CSI[0][kcs] != 0:
                jcs = CSI[0][kcs]
                for ics in [0, 1, 2]:
                    if CSI[0][ics] == jcs:
                        CSI[0][ics] = 0
                        CSI[1][ics] = 0.
                    elif CSI[0][ics] > jcs:
                        CSI[0][ics] = CSI[0][ics] - 1
            elif (CSI[0][kcs] == csi[0][kcs]) and (CSI[1][kcs] != csi[1][kcs]):
                CSI[1][kcs] = csi[1][kcs]
            elif CSI[0][kcs] >= csi[0][kcs]:
                CSI[0][kcs] = min(CSI[0][kcs], csi[0][kcs])
                if CSI[1][kcs] != csi[1][kcs]:
                    if CSI[1][kcs] == 1.:
                        CSI[1][kcs] = csi[1][kcs]
#        print(CSI)
    return CSI 
[docs]def getTauT(tau, sop, ssop, XYZ, wave=np.zeros(3)):
    phase = np.sum(XYZ * wave)
    ssopinv = nl.inv(ssop[0])
    mst = ssopinv[3][:3]
    epsinv = ssopinv[3][3]
    sdet = nl.det(sop[0])
    ssdet = nl.det(ssop[0])
    dtau = mst * (XYZ - sop[1]) - epsinv * ssop[1][3]
    dT = 1.0
    if np.any(dtau % .5):
        sumdtau = np.sum(dtau % .5)
        dT = 0.
        if np.abs(sumdtau - .5) > 1.e-4:
            dT = np.tan(np.pi * sumdtau)
    tauT = np.inner(mst, XYZ - sop[1]) + epsinv * (tau - ssop[1][3] + phase)
    return sdet, ssdet, dtau, dT, tauT 
[docs]def OpsfromStringOps(A, SGData, SSGData):
    SGOps = SGData['SGOps']
    SSGOps = SSGData['SSGOps']
    Ax = A.split('+')
    Ax[0] = int(Ax[0])
    iC = 1
    if Ax[0] < 0:
        iC = -1
    iAx = abs(Ax[0])
    nA = iAx % 100 - 1
    nC = iAx // 100
    unit = [0, 0, 0]
    if len(Ax) > 1:
        unit = eval('[' + Ax[1] + ']')
    return SGOps[nA], SSGOps[nA], iC, SGData['SGCen'][nC], unit 
[docs]def GetSSfxuinel(waveType, Stype, nH, XYZ, SGData, SSGData, debug=False):
    def orderParms(CSI):
        parms = [
            0,
        ]
        for csi in CSI:
            for i in [0, 1, 2]:
                if csi[i] not in parms:
                    parms.append(csi[i])
        for csi in CSI:
            for i in [0, 1, 2]:
                csi[i] = parms.index(csi[i])
        return CSI
    def fracCrenel(tau, Toff, Twid):
        Tau = (tau - Toff[:, nxs]) % 1.
        A = np.where(Tau < Twid[:, nxs], 1., 0.)
        return A
    def fracFourier(tau, nH, fsin, fcos):
        SA = np.sin(2. * nH * np.pi * tau)
        CB = np.cos(2. * nH * np.pi * tau)
        A = SA[nxs, nxs, :] * fsin[:, :, nxs]
        B = CB[nxs, nxs, :] * fcos[:, :, nxs]
        return A + B
    def posFourier(tau, nH, psin, pcos):
        SA = np.sin(2 * nH * np.pi * tau)
        CB = np.cos(2 * nH * np.pi * tau)
        A = SA[nxs, nxs, :] * psin[:, :, nxs]
        B = CB[nxs, nxs, :] * pcos[:, :, nxs]
        return A + B
    def posZigZag(tau, Tmm, XYZmax):
        DT = Tmm[1] - Tmm[0]
        slopeUp = 2. * XYZmax / DT
        slopeDn = 2. * XYZmax / (1. - DT)
        A = np.array([
            np.where(0. < t - (Tmm[0]) % 1. <= DT,
                     -XYZmax + slopeUp * ((t - Tmm[0]) % 1.),
                     XYZmax - slopeDn * ((t - Tmm[1]) % 1.)) for t in tau
        ])
        return A
    def posBlock(tau, Tmm, XYZmax):
        A = np.array(
            [np.where(Tmm[0] < t <= Tmm[1], XYZmax, -XYZmax) for t in tau])
        return A
    def DoFrac():
        delt2 = np.eye(2) * 0.001
        dF = fracFourier(tau, nH, delt2[:1], delt2[1:]).squeeze()
        dFTP = []
        if siteSym == '1':
            CSI = [[1, 0], [2, 0]], 2 * [
                [1., 0.],
            ]
        elif siteSym == '-1':
            CSI = [[1, 0], [0, 0]], 2 * [
                [1., 0.],
            ]
        else:
            FSC = np.ones(2, dtype='i')
            CSI = [np.zeros((2), dtype='i'), np.zeros(2)]
            if 'Crenel' in waveType:
                dF = np.zeros_like(tau)
            else:
                dF = fracFourier(tau, nH, delt2[:1], delt2[1:]).squeeze()
            dFT = np.zeros_like(dF)
            dFTP = []
            for i in SdIndx:
                sop = Sop[i]
                ssop = SSop[i]
                sdet, ssdet, dtau, dT, tauT = getTauT(tau, sop, ssop, XYZ)
                fsc = np.ones(2, dtype='i')
                if 'Crenel' in waveType:
                    dFT = np.zeros_like(tau)
                    fsc = [1, 1]
                else:  #Fourier
                    dFT = fracFourier(tauT, nH, delt2[:1], delt2[1:]).squeeze()
                    dFT = nl.det(sop[0]) * dFT
                    dFT = dFT[:, np.argsort(tauT)]
                    dFT[0] *= ssdet
                    dFT[1] *= sdet
                    dFTP.append(dFT)
                    if np.any(dtau % .5) and ('1/2' in SSGData['modSymb'] or
                                              '1' in SSGData['modSymb']):
                        fsc = [1, 1]
                        if dT:
                            CSI = [[[1, 0], [1, 0]], [[1., 0.], [1 / dT, 0.]]]
                        else:
                            CSI = [[[1, 0], [0, 0]], [[1., 0.], [0., 0.]]]
                        FSC = np.zeros(2, dtype='i')
                        return CSI, dF, dFTP
                    else:
                        for i in range(2):
                            if np.allclose(dF[i, :], dFT[i, :], atol=1.e-6):
                                fsc[i] = 1
                            else:
                                fsc[i] = 0
                        FSC &= fsc
                        if debug:
                            print(
                                SSMT2text(ssop).replace(' ', ''), sdet, ssdet,
                                epsinv, fsc)
            n = -1
            for i, F in enumerate(FSC):
                if F:
                    n += 1
                    CSI[0][i] = n + 1
                    CSI[1][i] = 1.0
        return CSI, dF, dFTP
    def DoXYZ():
        delt5 = np.ones(5) * 0.001
        delt6 = np.eye(6) * 0.001
        if 'Fourier' in waveType:
            dX = posFourier(tau, nH, delt6[:3],
                            delt6[3:])  #+np.array(XYZ)[:,nxs,nxs]
            #3x6x12 modulated position array (X,Spos,tau)& force positive
        elif waveType in ['ZigZag', 'Block']:
            if waveType == 'ZigZag':
                dX = posZigZag(tau, delt5[:2], delt5[2:])
            else:
                dX = posBlock(tau, delt5[:2], delt5[2:])
        dXTP = []
        if siteSym == '1':
            CSI = [[1, 0, 0], [2, 0, 0], [3, 0, 0], [4, 0, 0], [5, 0, 0],
                   [6, 0, 0]], 6 * [
                       [1., 0., 0.],
                   ]
        elif siteSym == '-1':
            CSI = [[1, 0, 0], [2, 0, 0], [3, 0, 0], [0, 0, 0], [0, 0, 0],
                   [0, 0, 0]], 3 * [
                       [1., 0., 0.],
                   ] + 3 * [
                       [0., 0., 0.],
                   ]
        else:
            if 'Fourier' in waveType:
                CSI = [np.zeros((6, 3), dtype='i'), np.zeros((6, 3))]
            elif waveType in ['ZigZag', 'Block']:
                CSI = [
                    np.array([[1, 0, 0], [2, 0, 0], [3, 0, 0], [4, 0, 0],
                              [5, 0, 0]]),
                    np.array([[1.0, .0, .0], [1.0, .0, .0], [1.0, .0, .0],
                              [1.0, .0, .0], [1.0, .0, .0]])
                ]
            XSC = np.ones(6, dtype='i')
            dXTP = []
            for i in SdIndx:
                sop = Sop[i]
                ssop = SSop[i]
                sdet, ssdet, dtau, dT, tauT = getTauT(tau, sop, ssop, XYZ)
                xsc = np.ones(6, dtype='i')
                if 'Fourier' in waveType:
                    dXT = posFourier(np.sort(tauT), nH, delt6[:3],
                                     delt6[3:])  #+np.array(XYZ)[:,nxs,nxs]
                elif waveType == 'ZigZag':
                    dXT = posZigZag(tauT, delt5[:2],
                                    delt5[2:]) + np.array(XYZ)[:, nxs, nxs]
                elif waveType == 'Block':
                    dXT = posBlock(tauT, delt5[:2],
                                   delt5[2:]) + np.array(XYZ)[:, nxs, nxs]
                dXT = np.inner(
                    sop[0],
                    dXT.T)  # X modulations array(3x6x49) -> array(3x49x6)
                dXT = np.swapaxes(dXT, 1, 2)  # back to array(3x6x49)
                dXT[:, :3, :] *= (ssdet * sdet)  # modify the sin component
                dXTP.append(dXT)
                if waveType == 'Fourier':
                    for i in range(3):
                        if not np.allclose(dX[i, i, :], dXT[i, i, :]):
                            xsc[i] = 0
                        if not np.allclose(dX[i, i + 3, :], dXT[i, i + 3, :]):
                            xsc[i + 3] = 0
                    if np.any(dtau % .5) and ('1/2' in SSGData['modSymb'] or
                                              '1' in SSGData['modSymb']):
                        xsc[3:6] = 0
                        CSI = [[[1, 0, 0], [2, 0, 0], [3, 0, 0], [1, 0, 0],
                                [2, 0, 0], [3, 0, 0]],
                               [[1., 0., 0.], [1., 0., 0.], [1., 0., 0.],
                                [1., 0., 0.], [1., 0., 0.], [1., 0., 0.]]]
                        if dT:
                            if '(x)' in siteSym:
                                CSI[1][3:] = [1. / dT, 0.,
                                              0.], [-dT, 0., 0.], [-dT, 0., 0.]
                                if 'm' in siteSym and len(SdIndx) == 1:
                                    CSI[1][3:] = [-dT, 0.,
                                                  0.], [1. / dT, 0.,
                                                        0.], [1. / dT, 0., 0.]
                            elif '(y)' in siteSym:
                                CSI[1][3:] = [-dT, 0., 0.], [1. / dT, 0.,
                                                             0.], [-dT, 0., 0.]
                                if 'm' in siteSym and len(SdIndx) == 1:
                                    CSI[1][3:] = [1. / dT, 0.,
                                                  0.], [-dT, 0.,
                                                        0.], [1. / dT, 0., 0.]
                            elif '(z)' in siteSym:
                                CSI[1][3:] = [-dT, 0.,
                                              0.], [-dT, 0.,
                                                    0.], [1. / dT, 0., 0.]
                                if 'm' in siteSym and len(SdIndx) == 1:
                                    CSI[1][3:] = [1. / dT, 0.,
                                                  0.], [1. / dT, 0.,
                                                        0.], [-dT, 0., 0.]
                        else:
                            CSI[1][3:] = [0., 0., 0.], [0., 0.,
                                                        0.], [0., 0., 0.]
                    if '4/mmm' in laue:
                        if np.any(dtau % .5) and '1/2' in SSGData['modSymb']:
                            if '(xy)' in siteSym:
                                CSI[0] = [[1, 0, 0], [1, 0, 0], [2, 0, 0],
                                          [1, 0, 0], [1, 0, 0], [2, 0, 0]]
                                if dT:
                                    CSI[1][3:] = [[1. / dT, 0., 0.],
                                                  [1. / dT, 0., 0.],
                                                  [-dT, 0., 0.]]
                                else:
                                    CSI[1][3:] = [0., 0.,
                                                  0.], [0., 0.,
                                                        0.], [0., 0., 0.]
                        if '(xy)' in siteSym or '(+-0)' in siteSym:
                            mul = 1
                            if '(+-0)' in siteSym:
                                mul = -1
                            if np.allclose(dX[0, 0, :], dXT[1, 0, :]):
                                CSI[0][3:5] = [[11, 0, 0], [11, 0, 0]]
                                CSI[1][3:5] = [[1., 0, 0], [mul, 0, 0]]
                                xsc[3:5] = 0
                            if np.allclose(dX[0, 3, :], dXT[0, 4, :]):
                                CSI[0][:2] = [[12, 0, 0], [12, 0, 0]]
                                CSI[1][:2] = [[1., 0, 0], [mul, 0, 0]]
                                xsc[:2] = 0
                else:
                    for i in range(3):
                        if not np.allclose(dX[:, i], dXT[i, :, i]):
                            xsc[i] = 0
                XSC &= xsc
                if debug:
                    print(
                        SSMT2text(ssop).replace(' ', ''), sdet, ssdet, epsinv,
                        xsc)
            if waveType == 'Fourier':
                n = -1
                if debug:
                    print(XSC)
                for i, X in enumerate(XSC):
                    if X:
                        n += 1
                        CSI[0][i][0] = n + 1
                        CSI[1][i][0] = 1.0
        return list(CSI), dX, dXTP
    def DoUij():
        delt12 = np.eye(12) * 0.0001
        dU = posFourier(tau, nH, delt12[:6],
                        delt12[6:])  #Uij modulations - 6x12x12 array
        dUTP = []
        if siteSym == '1':
            CSI = [[1, 0, 0], [2, 0, 0], [3, 0, 0], [4, 0, 0], [5, 0, 0],
                   [6, 0, 0], [7, 0, 0], [8, 0, 0], [9, 0, 0], [10, 0, 0],
                   [11, 0, 0], [12, 0, 0]], 12 * [
                       [1., 0., 0.],
                   ]
        elif siteSym == '-1':
            CSI = 6*[[0,0,0],]+[[1,0,0],[2,0,0],[3,0,0],[4,0,0],[5,0,0],[6,0,0]],   \
                
6*[[0.,0.,0.],]+[[1.,0.,0.],[1.,0.,0.],[1.,0.,0.],[1.,0.,0.],[1.,0.,0.],[1.,0.,0.]]
        else:
            CSI = [np.zeros((12, 3), dtype='i'), np.zeros((12, 3))]
            USC = np.ones(12, dtype='i')
            dUTP = []
            dtau = 0.
            for i in SdIndx:
                sop = Sop[i]
                ssop = SSop[i]
                sdet, ssdet, dtau, dT, tauT = getTauT(tau, sop, ssop, XYZ)
                usc = np.ones(12, dtype='i')
                dUT = posFourier(tauT, nH, delt12[:6],
                                 delt12[6:])  #Uij modulations - 6x12x49 array
                dUijT = np.rollaxis(np.rollaxis(np.array(Uij2U(dUT)), 3),
                                    3)  #convert dUT to 12x49x3x3
                dUijT = np.rollaxis(np.inner(np.inner(sop[0], dUijT), sop[0].T),
                                    3)  #transform by sop - 3x3x12x49
                dUT = np.array(U2Uij(dUijT))  #convert to 6x12x49
                dUT = dUT[:, :, np.argsort(tauT)]
                dUT[:, :6, :] *= (ssdet * sdet)
                dUTP.append(dUT)
                if np.any(dtau % .5) and ('1/2' in SSGData['modSymb'] or
                                          '1' in SSGData['modSymb']):
                    if dT:
                        CSI = [[[1, 0, 0], [2, 0, 0], [3, 0, 0], [4, 0, 0],
                                [5, 0, 0], [6, 0, 0], [1, 0, 0], [2, 0, 0],
                                [3, 0, 0], [4, 0, 0], [5, 0, 0], [6, 0, 0]],
                               [[1., 0., 0.], [1., 0., 0.], [1., 0., 0.],
                                [1., 0., 0.], [1., 0., 0.], [1., 0., 0.],
                                [1. / dT, 0., 0.], [1. / dT, 0., 0.],
                                [1. / dT, 0., 0.], [1., 0., 0.], [1., 0., 0.],
                                [1., 0., 0.]]]
                    else:
                        CSI = [[[1, 0, 0], [2, 0, 0], [3, 0, 0], [4, 0, 0],
                                [5, 0, 0], [6, 0, 0], [1, 0, 0], [2, 0, 0],
                                [3, 0, 0], [4, 0, 0], [5, 0, 0], [6, 0, 0]],
                               [[1., 0., 0.], [1., 0., 0.], [1., 0., 0.],
                                [1., 0., 0.], [1., 0., 0.], [1., 0., 0.],
                                [0., 0., 0.], [0., 0., 0.], [0., 0., 0.],
                                [1., 0., 0.], [1., 0., 0.], [1., 0., 0.]]]
                    if 'mm2(x)' in siteSym and dT:
                        CSI[1][9:] = [0., 0., 0.], [-dT, 0., 0.], [0., 0., 0.]
                        USC = [1, 1, 1, 0, 1, 0, 1, 1, 1, 0, 1, 0]
                    elif '(xy)' in siteSym and dT:
                        CSI[0] = [[1, 0, 0], [1, 0, 0], [2, 0, 0], [3, 0, 0],
                                  [4, 0, 0], [4, 0, 0], [1, 0, 0], [1, 0, 0],
                                  [2, 0, 0], [3, 0, 0], [4, 0, 0], [4, 0, 0]]
                        CSI[1][9:] = [[1. / dT, 0., 0.], [-dT, 0., 0.],
                                      [-dT, 0., 0.]]
                        USC = [1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1]
                    elif '(x)' in siteSym and dT:
                        CSI[1][9:] = [-dT, 0., 0.], [-dT, 0.,
                                                     0.], [1. / dT, 0., 0.]
                    elif '(y)' in siteSym and dT:
                        CSI[1][9:] = [-dT, 0., 0.], [1. / dT, 0.,
                                                     0.], [-dT, 0., 0.]
                    elif '(z)' in siteSym and dT:
                        CSI[1][9:] = [1. / dT, 0., 0.], [-dT, 0.,
                                                         0.], [-dT, 0., 0.]
                    for i in range(6):
                        if not USC[i]:
                            CSI[0][i] = [0, 0, 0]
                            CSI[1][i] = [0., 0., 0.]
                            CSI[0][i + 6] = [0, 0, 0]
                            CSI[1][i + 6] = [0., 0., 0.]
                else:
                    for i in range(6):
                        if not np.allclose(dU[i, i, :], dUT[i,
                                                            i, :]):  #sin part
                            usc[i] = 0
                        if not np.allclose(dU[i, i + 6, :],
                                           dUT[i, i + 6, :]):  #cos part
                            usc[i + 6] = 0
                    if np.any(dUT[1, 0, :]):
                        if '4/m' in siteSym:
                            CSI[0][6:8] = [[12, 0, 0], [12, 0, 0]]
                            if ssop[1][3]:
                                CSI[1][6:8] = [[1., 0., 0.], [-1., 0., 0.]]
                                usc[9] = 1
                            else:
                                CSI[1][6:8] = [[1., 0., 0.], [1., 0., 0.]]
                                usc[9] = 0
                        elif '4' in siteSym:
                            CSI[0][6:8] = [[12, 0, 0], [12, 0, 0]]
                            CSI[0][:2] = [[11, 0, 0], [11, 0, 0]]
                            if ssop[1][3]:
                                CSI[1][:2] = [[1., 0., 0.], [-1., 0., 0.]]
                                CSI[1][6:8] = [[1., 0., 0.], [-1., 0., 0.]]
                                usc[2] = 0
                                usc[8] = 0
                                usc[3] = 1
                                usc[9] = 1
                            else:
                                CSI[1][:2] = [[1., 0., 0.], [1., 0., 0.]]
                                CSI[1][6:8] = [[1., 0., 0.], [1., 0., 0.]]
                                usc[2] = 1
                                usc[8] = 1
                                usc[3] = 0
                                usc[9] = 0
                        elif 'xy' in siteSym or '+-0' in siteSym:
                            if np.allclose(dU[0, 0, :], dUT[0, 1, :] * sdet):
                                CSI[0][4:6] = [[12, 0, 0], [12, 0, 0]]
                                CSI[0][6:8] = [[11, 0, 0], [11, 0, 0]]
                                CSI[1][4:6] = [[1., 0., 0.], [sdet, 0., 0.]]
                                CSI[1][6:8] = [[1., 0., 0.], [sdet, 0., 0.]]
                                usc[4:6] = 0
                                usc[6:8] = 0
                    if debug:
                        print(
                            SSMT2text(ssop).replace(' ', ''), sdet, ssdet,
                            epsinv, usc)
                USC &= usc
            if debug:
                print(USC)
            if not np.any(dtau % .5):
                n = -1
                for i, U in enumerate(USC):
                    if U:
                        n += 1
                        CSI[0][i][0] = n + 1
                        CSI[1][i][0] = 1.0
        return list(CSI), dU, dUTP
    def DoMag():
        delt6 = np.eye(6) * 0.001
        dM = posFourier(tau, nH, delt6[:3],
                        delt6[3:])  #+np.array(Mxyz)[:,nxs,nxs]
        dMTP = []
        CSI = [np.zeros((6, 3), dtype='i'), np.zeros((6, 3))]
        if siteSym == '1':
            CSI = [[1, 0, 0], [2, 0, 0], [3, 0, 0], [4, 0, 0], [5, 0, 0],
                   [6, 0, 0]], 6 * [
                       [1., 0., 0.],
                   ]
        elif siteSym in [
                '-1',
                'mmm',
        ]:
            CSI = 3 * [
                [0, 0, 0],
            ] + [[1, 0, 0], [2, 0, 0], [3, 0, 0]], 3 * [
                [0., 0., 0.],
            ] + 3 * [
                [1., 0., 0.],
            ]
        elif siteSym in ['4(z)', '422(z)']:
            CSI[0][0][0] = CSI[0][4][1] = 1
            CSI[1][0][0] = 1.0
            CSI[1][4][1] = -1.0
        elif siteSym in [
                '-4m2(z)',
                '422(z)',
        ]:
            CSI[0][5][0] = 1
            CSI[1][5][0] = 1.0
        elif siteSym in [
                '-32(100)',
                '-3',
        ]:
            CSI[0][2][0] = 1
            CSI[1][2][0] = 1.0
        elif siteSym in [
                '3',
        ]:
            CSI[0][0][0] = CSI[0][3][0] = CSI[0][4][0] = 1
            CSI[1][0][0] = -np.sqrt(3.0)
            CSI[1][3][0] = 2.0
            CSI[1][4][0] = 1.0
        elif siteSym in [
                '622',
                '2(100)',
                '32(100)',
        ]:
            CSI[0][0][0] = CSI[0][1][0] = CSI[0][3][0] = 1
            CSI[1][0][0] = 1.0
            CSI[1][1][0] = 2.0
            CSI[1][3][0] = np.sqrt(3.0)
        else:
            #3x6x12 modulated moment array (M,Spos,tau)& force positive
            CSI = [np.zeros((6, 3), dtype='i'), np.zeros((6, 3))]
            MSC = np.ones(6, dtype='i')
            dMTP = []
            for i in SdIndx:
                sop = Sop[i]
                ssop = SSop[i]
                sdet, ssdet, dtau, dT, tauT = getTauT(tau, sop, ssop, XYZ)
                msc = np.ones(6, dtype='i')
                dMT = posFourier(np.sort(tauT), nH, delt6[:3],
                                 delt6[3:])  #+np.array(XYZ)[:,nxs,nxs]
                dMT = np.inner(
                    sop[0],
                    dMT.T)  # X modulations array(3x6x49) -> array(3x49x6)
                dMT = np.swapaxes(dMT, 1, 2)  # back to array(3x6x49)
                dMT[:, :3, :] *= (ssdet * sdet)  # modify the sin component
                dMTP.append(dMT)
                for i in range(3):
                    if not np.allclose(dM[i, i, :], sdet * dMT[i, i, :]):
                        msc[i] = 0
                    if not np.allclose(dM[i, i + 3, :],
                                       sdet * dMT[i, i + 3, :]):
                        msc[i + 3] = 0
                if np.any(dtau % .5) and ('1/2' in SSGData['modSymb'] or
                                          '1' in SSGData['modSymb']):
                    msc[3:6] = 0
                    CSI = [[[1, 0, 0], [2, 0, 0], [3, 0, 0], [1, 0, 0],
                            [2, 0, 0], [3, 0, 0]],
                           [[1., 0., 0.], [1., 0., 0.], [1., 0., 0.],
                            [1., 0., 0.], [1., 0., 0.], [1., 0., 0.]]]
                    if dT:
                        if '(x)' in siteSym:
                            CSI[1][3:] = [1. / dT, 0., 0.], [-dT, 0.,
                                                             0.], [-dT, 0., 0.]
                            if 'm' in siteSym and len(SdIndx) == 1:
                                CSI[1][3:] = [1. / dT, 0.,
                                              0.], [-dT, 0., 0.], [-dT, 0., 0.]
                        elif '(y)' in siteSym:
                            CSI[1][3:] = [-dT, 0., 0.], [1. / dT, 0.,
                                                         0.], [-dT, 0., 0.]
                            if 'm' in siteSym and len(SdIndx) == 1:
                                CSI[1][3:] = [-dT, 0., 0.], [1. / dT, 0.,
                                                             0.], [-dT, 0., 0.]
                        elif '(z)' in siteSym:
                            CSI[1][3:] = [-dT, 0., 0.], [-dT, 0.,
                                                         0.], [1. / dT, 0., 0.]
                            if 'm' in siteSym and len(SdIndx) == 1:
                                CSI[1][3:] = [-dT, 0.,
                                              0.], [-dT, 0.,
                                                    0.], [1. / dT, 0., 0.]
                    else:
                        CSI[1][3:] = [0., 0., 0.], [0., 0., 0.], [0., 0., 0.]
                if '4/mmm' in laue:
                    if siteSym in [
                            '4/mmm(z)',
                    ]:
                        CSI = 3 * [
                            [0, 0, 0],
                        ] + [[0, 0, 0], [0, 0, 0], [1, 0, 0]], 3 * [
                            [0., 0., 0.],
                        ] + 3 * [
                            [1., 0., 0.],
                        ]
                    if np.any(dtau % .5) and '1/2' in SSGData['modSymb']:
                        if '(xy)' in siteSym:
                            CSI[0] = [[1, 0, 0], [1, 0, 0], [2, 0, 0],
                                      [1, 0, 0], [1, 0, 0], [2, 0, 0]]
                            if dT:
                                CSI[1][3:] = [[1. / dT, 0., 0.],
                                              [1. / dT, 0., 0.], [-dT, 0., 0.]]
                            else:
                                CSI[1][3:] = [0., 0., 0.], [0., 0.,
                                                            0.], [0., 0., 0.]
                    if '(xy)' in siteSym or '(+-0)' in siteSym:
                        mul = 1
                        if '(+-0)' in siteSym:
                            mul = -1
                        if np.allclose(dM[0, 0, :], dMT[1, 0, :]):
                            CSI[0][3:5] = [[11, 0, 0], [11, 0, 0]]
                            CSI[1][3:5] = [[1., 0, 0], [mul, 0, 0]]
                            msc[3:5] = 0
                        if np.allclose(dM[0, 3, :], dMT[0, 4, :]):
                            CSI[0][:2] = [[12, 0, 0], [12, 0, 0]]
                            CSI[1][:2] = [[1., 0, 0], [mul, 0, 0]]
                            msc[:2] = 0
                MSC &= msc
                if debug:
                    print(
                        SSMT2text(ssop).replace(' ', ''), sdet, ssdet, epsinv,
                        msc)
            n = -1
            if debug:
                print(MSC)
            for i, M in enumerate(MSC):
                if M:
                    n += 1
                    CSI[0][i][0] = n + 1
                    CSI[1][i][0] = 1.0
        return list(CSI), dM, dMTP
    if debug:
        print('super space group: ' + SSGData['SSpGrp'])
    xyz = np.array(XYZ) % 1.
    SGOps = copy.deepcopy(SGData['SGOps'])
    laue = SGData['SGLaue']
    siteSym = SytSym(XYZ, SGData)[0].strip()
    if debug:
        print('siteSym: ' + siteSym)
    SSGOps = copy.deepcopy(SSGData['SSGOps'])
    #expand ops to include inversions if any
    if SGData['SGInv'] and not SGData['SGFixed']:
        for op, sop in zip(SGData['SGOps'], SSGData['SSGOps']):
            SGOps.append([-op[0], -op[1] % 1.])
            SSGOps.append([-sop[0], -sop[1] % 1.])
    #build set of sym ops around special position
    SSop = []
    Sop = []
    Sdtau = []
    for iop, Op in enumerate(SGOps):
        nxyz = (np.inner(Op[0], xyz) + Op[1]) % 1.
        if np.allclose(
                xyz, nxyz,
                1.e-4) and iop and MT2text(Op).replace(' ', '') != '-X,-Y,-Z':
            SSop.append(SSGOps[iop])
            Sop.append(SGOps[iop])
            ssopinv = nl.inv(SSGOps[iop][0])
            mst = ssopinv[3][:3]
            epsinv = ssopinv[3][3]
            Sdtau.append(
                np.sum(mst * (XYZ - SGOps[iop][1]) -
                       epsinv * SSGOps[iop][1][3]))
    SdIndx = np.argsort(np.array(Sdtau))  # just to do in sensible order
    if debug:
        print('special pos super operators: ',
              [SSMT2text(ss).replace(' ', '') for ss in SSop])
    #setup displacement arrays
    tau = np.linspace(-1, 1, 49, True)
    #make modulation arrays - one parameter at a time
    if Stype == 'Sfrac':
        CSI, dF, dFTP = DoFrac()
    elif Stype == 'Spos':
        CSI, dF, dFTP = DoXYZ()
        CSI[0] = orderParms(CSI[0])
    elif Stype == 'Sadp':
        CSI, dF, dFTP = DoUij()
        CSI[0] = orderParms(CSI[0])
    elif Stype == 'Smag':
        CSI, dF, dFTP = DoMag()
    if debug:
        return CSI, dF, dFTP
    else:
        return CSI, [], [] 
[docs]def MustrainNames(SGData):
    'Needs a doc string'
    laue = SGData['SGLaue']
    uniq = SGData['SGUniq']
    if laue in ['m3', 'm3m']:
        return ['S400', 'S220']
    elif laue in ['6/m', '6/mmm', '3m1']:
        return ['S400', 'S004', 'S202']
    elif laue in ['31m', '3']:
        return ['S400', 'S004', 'S202', 'S301']
    elif laue in ['3R', '3mR']:
        return ['S400', 'S220', 'S310', 'S211']
    elif laue in ['4/m', '4/mmm']:
        return ['S400', 'S004', 'S220', 'S022']
    elif laue in ['mmm']:
        return ['S400', 'S040', 'S004', 'S220', 'S202', 'S022']
    elif laue in ['2/m']:
        SHKL = ['S400', 'S040', 'S004', 'S220', 'S202', 'S022']
        if uniq == 'a':
            SHKL += ['S013', 'S031', 'S211']
        elif uniq == 'b':
            SHKL += ['S301', 'S103', 'S121']
        elif uniq == 'c':
            SHKL += ['S130', 'S310', 'S112']
        return SHKL
    else:
        SHKL = ['S400', 'S040', 'S004', 'S220', 'S202', 'S022']
        SHKL += ['S310', 'S103', 'S031', 'S130', 'S301', 'S013']
        SHKL += ['S211', 'S121', 'S112']
        return SHKL 
[docs]def HStrainVals(HSvals, SGData):
    laue = SGData['SGLaue']
    uniq = SGData['SGUniq']
    DIJ = np.zeros(6)
    if laue in ['m3', 'm3m']:
        DIJ[:3] = [HSvals[0], HSvals[0], HSvals[0]]
    elif laue in ['6/m', '6/mmm', '3m1', '31m', '3']:
        DIJ[:4] = [HSvals[0], HSvals[0], HSvals[1], HSvals[0]]
    elif laue in ['3R', '3mR']:
        DIJ = [HSvals[0], HSvals[0], HSvals[0], HSvals[1], HSvals[1], HSvals[1]]
    elif laue in ['4/m', '4/mmm']:
        DIJ[:3] = [HSvals[0], HSvals[0], HSvals[1]]
    elif laue in ['mmm']:
        DIJ[:3] = [HSvals[0], HSvals[1], HSvals[2]]
    elif laue in ['2/m']:
        DIJ[:3] = [HSvals[0], HSvals[1], HSvals[2]]
        if uniq == 'a':
            DIJ[5] = HSvals[3]
        elif uniq == 'b':
            DIJ[4] = HSvals[3]
        elif uniq == 'c':
            DIJ[3] = HSvals[3]
    else:
        DIJ = [HSvals[0], HSvals[1], HSvals[2], HSvals[3], HSvals[4], HSvals[5]]
    return DIJ 
[docs]def HStrainNames(SGData):
    'Needs a doc string'
    laue = SGData['SGLaue']
    uniq = SGData['SGUniq']
    if laue in ['m3', 'm3m']:
        return ['D11', 'eA']  #add cubic strain term
    elif laue in ['6/m', '6/mmm', '3m1', '31m', '3']:
        return ['D11', 'D33']
    elif laue in ['3R', '3mR']:
        return ['D11', 'D12']
    elif laue in ['4/m', '4/mmm']:
        return ['D11', 'D33']
    elif laue in ['mmm']:
        return ['D11', 'D22', 'D33']
    elif laue in ['2/m']:
        Dij = ['D11', 'D22', 'D33']
        if uniq == 'a':
            Dij += ['D23']
        elif uniq == 'b':
            Dij += ['D13']
        elif uniq == 'c':
            Dij += ['D12']
        return Dij
    else:
        Dij = ['D11', 'D22', 'D33', 'D12', 'D13', 'D23']
        return Dij 
[docs]def MustrainCoeff(HKL, SGData):
    'Needs a doc string'
    #NB: order of terms is the same as returned by MustrainNames
    laue = SGData['SGLaue']
    uniq = SGData['SGUniq']
    h, k, l = HKL
    Strm = []
    if laue in ['m3', 'm3m']:
        Strm.append(h**4 + k**4 + l**4)
        Strm.append(3.0 * ((h * k)**2 + (h * l)**2 + (k * l)**2))
    elif laue in ['6/m', '6/mmm', '3m1']:
        Strm.append(h**4 + k**4 + 2.0 * k * h**3 + 2.0 * h * k**3 + 3.0 *
                    (h * k)**2)
        Strm.append(l**4)
        Strm.append(3.0 * ((h * l)**2 + (k * l)**2 + h * k * l**2))
    elif laue in ['31m', '3']:
        Strm.append(h**4 + k**4 + 2.0 * k * h**3 + 2.0 * h * k**3 + 3.0 *
                    (h * k)**2)
        Strm.append(l**4)
        Strm.append(3.0 * ((h * l)**2 + (k * l)**2 + h * k * l**2))
        Strm.append(4.0 * l * h**3)
    elif laue in ['3R', '3mR']:
        Strm.append(h**4 + k**4 + l**4)
        Strm.append(3.0 * ((h * k)**2 + (h * l)**2 + (k * l)**2))
        Strm.append(2.0 * (h * l**3 + l * k**3 + k * h**3) + 2.0 *
                    (l * h**3 + k * l**3 + l * k**3))
        Strm.append(4.0 * (k * l * h**2 + h * l * k**2 + h * k * l**2))
    elif laue in ['4/m', '4/mmm']:
        Strm.append(h**4 + k**4)
        Strm.append(l**4)
        Strm.append(3.0 * (h * k)**2)
        Strm.append(3.0 * ((h * l)**2 + (k * l)**2))
    elif laue in ['mmm']:
        Strm.append(h**4)
        Strm.append(k**4)
        Strm.append(l**4)
        Strm.append(3.0 * (h * k)**2)
        Strm.append(3.0 * (h * l)**2)
        Strm.append(3.0 * (k * l)**2)
    elif laue in ['2/m']:
        Strm.append(h**4)
        Strm.append(k**4)
        Strm.append(l**4)
        Strm.append(3.0 * (h * k)**2)
        Strm.append(3.0 * (h * l)**2)
        Strm.append(3.0 * (k * l)**2)
        if uniq == 'a':
            Strm.append(2.0 * k * l**3)
            Strm.append(2.0 * l * k**3)
            Strm.append(4.0 * k * l * h**2)
        elif uniq == 'b':
            Strm.append(2.0 * l * h**3)
            Strm.append(2.0 * h * l**3)
            Strm.append(4.0 * h * l * k**2)
        elif uniq == 'c':
            Strm.append(2.0 * h * k**3)
            Strm.append(2.0 * k * h**3)
            Strm.append(4.0 * h * k * l**2)
    else:
        Strm.append(h**4)
        Strm.append(k**4)
        Strm.append(l**4)
        Strm.append(3.0 * (h * k)**2)
        Strm.append(3.0 * (h * l)**2)
        Strm.append(3.0 * (k * l)**2)
        Strm.append(2.0 * k * h**3)
        Strm.append(2.0 * h * l**3)
        Strm.append(2.0 * l * k**3)
        Strm.append(2.0 * h * k**3)
        Strm.append(2.0 * l * h**3)
        Strm.append(2.0 * k * l**3)
        Strm.append(4.0 * k * l * h**2)
        Strm.append(4.0 * h * l * k**2)
        Strm.append(4.0 * k * h * l**2)
    return Strm 
[docs]def MuShklMean(SGData, Amat, Shkl):
    def genMustrain(xyz, Shkl):
        uvw = np.inner(Amat.T, xyz)
        Strm = np.array(MustrainCoeff(uvw, SGData))
        Sum = np.sum(np.multiply(Shkl, Strm))
        Sum = np.where(Sum > 0.01, Sum, 0.01)
        Sum = np.sqrt(Sum)
        return Sum * xyz
    PHI = np.linspace(0., 360., 30, True)
    PSI = np.linspace(0., 180., 30, True)
    X = np.outer(npcosd(PHI), npsind(PSI))
    Y = np.outer(npsind(PHI), npsind(PSI))
    Z = np.outer(np.ones(np.size(PHI)), npcosd(PSI))
    XYZ = np.dstack((X, Y, Z))
    XYZ = np.nan_to_num(np.apply_along_axis(genMustrain, 2, XYZ, Shkl))
    return np.sqrt(np.sum(XYZ**2) / 900.) 
[docs]def Muiso2Shkl(muiso, SGData, cell):
    "this is to convert isotropic mustrain to generalized Shkls"
    import GSASIIlattice as G2lat
    A = G2lat.cell2AB(cell)[0]
    def minMus(Shkl, muiso, H, SGData, A):
        U = np.inner(A.T, H)
        S = np.array(MustrainCoeff(U, SGData))
        nS = S.shape[0]
        Sum = np.sqrt(np.sum(np.multiply(S, Shkl[:nS, nxs]), axis=0))
        rad = np.sqrt(np.sum((Sum[:, nxs] * H)**2, axis=1))
        return (muiso - rad)**2
    laue = SGData['SGLaue']
    PHI = np.linspace(0., 360., 60, True)
    PSI = np.linspace(0., 180., 60, True)
    X = np.outer(npsind(PHI), npsind(PSI))
    Y = np.outer(npcosd(PHI), npsind(PSI))
    Z = np.outer(np.ones(np.size(PHI)), npcosd(PSI))
    HKL = np.dstack((X, Y, Z))
    if laue in ['m3', 'm3m']:
        S0 = [1000., 1000.]
    elif laue in ['6/m', '6/mmm']:
        S0 = [1000., 1000., 1000.]
    elif laue in ['31m', '3', '3m1']:
        S0 = [1000., 1000., 1000., 1000.]
    elif laue in ['3R', '3mR']:
        S0 = [1000., 1000., 1000., 1000.]
    elif laue in ['4/m', '4/mmm']:
        S0 = [1000., 1000., 1000., 1000.]
    elif laue in ['mmm']:
        S0 = [1000., 1000., 1000., 1000., 1000., 1000.]
    elif laue in ['2/m']:
        S0 = [1000., 1000., 1000., 0., 0., 0., 0., 0., 0.]
    else:
        S0 = [
            1000., 1000., 1000., 1000., 1000., 1000., 1000., 1000., 1000.,
            1000., 1000., 1000., 0., 0., 0.
        ]
    S0 = np.array(S0)
    HKL = np.reshape(HKL, (-1, 3))
    result = so.leastsq(minMus, S0,
                        (np.ones(HKL.shape[0]) * muiso, HKL, SGData, A))
    return result[0] 
[docs]def PackRot(SGOps):
    IRT = []
    for ops in SGOps:
        M = ops[0]
        irt = 0
        for j in range(2, -1, -1):
            for k in range(2, -1, -1):
                irt *= 3
                irt += M[k][j]
        IRT.append(int(irt))
    return IRT 
[docs]def SytSym(XYZ, SGData):
    '''
    Generates the number of equivalent positions and a site symmetry code for a specified coordinate and space group
    :param XYZ: an array, tuple or list containing 3 elements: x, y & z
    :param SGData: from SpcGroup
    :Returns: a four element tuple:
     * The 1st element is a code for the site symmetry (see GetKNsym)
     * The 2nd element is the site multiplicity
     * Ndup number of overlapping operators
     * dupDir Dict - dictionary of overlapping operators
    '''
    Mult = 1
    Isym = 0
    if SGData['SGLaue'] in ['3', '3m1', '31m', '6/m', '6/mmm']:
        Isym = 1073741824
    Jdup = 0
    Ndup = 0
    dupDir = {}
    inv = SGData['SGInv'] + 1
    icen = SGData['SGCen']
    Ncen = len(icen)
    if SGData['SGFixed']:  #already in list of operators
        inv = 1
    if SGData['SGGray'] and Ncen > 1:
        Ncen //= 2
    Xeqv = list(GenAtom(XYZ, SGData, True))
    #    for xeqv in Xeqv:   print(xeqv)
    IRT = PackRot(SGData['SGOps'])
    L = -1
    for ic, cen in enumerate(icen[:Ncen]):
        for invers in range(int(inv)):
            for io, ops in enumerate(SGData['SGOps']):
                irtx = (1 - 2 * invers) * IRT[io]
                L += 1
                if not Xeqv[L][1]:
                    Ndup = io
                    Jdup += 1
                    jx = GetOprPtrNumber(
                        str(irtx))  #[KN table no,op name,KNsym ptr]
                    if jx < 39:
                        px = GetOprName(str(irtx))
                        if Xeqv[L][-1] < 0:
                            if '(' in px:
                                px = px.split('(')
                                px[0] += "'"
                                px = '('.join(px)
                            else:
                                px += "'"
                        dupDir[px] = L
                        Isym += 2**(jx - 1)
    if Isym == 1073741824:
        Isym = 0
    Mult = len(SGData['SGOps']) * Ncen * inv // Jdup
    return GetKNsym(str(Isym)), Mult, Ndup, dupDir 
[docs]def MagSytSym(SytSym, dupDir, SGData):
    '''
    site sym operations: 1,-1,2,3,-3,4,-4,6,-6,m need to be marked if spin inversion
    '''
    SGData['GenSym'], SGData['GenFlg'] = GetGenSym(SGData)[:2]
    #    print('SGPtGrp',SGData['SGPtGrp'],'SytSym',SytSym,'MagSpGrp',SGData['MagSpGrp'])
    #    print('dupDir',dupDir)
    SplitSytSym = SytSym.split('(')
    if SGData['SGGray']:
        return SytSym + "1'"
    if SytSym == '1':  #genersl position
        return SytSym
    if SplitSytSym[0] == SGData['SGPtGrp']:  #simple cases
        try:
            MagSytSym = SGData['MagSpGrp'].split()[1]
        except IndexError:
            MagSytSym = SGData['MagSpGrp'][1:].strip("1'")
        if len(SplitSytSym) > 1:
            MagSytSym += '(' + SplitSytSym[1]
        return MagSytSym
    if len(dupDir) == 1:
        return list(dupDir.keys())[0]
    if '2/m' in SytSym:  #done I think; last 2wo might be not needed
        ops = {
            '(x)': ['2(x)', 'm(x)'],
            '(y)': ['2(y)', 'm(y)'],
            '(z)': ['2(z)', 'm(z)'],
            '(100)': ['2(100)', 'm(100)'],
            '(010)': ['2(010)', 'm(010)'],
            '(001)': ['2(001)', 'm(001)'],
            '(120)': ['2(120)', 'm(120)'],
            '(210)': ['2(210)', 'm(210)'],
            '(+-0)': ['2(+-0)', 'm(+-0)'],
            '(110)': ['2(110)', 'm(110)']
        }
    elif '4/mmm' in SytSym:
        ops = {
            '(x)': ['4(x)', 'm(x)', 'm(y)', 'm(0+-)'],  #m(0+-) for cubic m3m?
            '(y)': ['4(y)', 'm(y)', 'm(z)', 'm(+0-)'],  #m(+0-)
            '(z)': ['4(z)', 'm(z)', 'm(x)', 'm(+-0)']
        }  #m(+-0)
    elif '4mm' in SytSym:
        ops = {
            '(x)': ['4(x)', 'm(y)', 'm(yz)'],
            '(y)': ['4(y)', 'm(z)', 'm(xz)'],
            '(z)': ['4(z)', 'm(x)', 'm(110)']
        }
    elif '422' in SytSym:
        ops = {
            '(x)': ['4(x)', '2(y)', '2(yz)'],
            '(y)': ['4(y)', '2(z)', '2(xz)'],
            '(z)': ['4(z)', '2(x)', '2(110)']
        }
    elif '-4m2' in SytSym:
        ops = {
            '(x)': ['-4(x)', 'm(x)', '2(yz)'],
            '(y)': ['-4(y)', 'm(y)', '2(xz)'],
            '(z)': ['-4(z)', 'm(z)', '2(110)']
        }
    elif '-42m' in SytSym:
        ops = {
            '(x)': ['-4(x)', '2(y)', 'm(yz)'],
            '(y)': ['-4(y)', '2(z)', 'm(xz)'],
            '(z)': ['-4(z)', '2(x)', 'm(110)']
        }
    elif '-4' in SytSym:
        ops = {
            '(x)': ['-4(x)',],
            '(y)': ['-4(y)',],
            '(z)': ['-4(z)',],
        }
    elif '4' in SytSym:
        ops = {
            '(x)': ['4(x)',],
            '(y)': ['4(y)',],
            '(z)': ['4(z)',],
        }
    elif '222' in SytSym:
        ops = {
            '': ['2(x)', '2(y)', '2(z)'],
            '(x)': ['2(y)', '2(z)', '2(x)'],
            '(y)': ['2(x)', '2(z)', '2(y)'],
            '(z)': ['2(x)', '2(y)', '2(z)'],
            '(100)': [
                '2(z)',
                '2(100)',
                '2(120)',
            ],
            '(010)': [
                '2(z)',
                '2(010)',
                '2(210)',
            ],
            '(110)': [
                '2(z)',
                '2(110)',
                '2(+-0)',
            ],
        }
    elif 'mm2' in SytSym:
        ops = {
            '(x)': ['m(y)', 'm(z)', '2(x)'],
            '(y)': ['m(x)', 'm(z)', '2(y)'],
            '(z)': ['m(x)', 'm(y)', '2(z)'],
            '(xy)': ['m(+-0)', 'm(z)', '2(110)'],
            '(yz)': ['m(0+-)', 'm(xz)', '2(yz)'],  #not 2(xy)!
            '(xz)': ['m(+0-)', 'm(y)', '2(xz)'],
            '(z100)': ['m(100)', 'm(120)', '2(z)'],
            '(z010)': ['m(010)', 'm(210)', '2(z)'],
            '(z110)': ['m(110)', 'm(+-0)', '2(z)'],
            '(+-0)': ['m(110)', 'm(z)', '2(+-0)'],
            '(d100)': ['m(yz)', 'm(0+-)', '2(xz)'],
            '(d010)': ['m(xz)', 'm(+0-)', '2(y)'],
            '(d001)': ['m(110)', 'm(+-0)', '2(z)'],
            '(210)': ['m(z)', 'm(010)', '2(210)'],
            '(120)': ['m(z)', 'm(100)', '2(120)'],
            '(100)': [
                'm(z)',
                'm(120)',
                '2(100)',
            ],
            '(010)': [
                'm(z)',
                'm(210)',
                '2(010)',
            ],
            '(110)': [
                'm(z)',
                'm(+-0)',
                '2(110)',
            ],
        }
    elif 'mmm' in SytSym:
        ops = {
            '': ['m(x)', 'm(y)', 'm(z)'],
            '(100)': [
                'm(z)',
                'm(100)',
                'm(120)',
            ],
            '(010)': [
                'm(z)',
                'm(010)',
                'm(210)',
            ],
            '(110)': [
                'm(z)',
                'm(110)',
                'm(+-0)',
            ],
            '(x)': ['m(x)', 'm(y)', 'm(z)'],
            '(y)': ['m(x)', 'm(y)', 'm(z)'],
            '(z)': ['m(x)', 'm(y)', 'm(z)'],
        }
    elif '32' in SytSym:
        ops = {
            '(120)': [
                '3',
                '2(120)',
            ],
            '(100)': ['3', '2(100)'],
            '(111)': ['3(111)', '2(x)']
        }
    elif '23' in SytSym:
        ops = {'': ['2(x)', '3(111)']}
    elif 'm3' in SytSym:
        ops = {'(100)': ['(+-0)',], '(+--)': [], '(-+-)': [], '(--+)': []}
    elif '3m' in SytSym:
        ops = {
            '(111)': [
                '3(111)',
                'm(+-0)',
            ],
            '(+--)': [
                '3(+--)',
                'm(0+-)',
            ],
            '(-+-)': [
                '3(-+-)',
                'm(+0-)',
            ],
            '(--+)': [
                '3(--+)',
                'm(+-0)',
            ],
            '(100)': ['3', 'm(100)'],
            '(120)': [
                '3',
                'm(210)',
            ]
        }
    if SytSym.split('(')[0] in [
            '6/m',
            '6mm',
            '-6m2',
            '622',
            '-6',
            '-3',
            '-3m',
            '-43m',
    ]:  #not simple cases
        MagSytSym = SytSym
        if "-1'" in dupDir:
            if '-6' in SytSym:
                MagSytSym = MagSytSym.replace('-6', "-6'")
            elif '-3m' in SytSym:
                MagSytSym = MagSytSym.replace('-3m', "-3'm'")
            elif '-3' in SytSym:
                MagSytSym = MagSytSym.replace('-3', "-3'")
        elif '-6m2' in SytSym:
            if "m'(110)" in dupDir:
                MagSytSym = "-6m'2'(" + SytSym.split('(')[1]
        elif '6/m' in SytSym:
            if "m'(z)" in dupDir:
                MagSytSym = "6'/m'"
        elif '6mm' in SytSym:
            if "m'(110)" in dupDir:
                MagSytSym = "6'm'm"
        elif '-43m' in SytSym:
            if "m'(110)" in dupDir:
                MagSytSym = "-43m'"
        return MagSytSym
    try:
        axis = '(' + SytSym.split('(')[1]
    except IndexError:
        axis = ''
    MagSytSym = ''
    for m in ops[axis]:
        if m in dupDir:
            MagSytSym += m.split('(')[0]
        else:
            MagSytSym += m.split('(')[0] + "'"
        if '2/m' in SytSym and '2' in m:
            MagSytSym += '/'
        if '-3/m' in SytSym:
            MagSytSym = '-' + MagSytSym
    MagSytSym += axis
    # some exceptions & special rules
    if MagSytSym == "4'/m'm'm'":
        MagSytSym = "4/m'm'm'"
    return MagSytSym
    #    if len(GenSym) == 3:
    #        if SGSpin[1] < 0:
    #            if 'mm2' in SytSym:
    #                MagSytSym = "m'm'2"+'('+SplitSytSym[1]
    #            else:   #bad rule for I41/a
    #                MagSytSym = SplitSytSym[0]+"'"
    #                if len(SplitSytSym) > 1:
    #                    MagSytSym += '('+SplitSytSym[1]
    #        else:
    #            MagSytSym = SytSym
    #        if len(SplitSytSym) >1:
    #            if "-4'"+'('+SplitSytSym[1] in dupDir:
    #                MagSytSym = MagSytSym.replace('-4',"-4'")
    #            if "-6'"+'('+SplitSytSym[1] in dupDir:
    #                MagSytSym = MagSytSym.replace('-6',"-6'")
    #        return MagSytSym
    #
    return SytSym 
[docs]def UpdateSytSym(Phase):
    ''' Update site symmetry/site multiplicity after space group/BNS lattice change
    '''
    generalData = Phase['General']
    SGData = generalData['SGData']
    Atoms = Phase['Atoms']
    cx, ct, cs, cia = generalData['AtomPtrs']
    for atom in Atoms:
        XYZ = atom[cx:cx + 3]
        sytsym, Mult = SytSym(XYZ, SGData)[:2]
        sytSym, Mul, Nop, dupDir = SytSym(XYZ, SGData)
        atom[cs] = sytsym
        if generalData['Type'] == 'magnetic':
            magSytSym = MagSytSym(sytSym, dupDir, SGData)
            atom[cs] = magSytSym
        atom[cs + 1] = Mult
    return 
[docs]def ElemPosition(SGData):
    ''' Under development.
    Object here is to return a list of symmetry element types and locations suitable
    for say drawing them.
    So far I have the element type... getting all possible locations without lookup may be impossible!
    '''
    Inv = SGData['SGInv']
    eleSym = {
        -3: ['', '-1'],
        -2: ['', -6],
        -1: ['2', '-4'],
        0: ['3', '-3'],
        1: ['4', 'm'],
        2: ['6', ''],
        3: ['1', '']
    }
    # get operators & expand if centrosymmetric
    SymElements = []
    Ops = SGData['SGOps']
    opM = np.array([op[0].T for op in Ops])
    opT = np.array([op[1] for op in Ops])
    if Inv:
        opM = np.concatenate((opM, -opM))
        opT = np.concatenate((opT, -opT))
    opMT = list(zip(opM, opT))
    for M, T in opMT[1:]:  #skip I
        Dt = int(nl.det(M))
        Tr = int(np.trace(M))
        Dt = -(Dt - 1) // 2
        Es = eleSym[Tr][Dt]
        if Dt:  #rotation-inversion
            I = np.eye(3)
            if Tr == 1:  #mirrors/glides
                if np.any(T):  #glide
                    M2 = np.inner(M, M)
                    MT = np.inner(M, T) + T
                    print('glide', Es, MT)
                    print(M2)
                else:  #mirror
                    print('mirror', Es, T)
                    print(I - M)
                X = [-1, -1, -1]
            elif Tr == -3:  # pure inversion
                X = np.inner(nl.inv(I - M), T)
                print('inversion', Es, X)
            else:  #other rotation-inversion
                M2 = np.inner(M, M)
                MT = np.inner(M, T) + T
                print('rot-inv', Es, MT)
                print(M2)
                X = [-1, -1, -1]
        else:  #rotations
            print('rotation', Es)
            X = [-1, -1, -1]
        SymElements.append([Es, X])
    return SymElements 
[docs]def ApplyStringOps(A, SGData, X, Uij=[]):
    'Needs a doc string'
    SGOps = SGData['SGOps']
    SGCen = SGData['SGCen']
    Ax = A.split('+')
    Ax[0] = int(Ax[0])
    iC = 1
    if Ax[0] < 0:
        iC = -1
    Ax[0] = abs(Ax[0])
    nA = Ax[0] % 100 - 1
    cA = Ax[0] // 100
    Cen = SGCen[cA]
    M, T = SGOps[nA]
    if len(Ax) > 1:
        cellA = Ax[1].split(',')
        cellA = np.array([int(a) for a in cellA])
    else:
        cellA = np.zeros(3)
    newX = Cen + iC * (np.inner(M, X).T + T) + cellA
    if len(Uij):
        U = Uij2U(Uij)
        U = np.inner(M, np.inner(U, M).T)
        newUij = U2Uij(U)
        return [newX, newUij]
    else:
        return newX 
[docs]def ApplyStringOpsMom(A, SGData, Mom):
    'Needs a doc string'
    SGOps = SGData['SGOps']
    Ax = A.split('+')
    Ax[0] = int(Ax[0])
    iAx = abs(Ax[0])
    nA = iAx % 100 - 1
    if SGData['SGInv'] and not SGData['SGFixed']:
        nC = 2 * len(SGOps) * (iAx // 100)
    else:
        nC = len(SGOps) * (iAx // 100)
    NA = nA
    if Ax[0] < 0:
        NA += len(SGOps)
    M, T = SGOps[nA]
    if SGData['SGGray']:
        newMom = -np.inner(Mom, M).T * nl.det(M) * SGData['SpnFlp'][NA + nC]
    else:
        newMom = np.inner(Mom, M).T * nl.det(M) * SGData['SpnFlp'][NA + nC]
#        print(len(SGOps),Ax[0],iAx,nC,nA,NA,MT2text([M,T]).replace(' ',''),SGData['SpnFlp'][NA],Mom,newMom)
#    print(Mom,newMom,MT2text([M,T]),)
    return newMom 
[docs]def StringOpsProd(A, B, SGData):
    """
    Find A*B where A & B are in strings '-' + '100*c+n' + '+ijk'
    where '-' indicates inversion, c(>0) is the cell centering operator,
    n is operator number from SgOps and ijk are unit cell translations (each may be <0).
    Should return resultant string - C. SGData - dictionary using entries:
       *  'SGCen': cell centering vectors [0,0,0] at least
       *  'SGOps': symmetry operations as [M,T] so that M*x+T = x'
    """
    SGOps = SGData['SGOps']
    SGCen = SGData['SGCen']
    #1st split out the cell translation part & work on the operator parts
    Ax = A.split('+')
    Bx = B.split('+')
    Ax[0] = int(Ax[0])
    Bx[0] = int(Bx[0])
    iC = 0
    if Ax[0] * Bx[0] < 0:
        iC = 1
    Ax[0] = abs(Ax[0])
    Bx[0] = abs(Bx[0])
    nA = Ax[0] % 100 - 1
    nB = Bx[0] % 100 - 1
    cA = Ax[0] // 100
    cB = Bx[0] // 100
    Cen = (SGCen[cA] + SGCen[cB]) % 1.0
    cC = np.nonzero([np.allclose(C, Cen) for C in SGCen])[0][0]
    Ma, Ta = SGOps[nA]
    Mb, Tb = SGOps[nB]
    Mc = np.inner(Ma, Mb.T)
    #    print Ma,Mb,Mc
    Tc = (np.add(np.inner(Mb, Ta) + 1., Tb)) % 1.0
    #    print Ta,Tb,Tc
    #    print [np.allclose(M,Mc)&np.allclose(T,Tc) for M,T in SGOps]
    nC = np.nonzero([np.allclose(M, Mc) & np.allclose(T, Tc) for M, T in SGOps
                    ])[0][0]
    #now the cell translation part
    if len(Ax) > 1:
        cellA = Ax[1].split(',')
        cellA = [int(a) for a in cellA]
    else:
        cellA = [0, 0, 0]
    if len(Bx) > 1:
        cellB = Bx[1].split(',')
        cellB = [int(b) for b in cellB]
    else:
        cellB = [0, 0, 0]
    cellC = np.add(cellA, cellB)
    C = str(((nC+1)+(100*cC))*(1-2*iC))+'+'+ \
        
str(int(cellC[0]))+','+str(int(cellC[1]))+','+str(int(cellC[2]))
    return C 
[docs]def U2Uij(U):
    #returns the UIJ vector U11,U22,U33,U12,U13,U23 from tensor U
    return [U[0][0], U[1][1], U[2][2], U[0][1], U[0][2], U[1][2]] 
[docs]def Uij2U(Uij):
    #returns the thermal motion tensor U from Uij as numpy array
    return np.array([[Uij[0], Uij[3], Uij[4]], [Uij[3], Uij[1], Uij[5]],
                     [Uij[4], Uij[5], Uij[2]]]) 
[docs]def StandardizeSpcName(spcgroup):
    '''Accept a spacegroup name where spaces may have not been used
    in the names according to the GSAS convention (spaces between symmetry
    for each axis) and return the space group name as used in GSAS
    '''
    rspc = spcgroup.replace(' ', '').upper()
    # deal with rhombohedral and hexagonal setting designations
    rhomb = ''
    if rspc[-1:] == 'R':
        rspc = rspc[:-1]
        rhomb = ' R'
    gray = ''
    if "1'" in rspc:
        gray = " 1'"
        rspc = rspc.replace("1'", '')
    rspc = rspc.replace("'", '')
    if rspc[-1:] == 'H':  # hexagonal is assumed and thus can be ignored
        rspc = rspc[:-1]
    if rspc[1:3] in ['M3', 'N3', 'A3', 'D3']:  #fix cubic old style
        rspc.replace('3', '-3')
    bns = -1
    try:
        bns = rspc.index('_')
        rspc = rspc.replace(rspc[bns:bns + 2], '')
    except ValueError:
        pass
    # look for a match in the spacegroup lists
    for i in spglist.values():
        for spc in i:
            if rspc == spc.replace(' ', '').upper():
                return spc + gray + rhomb
    # how about the post-2002 orthorhombic names?
    if rspc in sgequiv_2002_orthorhombic:
        return sgequiv_2002_orthorhombic[rspc] + gray
    else:
        # not found
        return '' 
[docs]def SpaceGroupNumber(spcgroup):
    SGNo = -1
    SpcGp = StandardizeSpcName(spcgroup)
    if not SpcGp:
        return SGNo
    try:
        SGNo = spgbyNum.index(SpcGp)
    except ValueError:
        pass
    return SGNo 
spgbyNum = []
'''Space groups indexed by number'''
spgbyNum = [
    None,
    'P 1',
    'P -1',  #1-2
    'P 2',
    'P 21',
    'C 2',
    'P m',
    'P c',
    'C m',
    'C c',
    'P 2/m',
    'P 21/m',
    'C 2/m',
    'P 2/c',
    'P 21/c',
    'C 2/c',  #3-15
    'P 2 2 2',
    'P 2 2 21',
    'P 21 21 2',
    'P 21 21 21',
    'C 2 2 21',
    'C 2 2 2',
    'F 2 2 2',
    'I 2 2 2',
    'I 21 21 21',
    'P m m 2',
    'P m c 21',
    'P c c 2',
    'P m a 2',
    'P c a 21',
    'P n c 2',
    'P m n 21',
    'P b a 2',
    'P n a 21',
    'P n n 2',
    'C m m 2',
    'C m c 21',
    'C c c 2',
    'A m m 2',
    'A b m 2',
    'A m a 2',
    'A b a 2',
    'F m m 2',
    'F d d 2',
    'I m m 2',
    'I b a 2',
    'I m a 2',
    'P m m m',
    'P n n n',
    'P c c m',
    'P b a n',
    'P m m a',
    'P n n a',
    'P m n a',
    'P c c a',
    'P b a m',
    'P c c n',
    'P b c m',
    'P n n m',
    'P m m n',
    'P b c n',
    'P b c a',
    'P n m a',
    'C m c m',
    'C m c a',
    'C m m m',
    'C c c m',
    'C m m a',
    'C c c a',
    'F m m m',
    'F d d d',
    'I m m m',
    'I b a m',
    'I b c a',
    'I m m a',  #16-74
    'P 4',
    'P 41',
    'P 42',
    'P 43',
    'I 4',
    'I 41',
    'P -4',
    'I -4',
    'P 4/m',
    'P 42/m',
    'P 4/n',
    'P 42/n',
    'I 4/m',
    'I 41/a',
    'P 4 2 2',
    'P 4 21 2',
    'P 41 2 2',
    'P 41 21 2',
    'P 42 2 2',
    'P 42 21 2',
    'P 43 2 2',
    'P 43 21 2',
    'I 4 2 2',
    'I 41 2 2',
    'P 4 m m',
    'P 4 b m',
    'P 42 c m',
    'P 42 n m',
    'P 4 c c',
    'P 4 n c',
    'P 42 m c',
    'P 42 b c',
    'I 4 m m',
    'I 4 c m',
    'I 41 m d',
    'I 41 c d',
    'P -4 2 m',
    'P -4 2 c',
    'P -4 21 m',
    'P -4 21 c',
    'P -4 m 2',
    'P -4 c 2',
    'P -4 b 2',
    'P -4 n 2',
    'I -4 m 2',
    'I -4 c 2',
    'I -4 2 m',
    'I -4 2 d',
    'P 4/m m m',
    'P 4/m c c',
    'P 4/n b m',
    'P 4/n n c',
    'P 4/m b m',
    'P 4/m n c',
    'P 4/n m m',
    'P 4/n c c',
    'P 42/m m c',
    'P 42/m c m',
    'P 42/n b c',
    'P 42/n n m',
    'P 42/m b c',
    'P 42/m n m',
    'P 42/n m c',
    'P 42/n c m',
    'I 4/m m m',
    'I 4/m c m',
    'I 41/a m d',
    'I 41/a c d',
    'P 3',
    'P 31',
    'P 32',
    'R 3',
    'P -3',
    'R -3',
    'P 3 1 2',
    'P 3 2 1',
    'P 31 1 2',
    'P 31 2 1',
    'P 32 1 2',
    'P 32 2 1',
    'R 3 2',
    'P 3 m 1',
    'P 3 1 m',
    'P 3 c 1',
    'P 3 1 c',
    'R 3 m',
    'R 3 c',
    'P -3 1 m',
    'P -3 1 c',
    'P -3 m 1',
    'P -3 c 1',
    'R -3 m',
    'R -3 c',  #75-167
    'P 6',
    'P 61',
    'P 65',
    'P 62',
    'P 64',
    'P 63',
    'P -6',
    'P 6/m',
    'P 63/m',
    'P 6 2 2',
    'P 61 2 2',
    'P 65 2 2',
    'P 62 2 2',
    'P 64 2 2',
    'P 63 2 2',
    'P 6 m m',
    'P 6 c c',
    'P 63 c m',
    'P 63 m c',
    'P -6 m 2',
    'P -6 c 2',
    'P -6 2 m',
    'P -6 2 c',
    'P 6/m m m',
    'P 6/m c c',
    'P 63/m c m',
    'P 63/m m c',  #168-194
    'P 2 3',
    'F 2 3',
    'I 2 3',
    'P 21 3',
    'I 21 3',
    'P m 3',
    'P n 3',
    'F m -3',
    'F d -3',
    'I m -3',
    'P a -3',
    'I a -3',
    'P 4 3 2',
    'P 42 3 2',
    'F 4 3 2',
    'F 41 3 2',
    'I 4 3 2',
    'P 43 3 2',
    'P 41 3 2',
    'I 41 3 2',
    'P -4 3 m',
    'F -4 3 m',
    'I -4 3 m',
    'P -4 3 n',
    'F -4 3 c',
    'I -4 3 d',
    'P m -3 m',
    'P n -3 n',
    'P m -3 n',
    'P n -3 m',
    'F m -3 m',
    'F m -3 c',
    'F d -3 m',
    'F d -3 c',
    'I m -3 m',
    'I a -3 d',
]  #195-230
altSettingOrtho = {}
''' A dictionary of alternate settings for orthorhombic unit cells
'''
altSettingOrtho = {
    'P 2 2 2': {
        'abc': 'P 2 2 2',
        'cab': 'P 2 2 2',
        'bca': 'P 2 2 2',
        'acb': 'P 2 2 2',
        'bac': 'P 2 2 2',
        'cba': 'P 2 2 2'
    },
    'P 2 2 21': {
        'abc': 'P 2 2 21',
        'cab': 'P 21 2 2',
        'bca': 'P 2 21 2',
        'acb': 'P 2 21 2',
        'bac': 'P 2 2 21',
        'cba': 'P 21 2 2'
    },
    'P 21 21 2': {
        'abc': 'P 21 21 2',
        'cab': 'P 2 21 21',
        'bca': 'P 21 2 21',
        'acb': 'P 21 2 21',
        'bac': 'P 21 21 2',
        'cba': 'P 2 21 21'
    },
    'P 21 21 21': {
        'abc': 'P 21 21 21',
        'cab': 'P 21 21 21',
        'bca': 'P 21 21 21',
        'acb': 'P 21 21 21',
        'bac': 'P 21 21 21',
        'cba': 'P 21 21 21'
    },
    'C 2 2 21': {
        'abc': 'C 2 2 21',
        'cab': 'A 21 2 2',
        'bca': 'B 2 21 2',
        'acb': 'B 2 21 2',
        'bac': 'C 2 2 21',
        'cba': 'A 21 2 2'
    },
    'C 2 2 2': {
        'abc': 'C 2 2 2',
        'cab': 'A 2 2 2',
        'bca': 'B 2 2 2',
        'acb': 'B 2 2 2',
        'bac': 'C 2 2 2',
        'cba': 'A 2 2 2'
    },
    'F 2 2 2': {
        'abc': 'F 2 2 2',
        'cab': 'F 2 2 2',
        'bca': 'F 2 2 2',
        'acb': 'F 2 2 2',
        'bac': 'F 2 2 2',
        'cba': 'F 2 2 2'
    },
    'I 2 2 2': {
        'abc': 'I 2 2 2',
        'cab': 'I 2 2 2',
        'bca': 'I 2 2 2',
        'acb': 'I 2 2 2',
        'bac': 'I 2 2 2',
        'cba': 'I 2 2 2'
    },
    'I 21 21 21': {
        'abc': 'I 21 21 21',
        'cab': 'I 21 21 21',
        'bca': 'I 21 21 21',
        'acb': 'I 21 21 21',
        'bac': 'I 21 21 21',
        'cba': 'I 21 21 21'
    },
    'P m m 2': {
        'abc': 'P m m 2',
        'cab': 'P 2 m m',
        'bca': 'P m 2 m',
        'acb': 'P m 2 m',
        'bac': 'P m m 2',
        'cba': 'P 2 m m'
    },
    'P m c 21': {
        'abc': 'P m c 21',
        'cab': 'P 21 m a',
        'bca': 'P b 21 m',
        'acb': 'P m 21 b',
        'bac': 'P c m 21',
        'cba': 'P 21 a m'
    },
    'P c c 2': {
        'abc': 'P c c 2',
        'cab': 'P 2 a a',
        'bca': 'P b 2 b',
        'acb': 'P b 2 b',
        'bac': 'P c c 2',
        'cba': 'P 2 a a'
    },
    'P m a 2': {
        'abc': 'P m a 2',
        'cab': 'P 2 m b',
        'bca': 'P c 2 m',
        'acb': 'P m 2 a',
        'bac': 'P b m 2',
        'cba': 'P 2 c m'
    },
    'P c a 21': {
        'abc': 'P c a 21',
        'cab': 'P 21 a b',
        'bca': 'P c 21 b',
        'acb': 'P b 21 a',
        'bac': 'P b c 21',
        'cba': 'P 21 c a'
    },
    'P n c 2': {
        'abc': 'P n c 2',
        'cab': 'P 2 n a',
        'bca': 'P b 2 n',
        'acb': 'P n 2 b',
        'bac': 'P c n 2',
        'cba': 'P 2 a n'
    },
    'P m n 21': {
        'abc': 'P m n 21',
        'cab': 'P 21 m n',
        'bca': 'P n 21 m',
        'acb': 'P m 21 n',
        'bac': 'P n m 21',
        'cba': 'P 21 n m'
    },
    'P b a 2': {
        'abc': 'P b a 2',
        'cab': 'P 2 c b',
        'bca': 'P c 2 a',
        'acb': 'P c 2 a',
        'bac': 'P b a 2',
        'cba': 'P 2 c b'
    },
    'P n a 21': {
        'abc': 'P n a 21',
        'cab': 'P 21 n b',
        'bca': 'P c 21 n',
        'acb': 'P n 21 a',
        'bac': 'P b n 21',
        'cba': 'P 21 c n'
    },
    'P n n 2': {
        'abc': 'P n n 2',
        'cab': 'P 2 n n',
        'bca': 'P n 2 n',
        'acb': 'P n 2 n',
        'bac': 'P n n 2',
        'cba': 'P 2 n n'
    },
    'C m m 2': {
        'abc': 'C m m 2',
        'cab': 'A 2 m m',
        'bca': 'B m 2 m',
        'acb': 'B m 2 m',
        'bac': 'C m m 2',
        'cba': 'A 2 m m'
    },
    'C m c 21': {
        'abc': 'C m c 21',
        'cab': 'A 21 m a',
        'bca': 'B b 21 m',
        'acb': 'B m 21 b',
        'bac': 'C c m 21',
        'cba': 'A 21 a m'
    },
    'C c c 2': {
        'abc': 'C c c 2',
        'cab': 'A 2 a a',
        'bca': 'B b 2 b',
        'acb': 'B b 2 b',
        'bac': 'C c c 2',
        'cba': 'A 2 a a'
    },
    'A m m 2': {
        'abc': 'A m m 2',
        'cab': 'B 2 m m',
        'bca': 'C m 2 m',
        'acb': 'A m 2 m',
        'bac': 'B m m 2',
        'cba': 'C 2 m m'
    },
    'A b m 2': {
        'abc': 'A b m 2',
        'cab': 'B 2 c m',
        'bca': 'C m 2 a',
        'acb': 'A c 2 m',
        'bac': 'B m a 2',
        'cba': 'C 2 m b'
    },
    'A m a 2': {
        'abc': 'A m a 2',
        'cab': 'B 2 m b',
        'bca': 'C c 2 m',
        'acb': 'A m 2 a',
        'bac': 'B b m 2',
        'cba': 'C 2 c m'
    },
    'A b a 2': {
        'abc': 'A b a 2',
        'cab': 'B 2 c b',
        'bca': 'C c 2 a',
        'acb': 'A c 2 a',
        'bac': 'B b a 2',
        'cba': 'C 2 c b'
    },
    'F m m 2': {
        'abc': 'F m m 2',
        'cab': 'F 2 m m',
        'bca': 'F m 2 m',
        'acb': 'F m 2 m',
        'bac': 'F m m 2',
        'cba': 'F 2 m m'
    },
    'F d d 2': {
        'abc': 'F d d 2',
        'cab': 'F 2 d d',
        'bca': 'F d 2 d',
        'acb': 'F d 2 d',
        'bac': 'F d d 2',
        'cba': 'F 2 d d'
    },
    'I m m 2': {
        'abc': 'I m m 2',
        'cab': 'I 2 m m',
        'bca': 'I m 2 m',
        'acb': 'I m 2 m',
        'bac': 'I m m 2',
        'cba': 'I 2 m m'
    },
    'I b a 2': {
        'abc': 'I b a 2',
        'cab': 'I 2 c b',
        'bca': 'I c 2 a',
        'acb': 'I c 2 a',
        'bac': 'I b a 2',
        'cba': 'I 2 c b'
    },
    'I m a 2': {
        'abc': 'I m a 2',
        'cab': 'I 2 m b',
        'bca': 'I c 2 m',
        'acb': 'I m 2 a',
        'bac': 'I b m 2',
        'cba': 'I 2 c m'
    },
    'P m m m': {
        'abc': 'P m m m',
        'cab': 'P m m m',
        'bca': 'P m m m',
        'acb': 'P m m m',
        'bac': 'P m m m',
        'cba': 'P m m m'
    },
    'P n n n': {
        'abc': 'P n n n',
        'cab': 'P n n n',
        'bca': 'P n n n',
        'acb': 'P n n n',
        'bac': 'P n n n',
        'cba': 'P n n n'
    },
    'P c c m': {
        'abc': 'P c c m',
        'cab': 'P m a a',
        'bca': 'P b m b',
        'acb': 'P b m b',
        'bac': 'P c c m',
        'cba': 'P m a a'
    },
    'P b a n': {
        'abc': 'P b a n',
        'cab': 'P n c b',
        'bca': 'P c n a',
        'acb': 'P c n a',
        'bac': 'P b a n',
        'cba': 'P n c b'
    },
    'P m m a': {
        'abc': 'P m m a',
        'cab': 'P b m m',
        'bca': 'P m c m',
        'acb': 'P m a m',
        'bac': 'P m m b',
        'cba': 'P c m m'
    },
    'P n n a': {
        'abc': 'P n n a',
        'cab': 'P b n n',
        'bca': 'P n c n',
        'acb': 'P n a n',
        'bac': 'P n n b',
        'cba': 'P c n n'
    },
    'P m n a': {
        'abc': 'P m n a',
        'cab': 'P b m n',
        'bca': 'P n c m',
        'acb': 'P m a n',
        'bac': 'P n m b',
        'cba': 'P c n m'
    },
    'P c c a': {
        'abc': 'P c c a',
        'cab': 'P b a a',
        'bca': 'P b c b',
        'acb': 'P b a b',
        'bac': 'P c c b',
        'cba': 'P c a a'
    },
    'P b a m': {
        'abc': 'P b a m',
        'cab': 'P m c b',
        'bca': 'P c m a',
        'acb': 'P c m a',
        'bac': 'P b a m',
        'cba': 'P m c b'
    },
    'P c c n': {
        'abc': 'P c c n',
        'cab': 'P n a a',
        'bca': 'P b n b',
        'acb': 'P b n b',
        'bac': 'P c c n',
        'cba': 'P n a a'
    },
    'P b c m': {
        'abc': 'P b c m',
        'cab': 'P m c a',
        'bca': 'P b m a',
        'acb': 'P c m b',
        'bac': 'P c a m',
        'cba': 'P m a b'
    },
    'P n n m': {
        'abc': 'P n n m',
        'cab': 'P m n n',
        'bca': 'P n m n',
        'acb': 'P n m n',
        'bac': 'P n n m',
        'cba': 'P m n n'
    },
    'P m m n': {
        'abc': 'P m m n',
        'cab': 'P n m m',
        'bca': 'P m n m',
        'acb': 'P m n m',
        'bac': 'P m m n',
        'cba': 'P n m m'
    },
    'P b c n': {
        'abc': 'P b c n',
        'cab': 'P n c a',
        'bca': 'P b n a',
        'acb': 'P c n b',
        'bac': 'P c a n',
        'cba': 'P n a b'
    },
    'P b c a': {
        'abc': 'P b c a',
        'cab': 'P b c a',
        'bca': 'P b c a',
        'acb': 'P c a b',
        'bac': 'P c a b',
        'cba': 'P c a b'
    },
    'P n m a': {
        'abc': 'P n m a',
        'cab': 'P b n m',
        'bca': 'P m c n',
        'acb': 'P n a m',
        'bac': 'P m n b',
        'cba': 'P c m n'
    },
    'C m c m': {
        'abc': 'C m c m',
        'cab': 'A m m a',
        'bca': 'B b m m',
        'acb': 'B m m b',
        'bac': 'C c m m',
        'cba': 'A m a m'
    },
    'C m c a': {
        'abc': 'C m c a',
        'cab': 'A b m a',
        'bca': 'B b c m',
        'acb': 'B m a b',
        'bac': 'C c m b',
        'cba': 'A c a m'
    },
    'C m m m': {
        'abc': 'C m m m',
        'cab': 'A m m m',
        'bca': 'B m m m',
        'acb': 'B m m m',
        'bac': 'C m m m',
        'cba': 'A m m m'
    },
    'C c c m': {
        'abc': 'C c c m',
        'cab': 'A m a a',
        'bca': 'B b m b',
        'acb': 'B b m b',
        'bac': 'C c c m',
        'cba': 'A m a a'
    },
    'C m m a': {
        'abc': 'C m m a',
        'cab': 'A b m m',
        'bca': 'B m c m',
        'acb': 'B m a m',
        'bac': 'C m m b',
        'cba': 'A c m m'
    },
    'C c c a': {
        'abc': 'C c a a',
        'cab': 'A b a a',
        'bca': 'B b c b',
        'acb': 'B b a b',
        'bac': 'C c c b',
        'cba': 'A c a a'
    },
    'F m m m': {
        'abc': 'F m m m',
        'cab': 'F m m m',
        'bca': 'F m m m',
        'acb': 'F m m m',
        'bac': 'F m m m',
        'cba': 'F m m m'
    },
    'F d d d': {
        'abc': 'F d d d',
        'cab': 'F d d d',
        'bca': 'F d d d',
        'acb': 'F d d d',
        'bac': 'F d d d',
        'cba': 'F d d d'
    },
    'I m m m': {
        'abc': 'I m m m',
        'cab': 'I m m m',
        'bca': 'I m m m',
        'acb': 'I m m m',
        'bac': 'I m m m',
        'cba': 'I m m m'
    },
    'I b a m': {
        'abc': 'I b a m',
        'cab': 'I m c b',
        'bca': 'I c m a',
        'acb': 'I c m a',
        'bac': 'I b a m',
        'cba': 'I m c b'
    },
    'I b c a': {
        'abc': 'I b c a',
        'cab': 'I b c a',
        'bca': 'I b c a',
        'acb': 'I c a b',
        'bac': 'I c a b',
        'cba': 'I c a b'
    },
    'I m m a': {
        'abc': 'I m m a',
        'cab': 'I b m m',
        'bca': 'I m c m',
        'acb': 'I m a m',
        'bac': 'I m m  b',
        'cba': 'I c m m'
    },
}
spg2origins = {}
''' A dictionary of all spacegroups that have 2nd settings; the value is the
1st --> 2nd setting transformation vector as X(2nd) = X(1st)-V, nonstandard ones are included.
'''
spg2origins = {
    'P n n n': [-.25, -.25, -.25],
    'P b a n': [-.25, -.25, 0],
    'P n c b': [0, -.25, -.25],
    'P c n a': [-.25, 0, -.25],
    'P m m n': [-.25, -.25, 0],
    'P n m m': [0, -.25, -.25],
    'P m n m': [-.25, 0, -.25],
    'C c c a': [0, -.25, -.25],
    'C c c b': [-.25, 0, -.25],
    'A b a a': [-.25, 0, -.25],
    'A c a a': [-.25, -.25, 0],
    'B b c b': [-.25, -.25, 0],
    'B b a b': [0, -.25, -.25],
    'F d d d': [-.125, -.125, -.125],
    'P 4/n': [-.25, -.25, 0],
    'P 42/n': [-.25, -.25, -.25],
    'I 41/a': [0, -.25, -.125],
    'P 4/n b m': [-.25, -.25, 0],
    'P 4/n n c': [-.25, -.25, -.25],
    'P 4/n m m': [-.25, -.25, 0],
    'P 4/n c c': [-.25, -.25, 0],
    'P 42/n b c': [-.25, -.25, -.25],
    'P 42/n n m': [-.25, .25, -.25],
    'P 42/n m c': [-.25, .25, -.25],
    'P 42/n c m': [-.25, .25, -.25],
    'I 41/a m d': [0, .25, -.125],
    'I 41/a c d': [0, .25, -.125],
    'p n -3': [-.25, -.25, -.25],
    'F d -3': [-.125, -.125, -.125],
    'P n -3 n': [-.25, -.25, -.25],
    'P n -3 m': [-.25, -.25, -.25],
    'F d -3 m': [-.125, -.125, -.125],
    'F d -3 c': [-.375, -.375, -.375],
    'p n 3': [-.25, -.25, -.25],
    'F d 3': [-.125, -.125, -.125],
    'P n 3 n': [-.25, -.25, -.25],
    'P n 3 m': [-.25, -.25, -.25],
    'F d 3 m': [-.125, -.125, -.125],
    'F d - c': [-.375, -.375, -.375]
}
spglist = {}
'''A dictionary of space groups as ordered and named in the pre-2002 International
Tables Volume A, except that spaces are used following the GSAS convention to
separate the different crystallographic directions.
Note that the symmetry codes here will recognize many non-standard space group
symbols with different settings. They are ordered by Laue group
'''
spglist = {
    'P1': (
        'P 1',
        'P -1',
    ),  # 1-2
    'C1': (
        'C 1',
        'C -1',
    ),
    'P2/m': (
        'P 2',
        'P 21',
        'P m',
        'P a',
        'P c',
        'P n',
        'P 2/m',
        'P 21/m',
        'P 2/c',
        'P 2/a',
        'P 2/n',
        'P 21/c',
        'P 21/a',
        'P 21/n',
    ),  #3-15
    'C2/m': (
        'C 2',
        'C m',
        'C c',
        'C n',
        'C 2/m',
        'C 2/c',
        'C 2/n',
    ),
    'A2/m': (
        'A 2',
        'A m',
        'A a',
        'A n',
        'A 2/m',
        'A 2/a',
        'A 2/n',
    ),
    'I2/m': (
        'I 2',
        'I m',
        'I a',
        'I n',
        'I c',
        'I 2/m',
        'I 2/a',
        'I 2/c',
        'I 2/n',
    ),
    'Pmmm': (
        'P 2 2 2',
        'P 2 2 21',
        'P 21 2 2',
        'P 2 21 2',
        'P 21 21 2',
        'P 2 21 21',
        'P 21 2 21',
        'P 21 21 21',
        'P m m 2',
        'P 2 m m',
        'P m 2 m',
        'P m c 21',
        'P 21 m a',
        'P b 21 m',
        'P m 21 b',
        'P c m 21',
        'P 21 a m',
        'P c c 2',
        'P 2 a a',
        'P b 2 b',
        'P m a 2',
        'P 2 m b',
        'P c 2 m',
        'P m 2 a',
        'P b m 2',
        'P 2 c m',
        'P c a 21',
        'P 21 a b',
        'P c 21 b',
        'P b 21 a',
        'P b c 21',
        'P 21 c a',
        'P n c 2',
        'P 2 n a',
        'P b 2 n',
        'P n 2 b',
        'P c n 2',
        'P 2 a n',
        'P m n 21',
        'P 21 m n',
        'P n 21 m',
        'P m 21 n',
        'P n m 21',
        'P 21 n m',
        'P b a 2',
        'P 2 c b',
        'P c 2 a',
        'P n a 21',
        'P 21 n b',
        'P c 21 n',
        'P n 21 a',
        'P b n 21',
        'P 21 c n',
        'P n n 2',
        'P 2 n n',
        'P n 2 n',
        'P m m m',
        'P n n n',
        'P c c m',
        'P m a a',
        'P b m b',
        'P b a n',
        'P n c b',
        'P c n a',
        'P m m a',
        'P b m m',
        'P m c m',
        'P m a m',
        'P m m b',
        'P c m m',
        'P n n a',
        'P b n n',
        'P n c n',
        'P n a n',
        'P n n b',
        'P c n n',
        'P m n a',
        'P b m n',
        'P n c m',
        'P m a n',
        'P n m b',
        'P c n m',
        'P c c a',
        'P b a a',
        'P b c b',
        'P b a b',
        'P c c b',
        'P c a a',
        'P b a m',
        'P m c b',
        'P c m a',
        'P c c n',
        'P n a a',
        'P b n b',
        'P b c m',
        'P m c a',
        'P b m a',
        'P c m b',
        'P c a m',
        'P m a b',
        'P n n m',
        'P m n n',
        'P n m n',
        'P m m n',
        'P n m m',
        'P m n m',
        'P b c n',
        'P n c a',
        'P b n a',
        'P c n b',
        'P c a n',
        'P n a b',
        'P b c a',
        'P c a b',
        'P n m a',
        'P b n m',
        'P m c n',
        'P n a m',
        'P m n b',
        'P c m n',
    ),
    'Cmmm': (
        'C 2 2 21',
        'C 2 2 2',
        'C m m 2',
        'C m c 21',
        'C c m 21',
        'C c c 2',
        'C m 2 m',
        'C 2 m m',
        'C m 2 a',
        'C 2 m b',
        'C c 2 m',
        'C 2 c m',
        'C c 2 a',
        'C 2 c b',
        'C m c m',
        'C c m m',
        'C m c a',
        'C c m b',
        'C m m m',
        'C c c m',
        'C m m a',
        'C m m b',
        'C c c a',
        'C c c b',
    ),
    'Ammm': (
        'A 21 2 2',
        'A 2 2 2',
        'A 2 m m',
        'A 21 m a',
        'A 21 a m',
        'A 2 a a',
        'A m 2 m',
        'A m m 2',
        'A b m 2',
        'A c 2 m',
        'A m a 2',
        'A m 2 a',
        'A b a 2',
        'A c 2 a',
        'A m m a',
        'A m a m',
        'A b m a',
        'A c a m',
        'A m m m',
        'A m a a',
        'A b m m',
        'A c m m',
        'A c a a',
        'A b a a',
    ),
    'Bmmm': (
        'B 2 21 2',
        'B 2 2 2',
        'B m 2 m',
        'B m 21 b',
        'B b 21 m',
        'B b 2 b',
        'B m m 2',
        'B 2 m m',
        'B 2 c m',
        'B m a 2',
        'B 2 m b',
        'B b m 2',
        'B 2 c b',
        'B b a 2',
        'B b m m',
        'B m m b',
        'B b c m',
        'B m a b',
        'B m m m',
        'B b m b',
        'B m a m',
        'B m c m',
        'B b a b',
        'B b c b',
    ),
    'Immm': (
        'I 2 2 2',
        'I 21 21 21',
        'I m m 2',
        'I m 2 m',
        'I 2 m m',
        'I b a 2',
        'I 2 c b',
        'I c 2 a',
        'I m a 2',
        'I 2 m b',
        'I c 2 m',
        'I m 2 a',
        'I b m 2',
        'I 2 c m',
        'I m m m',
        'I b a m',
        'I m c b',
        'I c m a',
        'I b c a',
        'I c a b',
        'I m m a',
        'I b m m ',
        'I m c m',
        'I m a m',
        'I m m b',
        'I c m m',
    ),
    'Fmmm': (
        'F 2 2 2',
        'F m m m',
        'F d d d',
        'F m m 2',
        'F m 2 m',
        'F 2 m m',
        'F d d 2',
        'F d 2 d',
        'F 2 d d',
    ),
    'P4/mmm': (
        'P 4',
        'P 41',
        'P 42',
        'P 43',
        'P -4',
        'P 4/m',
        'P 42/m',
        'P 4/n',
        'P 42/n',
        'P 4 2 2',
        'P 4 21 2',
        'P 41 2 2',
        'P 41 21 2',
        'P 42 2 2',
        'P 42 21 2',
        'P 43 2 2',
        'P 43 21 2',
        'P 4 m m',
        'P 4 b m',
        'P 42 c m',
        'P 42 n m',
        'P 4 c c',
        'P 4 n c',
        'P 42 m c',
        'P 42 b c',
        'P -4 2 m',
        'P -4 2 c',
        'P -4 21 m',
        'P -4 21 c',
        'P -4 m 2',
        'P -4 c 2',
        'P -4 b 2',
        'P -4 n 2',
        'P 4/m m m',
        'P 4/m c c',
        'P 4/n b m',
        'P 4/n n c',
        'P 4/m b m',
        'P 4/m n c',
        'P 4/n m m',
        'P 4/n c c',
        'P 42/m m c',
        'P 42/m c m',
        'P 42/n b c',
        'P 42/n n m',
        'P 42/m b c',
        'P 42/m n m',
        'P 42/n m c',
        'P 42/n c m',
    ),
    'I4/mmm': ('I 4', 'I 41', 'I -4', 'I 4/m', 'I 41/a', 'I 4 2 2', 'I 41 2 2',
               'I 4 m m', 'I 4 c m', 'I 41 m d', 'I 41 c d', 'I -4 m 2',
               'I -4 c 2', 'I -4 2 m', 'I -4 2 d', 'I 4/m m m', 'I 4/m c m',
               'I 41/a m d', 'I 41/a c d'),
    'R3-H': (
        'R 3',
        'R -3',
        'R 3 2',
        'R 3 m',
        'R 3 c',
        'R -3 m',
        'R -3 c',
    ),
    'P6/mmm': (
        'P 3',
        'P 31',
        'P 32',
        'P -3',
        'P 3 1 2',
        'P 3 2 1',
        'P 31 1 2',
        'P 31 2 1',
        'P 32 1 2',
        'P 32 2 1',
        'P 3 m 1',
        'P 3 1 m',
        'P 3 c 1',
        'P 3 1 c',
        'P -3 1 m',
        'P -3 1 c',
        'P -3 m 1',
        'P -3 c 1',
        'P 6',
        'P 61',
        'P 65',
        'P 62',
        'P 64',
        'P 63',
        'P -6',
        'P 6/m',
        'P 63/m',
        'P 6 2 2',
        'P 61 2 2',
        'P 65 2 2',
        'P 62 2 2',
        'P 64 2 2',
        'P 63 2 2',
        'P 6 m m',
        'P 6 c c',
        'P 63 c m',
        'P 63 m c',
        'P -6 m 2',
        'P -6 c 2',
        'P -6 2 m',
        'P -6 2 c',
        'P 6/m m m',
        'P 6/m c c',
        'P 63/m c m',
        'P 63/m m c',
    ),
    'Pm3m': (
        'P 2 3',
        'P 21 3',
        'P m 3',
        'P m -3',
        'P n 3',
        'P n -3',
        'P a 3',
        'P a -3',
        'P 4 3 2',
        'P 42 3 2',
        'P 43 3 2',
        'P 41 3 2',
        'P -4 3 m',
        'P -4 3 n',
        'P m 3 m',
        'P m -3 m',
        'P n 3 n',
        'P n -3 n',
        'P m 3 n',
        'P m -3 n',
        'P n 3 m',
        'P n -3 m',
    ),
    'Im3m': ('I 2 3', 'I 21 3', 'I m 3', 'I m -3', 'I a 3', 'I a -3', 'I 4 3 2',
             'I 41 3 2', 'I -4 3 m', 'I -4 3 d', 'I m -3 m', 'I m 3 m',
             'I a 3 d', 'I a -3 d', 'I n 3 n', 'I n -3 n'),
    'Fm3m': (
        'F 2 3',
        'F m 3',
        'F m -3',
        'F d 3',
        'F d -3',
        'F 4 3 2',
        'F 41 3 2',
        'F -4 3 m',
        'F -4 3 c',
        'F m 3 m',
        'F m -3 m',
        'F m 3 c',
        'F m -3 c',
        'F d 3 m',
        'F d -3 m',
        'F d 3 c',
        'F d -3 c',
    ),
}
sgequiv_2002_orthorhombic = {}
''' A dictionary of orthorhombic space groups that were renamed in the 2002 Volume A,
 along with the pre-2002 name. The e designates a double glide-plane
'''
sgequiv_2002_orthorhombic = {
    'AEM2': 'A b m 2',
    'B2EM': 'B 2 c m',
    'CM2E': 'C m 2 a',
    'AE2M': 'A c 2 m',
    'BME2': 'B m a 2',
    'C2ME': 'C 2 m b',
    'AEA2': 'A b a 2',
    'B2EB': 'B 2 c b',
    'CC2E': 'C c 2 a',
    'AE2A': 'A c 2 a',
    'BBE2': 'B b a 2',
    'C2CE': 'C 2 c b',
    'CMCE': 'C m c a',
    'AEMA': 'A b m a',
    'BBEM': 'B b c m',
    'BMEB': 'B m a b',
    'CCME': 'C c m b',
    'AEAM': 'A c a m',
    'CMME': 'C m m a',
    'AEMM': 'A b m m',
    'BMEM': 'B m c m',
    'CCCE': 'C c c a',
    'AEAA': 'A b a a',
    'BBEB': 'B b c b'
}
#'A few non-standard space groups for test use'
nonstandard_sglist = (
    'P 21 1 1',
    'P 1 21 1',
    'P 1 1 21',
    'R 3 r',
    'R 3 2 h',
    'R -3 r',
    'R 3 2 r',
    'R 3 m h',
    'R 3 m r',
    'R 3 c r',
    'R -3 c r',
    'R -3 m r',
),
#Use the space groups types in this order to list the symbols in the
#order they are listed in the International Tables, vol. A'''
symtypelist = ('triclinic', 'monoclinic', 'orthorhombic', 'tetragonal',
               'trigonal', 'hexagonal', 'cubic')
# self-test materials follow. Requires files in directory testinp
selftestlist = []
'''Defines a list of self-tests'''
selftestquiet = True
def _ReportTest():
    'Report name and doc string of current routine when ``selftestquiet`` is False'
    if not selftestquiet:
        import inspect
        caller = inspect.stack()[1][3]
        doc = eval(caller).__doc__
        if doc is not None:
            print('testing ' + __file__ + ' with ' + caller + ' (' + doc + ')')
        else:
            print('testing ' + __file__() + " with " + caller)
[docs]def test0():
    '''self-test #0: exercise MoveToUnitCell'''
    _ReportTest()
    msg = "MoveToUnitCell failed"
    assert (MoveToUnitCell([1, 2, 3])[0] == [0, 0, 0]).all, msg
    assert (MoveToUnitCell([2, -1, -2])[0] == [0, 0, 0]).all, msg
    assert abs(MoveToUnitCell(np.array([-.1]))[0] - 0.9)[0] < 1e-6, msg
    assert abs(MoveToUnitCell(np.array([.1]))[0] - 0.1)[0] < 1e-6, msg 
selftestlist.append(test0)
[docs]def test1():
    '''self-test #1: SpcGroup against previous results'''
    #'''self-test #1: SpcGroup and SGPrint against previous results'''
    _ReportTest()
    testdir = ospath.join(ospath.split(ospath.abspath(__file__))[0], 'testinp')
    if ospath.exists(testdir):
        if testdir not in sys.path:
            sys.path.insert(0, testdir)
    import spctestinp
    def CompareSpcGroup(spc, referr, refdict, reflist):
        'Compare output from GSASIIspc.SpcGroup with results from a previous run'
        # if an error is reported, the dictionary can be ignored
        msg0 = "CompareSpcGroup failed on space group %s" % spc
        result = SpcGroup(spc)
        if result[0] == referr and referr > 0:
            return True
        #        #print result[1]['SpGrp']
        #msg = msg0 + " in list lengths"
        #assert len(keys) == len(refdict.keys()), msg
        for key in refdict.keys():
            if key == 'SGOps' or key == 'SGCen':
                msg = msg0 + (" in key %s length" % key)
                assert len(refdict[key]) == len(result[1][key]), msg
                for i in range(len(refdict[key])):
                    msg = msg0 + (" in key %s level 0" % key)
                    assert np.allclose(result[1][key][i][0],
                                       refdict[key][i][0]), msg
                    msg = msg0 + (" in key %s level 1" % key)
                    assert np.allclose(result[1][key][i][1],
                                       refdict[key][i][1]), msg
            else:
                msg = msg0 + (" in key %s" % key)
                assert result[1][key] == refdict[key], msg
        msg = msg0 + (" in key %s reflist" % key)
        #for (l1,l2) in zip(reflist, SGPrint(result[1])):
        #    assert l2.replace('\t','').replace(' ','') == l1.replace(' ',''), 'SGPrint ' +msg
        # for now disable SGPrint testing, output has changed
        #assert reflist == SGPrint(result[1]), 'SGPrint ' +msg
    for spc in spctestinp.SGdat:
        CompareSpcGroup(spc, 0, spctestinp.SGdat[spc], spctestinp.SGlist[spc]) 
selftestlist.append(test1)
[docs]def test2():
    '''self-test #2: SpcGroup against cctbx (sgtbx) computations'''
    _ReportTest()
    testdir = ospath.join(ospath.split(ospath.abspath(__file__))[0], 'testinp')
    if ospath.exists(testdir):
        if testdir not in sys.path:
            sys.path.insert(0, testdir)
    import sgtbxtestinp
    def CompareWcctbx(spcname, cctbx_in, debug=0):
        'Compare output from GSASIIspc.SpcGroup with results from cctbx.sgtbx'
        cctbx = cctbx_in[:]  # make copy so we don't delete from the original
        spc = (SpcGroup(spcname))[1]
        if debug:
            print(spc['SpGrp'])
        if debug:
            print(spc['SGCen'])
        latticetype = spcname.strip().upper()[0]
        # lattice type of R implies Hexagonal centering", fix the rhombohedral settings
        if latticetype == "R" and len(spc['SGCen']) == 1:
            latticetype = 'P'
        assert latticetype == spc[
            'SGLatt'], "Failed: %s does not match Lattice: %s" % (spcname,
                                                                  spc['SGLatt'])
        onebar = [1]
        if spc['SGInv']:
            onebar.append(-1)
        for (op, off) in spc['SGOps']:
            for inv in onebar:
                for cen in spc['SGCen']:
                    noff = off + cen
                    noff = MoveToUnitCell(noff)[0]
                    mult = tuple((op * inv).ravel().tolist())
                    if debug:
                        print("\n%s: %s + %s" % (spcname, mult, noff))
                    for refop in cctbx:
                        if debug:
                            print(refop)
                        # check the transform
                        if refop[:9] != mult:
                            continue
                        if debug:
                            print("mult match")
                        # check the translation
                        reftrans = list(refop[-3:])
                        reftrans = MoveToUnitCell(reftrans)[0]
                        if all(abs(noff - reftrans) < 1.e-5):
                            cctbx.remove(refop)
                            break
                    else:
                        assert False, "failed on %s:\n\t %s + %s" % (spcname,
                                                                     mult, noff)
    for key in sgtbxtestinp.sgtbx:
        CompareWcctbx(key, sgtbxtestinp.sgtbx[key]) 
selftestlist.append(test2)
[docs]def test3():
    '''self-test #3: exercise SytSym (includes GetOprPtrName, GenAtom, GetKNsym)
     for selected space groups against info in IT Volume A '''
    _ReportTest()
    def ExerciseSiteSym(spc, crdlist):
        'compare site symmetries and multiplicities for a specified space group'
        msg = "failed on site sym test for %s" % spc
        (E, S) = SpcGroup(spc)
        assert not E, msg
        for t in crdlist:
            symb, m, n, od = SytSym(t[0], S)
            if symb.strip() != t[2].strip() or m != t[1]:
                print(spc, t[0], m, n, symb, t[2], od)
            assert m == t[1]
            #assert symb.strip() == t[2].strip()
    ExerciseSiteSym('p 1', [
        ((0.13, 0.22, 0.31), 1, '1'),
        ((0, 0, 0), 1, '1'),
    ])
    ExerciseSiteSym('p -1', [
        ((0.13, 0.22, 0.31), 2, '1'),
        ((0, 0.5, 0), 1, '-1'),
    ])
    ExerciseSiteSym('C 2/c', [
        ((0.13, 0.22, 0.31), 8, '1'),
        ((0.0, .31, 0.25), 4, '2(y)'),
        ((0.25, .25, 0.5), 4, '-1'),
        ((0, 0.5, 0), 4, '-1'),
    ])
    ExerciseSiteSym('p 2 2 2', [
        ((0.13, 0.22, 0.31), 4, '1'),
        ((0, 0.5, .31), 2, '2(z)'),
        ((0.5, .31, 0.5), 2, '2(y)'),
        ((.11, 0, 0), 2, '2(x)'),
        ((0, 0.5, 0), 1, '222'),
    ])
    ExerciseSiteSym('p 4/n', [
        ((0.13, 0.22, 0.31), 8, '1'),
        ((0.25, 0.75, .31), 4, '2(z)'),
        ((0.5, 0.5, 0.5), 4, '-1'),
        ((0, 0.5, 0), 4, '-1'),
        ((0.25, 0.25, .31), 2, '4(001)'),
        ((0.25, .75, 0.5), 2, '-4(001)'),
        ((0.25, .75, 0.0), 2, '-4(001)'),
    ])
    ExerciseSiteSym('p 31 2 1', [
        ((0.13, 0.22, 0.31), 6, '1'),
        ((0.13, 0.0, 0.833333333), 3, '2(100)'),
        ((0.13, 0.13, 0.), 3, '2(110)'),
    ])
    ExerciseSiteSym('R 3 c', [
        ((0.13, 0.22, 0.31), 18, '1'),
        ((0.0, 0.0, 0.31), 6, '3'),
    ])
    ExerciseSiteSym('R 3 c R', [
        ((0.13, 0.22, 0.31), 6, '1'),
        ((0.31, 0.31, 0.31), 2, '3(111)'),
    ])
    ExerciseSiteSym('P 63 m c', [
        ((0.13, 0.22, 0.31), 12, '1'),
        ((0.11, 0.22, 0.31), 6, 'm(100)'),
        ((0.333333, 0.6666667, 0.31), 2, '3m(100)'),
        ((0, 0, 0.31), 2, '3m(100)'),
    ])
    ExerciseSiteSym('I a -3', [
        ((0.13, 0.22, 0.31), 48, '1'),
        ((0.11, 0, 0.25), 24, '2(x)'),
        ((0.11, 0.11, 0.11), 16, '3(111)'),
        ((0, 0, 0), 8, '-3(111)'),
    ]) 
selftestlist.append(test3)
if __name__ == '__main__':
    # run self-tests
    selftestquiet = False
    for test in selftestlist:
        test()
    print("OK")