symmetr package

Submodules

• symmetr.find_eq module
  • confs
    • confs.__dict__
    • confs.__firstlineno__
    • confs.__init__()
    • confs.__module__
    • confs.__static_attributes__
    • confs.add()
    • confs.convert()
    • confs.is_in()
    • confs.pprint()
  • find_equiv()
• symmetr.fslib module
  • read_fs_inp()
  • run_fs()
  • run_fs_fin()
• symmetr.funcs_main module
  • def_symmetr_opt()
  • sym_mham()
  • sym_res()
  • sym_res_exp()
  • sym_res_nonexp()
• symmetr.input module
  • create_symmetr_input()
  • options
    • options.__dict__
    • options.__firstlineno__
    • options.__getitem__()
    • options.__init__()
    • options.__module__
    • options.__setitem__()
    • options.__static_attributes__
    • options.__str__()
    • options.check()
  • parse()
• symmetr.magndata module
  • get_magndata_structure()
• symmetr.mham module
  • convert_mag_ham()
  • equiv()
  • find_perms()
  • params_trans_ham
    • params_trans_ham.__dict__
    • params_trans_ham.__firstlineno__
    • params_trans_ham.__init__()
    • params_trans_ham.__module__
    • params_trans_ham.__static_attributes__
  • print_Ham()
  • sym_mag_ham()
  • trans_mag_Ham_perms()
  • trans_mag_ham()
• symmetr.noso_new module
  • NosoSymFinder
    • NosoSymFinder.__dict__
    • NosoSymFinder.__firstlineno__
    • NosoSymFinder.__init__()
    • NosoSymFinder.__module__
    • NosoSymFinder.__static_attributes__
    • NosoSymFinder.find_noso_syms()
    • NosoSymFinder.get_AB_rotations()
    • NosoSymFinder.get_chain_rotations()
    • NosoSymFinder.get_i_chain()
    • NosoSymFinder.get_i_chain_nr()
    • NosoSymFinder.get_mchain()
    • NosoSymFinder.get_permutation_chains()
    • NosoSymFinder.get_permutations_rotations()
    • NosoSymFinder.get_rotations_overlap()
    • NosoSymFinder.get_rotations_overlap_multi()
    • NosoSymFinder.merge_rotations()
    • NosoSymFinder.remove_repeated()
  • RotationType
    • RotationType.__dict__
    • RotationType.__firstlineno__
    • RotationType.__init__()
    • RotationType.__module__
    • RotationType.__repr__()
    • RotationType.__static_attributes__
    • RotationType.eq()
• symmetr.symT module
  • get_T()
  • get_generators()
  • get_metric()
  • get_syms()
  • get_syms_nonmag()
  • get_syms_noso()
• symmetr.symmetrize module
  • even_odd()
  • params_trans
    • params_trans.__dict__
    • params_trans.__firstlineno__
    • params_trans.__init__()
    • params_trans.__module__
    • params_trans.__static_attributes__
  • symmetr()
  • symmetr_AB()
  • symmetrize_same_op()
  • symmetrize_sym_inds()
• symmetr.symmetrize_exp module
  • convert_mags()
  • create_rank2()
  • def_syms_L()
  • get_L_trans()
  • index_from_1()
  • is_collinear()
  • print_tensor()
  • simplify_tensor()
  • sub_m()
• symmetr.symmetry module
  • Symmetry
    • Symmetry.__dict__
    • Symmetry.__eq__()
    • Symmetry.__firstlineno__
    • Symmetry.__hash__
    • Symmetry.__init__()
    • Symmetry.__module__
    • Symmetry.__mul__()
    • Symmetry.__static_attributes__
    • Symmetry.__str__()
    • Symmetry.convert()
    • Symmetry.copy()
    • Symmetry.def_custom_R()
    • Symmetry.eq_numeric()
    • Symmetry.get_R()
    • Symmetry.inv()
    • Symmetry.pprint()
  • convert_op()
  • create_I()
  • create_P()
  • create_T()
  • findsym2sym()
  • matsym2sym()
  • optype_to_basic()
  • sym2R()
  • sym2Rs()
  • sym2trans()
