API Reference

• ferrodispcalc package
  • Submodules
    • ferrodispcalc.compute
      • calculate_averaged_structure()
      • calculate_dielectric_constant()
      • calculate_displacement()
      • calculate_octahedral_tilt()
      • calculate_polarization()
    • ferrodispcalc.neighborlist
      • build_neighbor_list()
      • save_neighbor_list()
    • ferrodispcalc.io
      • read_lammps_data()
      • read_lammps_dump()
      • read_lammps_log()
    • ferrodispcalc.config
      • TypeMap
    • ferrodispcalc.sed
      • DipoleModeResult
      • DipoleSedResult
      • calculate_sed()
      • extract_eigen_vector()
      • generate_commensurate_qpath()
      • load_eigen_vector()
      • load_sed()
      • plot_sed()
      • plot_sed_1d()
      • save_eigen_vector()
      • save_sed()
  • ferrodispcalc.vis
    • ferrodispcalc.vis.grid
      • grid_data()
    • ferrodispcalc.vis.line_plot
      • line_profile()
    • ferrodispcalc.vis.plane_plot
      • plane_profile()
      • plane_profile_multi()
    • ferrodispcalc.vis.space_plot
      • space_animation()
      • space_profile()