API

The program can be used from python directly, which allows automation or further manipulation of the results.

For the response mode the main function to use is symmetr.funcs_main.sym_res(), analogous function for the mham mode is symmetr.funcs_main.sym_mham(). The input parameters are parsed using a function symmetr.input.parse(), which takes as an input string that contains parameters exactly like when used from command line.

Example:

from symmetr import sym_res, parse

res = sym_res(parse('res j E -f input.in'))

The format of the output changes depending on the exact parameters used. In a typical case as shown here the response is a list containing the two components of the response tensor. The tensor themselves are instances of the symmetr.tensors.Tensor class, described in detail here.

Some of the features of the code are described here in more detail. See here for description of how to obtain the symmetries for given material. here you can find description of how to define a custom symmetrization.

You can find more information in the autogenerated code documentation, although note that this is incomplete.

Contents:

• Tensors
• Symmetries
  • Symmetry representation
  • Coordinate system
• Full API
  • symmetr package
  • symmetr.find_eq module
  • symmetr.fslib module
  • symmetr.funcs_main module
  • symmetr.input module
  • symmetr.magndata module
  • symmetr.mham module
  • symmetr.noso_new module
  • symmetr.symT module
  • symmetr.symmetrize module
  • symmetr.symmetrize_exp module
  • symmetr.symmetry module
  • symmetr.tensors module