pymatgen.util package

Subpackages

Submodules

• pymatgen.util.convergence module
  • SplineInputError
  • determine_convergence()
  • exponential()
  • extrapolate_reciprocal()
  • extrapolate_simple_reciprocal()
  • get_derivatives()
  • get_weights()
  • id_generator()
  • measure()
  • multi_curve_fit()
  • multi_reciprocal_extra()
  • p0_exponential()
  • p0_reciprocal()
  • p0_simple_2reciprocal()
  • p0_simple_4reciprocal()
  • p0_simple_5reciprocal()
  • p0_simple_reciprocal()
  • p0_single_reciprocal()
  • print_and_raise_error()
  • print_plot_line()
  • reciprocal()
  • simple_2reciprocal()
  • simple_4reciprocal()
  • simple_5reciprocal()
  • simple_reciprocal()
  • single_reciprocal()
• pymatgen.util.coord module
  • Simplex
    • Simplex.bary_coords()
    • Simplex.coords
    • Simplex.in_simplex()
    • Simplex.line_intersection()
    • Simplex.point_from_bary_coords()
    • Simplex.volume
  • all_distances()
  • barycentric_coords()
  • coord_list_mapping()
  • coord_list_mapping_pbc()
  • find_in_coord_list()
  • find_in_coord_list_pbc()
  • get_angle()
  • get_linear_interpolated_value()
  • in_coord_list()
  • in_coord_list_pbc()
  • is_coord_subset()
  • is_coord_subset_pbc()
  • lattice_points_in_supercell()
  • pbc_diff()
  • pbc_shortest_vectors()
• pymatgen.util.coord_cython module
  • coord_list_mapping_pbc()
  • is_coord_subset_pbc()
  • pbc_shortest_vectors()
• pymatgen.util.coord_cython module
  • coord_list_mapping_pbc()
  • is_coord_subset_pbc()
  • pbc_shortest_vectors()
• pymatgen.util.coord_cython module
  • coord_list_mapping_pbc()
  • is_coord_subset_pbc()
  • pbc_shortest_vectors()
• pymatgen.util.io_utils module
  • AtomicFile
    • AtomicFile.close()
    • AtomicFile.discard()
  • ask_yesno()
  • clean_lines()
  • micro_pyawk()
• pymatgen.util.num module
  • abs_cap()
  • make_symmetric_matrix_from_upper_tri()
  • maxloc()
  • min_max_indexes()
  • minloc()
  • monotonic()
  • non_decreasing()
  • non_increasing()
  • round_to_sigfigs()
  • strictly_decreasing()
  • strictly_increasing()
• pymatgen.util.plotting module
  • add_fig_kwargs()
  • format_formula()
  • get_ax3d_fig_plt()
  • get_ax_fig_plt()
  • get_axarray_fig_plt()
  • periodic_table_heatmap()
  • pretty_plot()
  • pretty_plot_two_axis()
  • pretty_polyfit_plot()
  • van_arkel_triangle()
• pymatgen.util.provenance module
  • Author
    • Author.name
    • Author.email
    • Author.as_dict()
    • Author.from_dict()
    • Author.parse_author()
  • HistoryNode
    • HistoryNode.name
    • HistoryNode.url
    • HistoryNode.description
    • HistoryNode.as_dict()
    • HistoryNode.from_dict()
    • HistoryNode.parse_history_node()
  • StructureNL
    • StructureNL.as_dict()
    • StructureNL.from_dict()
    • StructureNL.from_structures()
  • is_valid_bibtex()
• pymatgen.util.serialization module
  • PmgPickler
    • PmgPickler.persistent_id()
  • PmgUnpickler
    • PmgUnpickler.persistent_load()
  • json_pretty_dump()
  • pmg_pickle_dump()
  • pmg_pickle_load()
  • pmg_serialize()
• pymatgen.util.string module
  • Stringify
    • Stringify.STRING_MODE
    • Stringify.to_html_string()
    • Stringify.to_latex_string()
    • Stringify.to_pretty_string()
    • Stringify.to_unicode_string()
  • charge_string()
  • disordered_formula()
  • formula_double_format()
  • htmlify()
  • latexify()
  • latexify_spacegroup()
  • str_delimited()
  • stream_has_colours()
  • transformation_to_string()
  • unicodeify()
  • unicodeify_spacegroup()
  • unicodeify_species()
• pymatgen.util.testing module
  • PymatgenTest
    • PymatgenTest.MODULE_DIR
    • PymatgenTest.STRUCTURES_DIR
    • PymatgenTest.TEST_FILES_DIR
    • PymatgenTest.TEST_STRUCTURES
    • PymatgenTest.assertArrayAlmostEqual()
    • PymatgenTest.assertArrayEqual()
    • PymatgenTest.assertDictsAlmostEqual()
    • PymatgenTest.assertMSONable()
    • PymatgenTest.assertStrContentEqual()
    • PymatgenTest.fn
    • PymatgenTest.get_mp_structure()
    • PymatgenTest.get_structure()
    • PymatgenTest.serialize_with_pickle()
    • PymatgenTest.warnings
• pymatgen.util.typing module

Module contents

The util package implements various utilities that are commonly used by various packages.