• symmetr.tensors module
  • GenericTensor
    • GenericTensor.__add__()
    • GenericTensor.__dict__
    • GenericTensor.__div__()
    • GenericTensor.__firstlineno__
    • GenericTensor.__init__()
    • GenericTensor.__iter__()
    • GenericTensor.__len__()
    • GenericTensor.__module__
    • GenericTensor.__mul__()
    • GenericTensor.__neg__()
    • GenericTensor.__radd__()
    • GenericTensor.__rmul__()
    • GenericTensor.__rsub__()
    • GenericTensor.__static_attributes__
    • GenericTensor.__sub__()
    • GenericTensor.convert()
    • GenericTensor.def_metric()
    • GenericTensor.def_trans()
    • GenericTensor.is_contravar()
    • GenericTensor.is_covar()
    • GenericTensor.is_even()
    • GenericTensor.lower_index()
    • GenericTensor.raise_index()
    • GenericTensor.reduce()
    • GenericTensor.reverse_index()
    • GenericTensor.transform()
    • GenericTensor.use_numpy_mode()
  • NumTensor
    • NumTensor.__annotations__
    • NumTensor.__eq__()
    • NumTensor.__firstlineno__
    • NumTensor.__getitem__()
    • NumTensor.__hash__
    • NumTensor.__init__()
    • NumTensor.__module__
    • NumTensor.__mul__()
    • NumTensor.__ne__()
    • NumTensor.__setitem__()
    • NumTensor.__static_attributes__
    • NumTensor.__str__()
    • NumTensor.convert()
    • NumTensor.convert2tensor()
    • NumTensor.copy()
    • NumTensor.copy0()
    • NumTensor.ind2i()
    • NumTensor.is_even()
    • NumTensor.pprint()
    • NumTensor.round()
    • NumTensor.subs()
    • NumTensor.transform()
  • Tensor
    • Tensor.__annotations__
    • Tensor.__eq__()
    • Tensor.__firstlineno__
    • Tensor.__getitem__()
    • Tensor.__hash__
    • Tensor.__init__()
    • Tensor.__module__
    • Tensor.__ne__()
    • Tensor.__setitem__()
    • Tensor.__static_attributes__
    • Tensor.__str__()
    • Tensor.__type__()
    • Tensor.check_calc_symmetry()
    • Tensor.convert2numpy()
    • Tensor.convert2numtensor()
    • Tensor.copy()
    • Tensor.copy0()
    • Tensor.evalf()
    • Tensor.load()
    • Tensor.mat()
    • Tensor.pprint()
    • Tensor.remove_zeros()
    • Tensor.rename_vars()
    • Tensor.round()
    • Tensor.save()
    • Tensor.simplify()
    • Tensor.subs()
    • Tensor.subs_tensor()
  • makeinds()
  • matrix
    • matrix.T()
    • matrix.__add__()
    • matrix.__annotations__
    • matrix.__div__()
    • matrix.__firstlineno__
    • matrix.__init__()
    • matrix.__module__
    • matrix.__mul__()
    • matrix.__radd__()
    • matrix.__rmul__()
    • matrix.__rsub__()
    • matrix.__static_attributes__
    • matrix.__sub__()
  • tensor2Y()
  • var_name()
  • var_name_xyz()

Module contents

symmetr.parse(clargs=None)

Parses the input line arguments

If clargs is not set then this parses the input arguments. Otherwise clargs is a string that contains the input arguments like on command line. :param clargs: The input arguments to be parsed. :type clargs: optional[string]

symmetr.sym_mham(opt, printit=False)

symmetr.sym_res(opt, printit=False)

A wrapper function that returns the appropriate response tensor based on the input options.

Parameters:

• opt (class options) – stores all the input arguments. Only some are used here.

• printit (optional[boolean]) – if true this prints the output