Package `diffpy.mpdf`

Tools for magnetic pair distribution function analysis

Expand source code

#!/usr/bin/env python
##############################################################################
#
# diffpy.mpdf         by Frandsen Group
#                     Benjamin A. Frandsen benfrandsen@byu.edu
#                     (c) 2022 Benjamin Allen Frandsen
#                      All rights reserved
#
# File coded by:    Benjamin Frandsen
#
# See AUTHORS.txt for a list of people who contributed.
# See LICENSE.txt for license information.
#
##############################################################################

"""Tools for magnetic pair distribution function analysis
"""

# package version
from diffpy.mpdf.version import __version__

# convenience imports
from diffpy.mpdf.magstructure import *
from diffpy.mpdf.mpdfcalculator import *
from diffpy.mpdf.magutils import *
from diffpy.mpdf.mpdf3Dcalculator import *
from diffpy.mpdf.visualize3D import *
from diffpy.mpdf.mciftools import *
from diffpy.mpdf.simpleparser import *
from diffpy.mpdf.mpdftransformer import *

# End of file

Sub-modules

diffpy.mpdf.magstructure: classes to create magnetic structures for mPDF calculations.
diffpy.mpdf.magutils: functions to facilitate mPDF analysis.
diffpy.mpdf.mciftools: functions for creating magnetic structures from MCIF files.
diffpy.mpdf.mpdf3Dcalculator: class to perform 3D-mPDF calculations
diffpy.mpdf.mpdfcalculator: class to perform mPDF calculations
diffpy.mpdf.mpdftransformer: class to transform magnetic scattering data into mPDF data.
diffpy.mpdf.simpleparser: Parser that can be used for CIF and MCIF files.
diffpy.mpdf.tests: Unit tests for diffpy.mpdf.
diffpy.mpdf.version: Definition of version, date, gitsha.
diffpy.mpdf.visualize3D: Generate 2D slices of 3D data for visualization.