pymatgen package

Subpackages

• pymatgen.alchemy package
  • Subpackages
  • Submodules
    • pymatgen.alchemy.filters module
    • pymatgen.alchemy.materials module
    • pymatgen.alchemy.transmuters module
  • Module contents
• pymatgen.analysis package
  • Subpackages
    • pymatgen.analysis.chemenv package
      • Subpackages
        • pymatgen.analysis.chemenv.coordination_environments package
          • Subpackages
            • pymatgen.analysis.chemenv.coordination_environments.coordination_geometries_files package
              • Module contents
            • pymatgen.analysis.chemenv.coordination_environments.strategy_files package
              • Module contents
          • Submodules
            • pymatgen.analysis.chemenv.coordination_environments.chemenv_strategies module
            • pymatgen.analysis.chemenv.coordination_environments.coordination_geometries module
            • pymatgen.analysis.chemenv.coordination_environments.coordination_geometry_finder module
            • pymatgen.analysis.chemenv.coordination_environments.structure_environments module
            • pymatgen.analysis.chemenv.coordination_environments.voronoi module
          • Module contents
        • pymatgen.analysis.chemenv.utils package
          • Subpackages
          • Submodules
            • pymatgen.analysis.chemenv.utils.chemenv_config module
            • pymatgen.analysis.chemenv.utils.chemenv_errors module
            • pymatgen.analysis.chemenv.utils.coordination_geometry_utils module
            • pymatgen.analysis.chemenv.utils.defs_utils module
            • pymatgen.analysis.chemenv.utils.func_utils module
            • pymatgen.analysis.chemenv.utils.math_utils module
            • pymatgen.analysis.chemenv.utils.scripts_utils module
          • Module contents
      • Module contents
    • pymatgen.analysis.cost package
      • Subpackages
      • Submodules
        • pymatgen.analysis.cost.cost module
      • Module contents
    • pymatgen.analysis.defects package
      • Subpackages
      • Submodules
        • pymatgen.analysis.defects.dilute_solution_model module
        • pymatgen.analysis.defects.point_defects module
        • pymatgen.analysis.defects.surf_error module
      • Module contents
    • pymatgen.analysis.diffraction package
      • Subpackages
      • Submodules
        • pymatgen.analysis.diffraction.xrd module
      • Module contents
    • pymatgen.analysis.elasticity package
      • Submodules
        • pymatgen.analysis.elasticity.elastic module
        • pymatgen.analysis.elasticity.strain module
        • pymatgen.analysis.elasticity.stress module
        • pymatgen.analysis.elasticity.tensors module
      • Module contents
    • pymatgen.analysis.ferroelectricity package
      • Submodules
        • pymatgen.analysis.ferroelectricity.polarization module
      • Module contents
    • pymatgen.analysis.hhi package
      • Subpackages
      • Submodules
        • pymatgen.analysis.hhi.hhi module
      • Module contents
    • pymatgen.analysis.pourbaix package
      • Subpackages
      • Submodules
        • pymatgen.analysis.pourbaix.analyzer module
        • pymatgen.analysis.pourbaix.entry module
        • pymatgen.analysis.pourbaix.maker module
        • pymatgen.analysis.pourbaix.plotter module
      • Module contents
    • pymatgen.analysis.structure_prediction package
      • Subpackages
      • Submodules
        • pymatgen.analysis.structure_prediction.substitution_probability module
        • pymatgen.analysis.structure_prediction.substitutor module
      • Module contents
    • pymatgen.analysis.xas package
      • Subpackages
      • Submodules
        • pymatgen.analysis.xas.spectrum module
      • Module contents
  • Submodules
    • pymatgen.analysis.adsorption module
    • pymatgen.analysis.bond_valence module
    • pymatgen.analysis.diffusion_analyzer module
    • pymatgen.analysis.energy_models module
    • pymatgen.analysis.eos module
    • pymatgen.analysis.ewald module
    • pymatgen.analysis.interface_reactions module
    • pymatgen.analysis.local_env module
    • pymatgen.analysis.molecule_matcher module
    • pymatgen.analysis.molecule_structure_comparator module
    • pymatgen.analysis.nmr module
    • pymatgen.analysis.path_finder module
    • pymatgen.analysis.phase_diagram module
    • pymatgen.analysis.piezo module
    • pymatgen.analysis.quasiharmonic module
    • pymatgen.analysis.reaction_calculator module
    • pymatgen.analysis.structure_analyzer module
    • pymatgen.analysis.structure_matcher module
    • pymatgen.analysis.substrate_analyzer module
    • pymatgen.analysis.surface_analysis module
    • pymatgen.analysis.thermochemistry module
    • pymatgen.analysis.transition_state module
    • pymatgen.analysis.wulff module
  • Module contents
• pymatgen.apps package
  • Subpackages
    • pymatgen.apps.battery package
      • Subpackages
      • Submodules
        • pymatgen.apps.battery.analyzer module
        • pymatgen.apps.battery.battery_abc module
        • pymatgen.apps.battery.conversion_battery module
        • pymatgen.apps.battery.insertion_battery module
        • pymatgen.apps.battery.plotter module
      • Module contents
    • pymatgen.apps.borg package
      • Subpackages
      • Submodules
        • pymatgen.apps.borg.hive module
        • pymatgen.apps.borg.queen module
      • Module contents
  • Module contents
• pymatgen.cli package
  • Submodules
    • pymatgen.cli.feff_input_generation module
    • pymatgen.cli.feff_plot_cross_section module
    • pymatgen.cli.feff_plot_dos module
    • pymatgen.cli.gaussian_analyzer module
    • pymatgen.cli.get_environment module
    • pymatgen.cli.pmg module
    • pymatgen.cli.pmg_analyze module
    • pymatgen.cli.pmg_config module
    • pymatgen.cli.pmg_plot module
    • pymatgen.cli.pmg_potcar module
    • pymatgen.cli.pmg_query module
    • pymatgen.cli.pmg_structure module
    • pymatgen.cli.pydii module
  • Module contents
• pymatgen.command_line package
  • Subpackages
  • Submodules
    • pymatgen.command_line.aconvasp_caller module
    • pymatgen.command_line.bader_caller module
    • pymatgen.command_line.enumlib_caller module
    • pymatgen.command_line.gulp_caller module
  • Module contents
• pymatgen.core package
  • Subpackages
  • Submodules
    • pymatgen.core.bonds module
    • pymatgen.core.composition module
    • pymatgen.core.ion module
    • pymatgen.core.lattice module
    • pymatgen.core.libxcfunc module
    • pymatgen.core.operations module
    • pymatgen.core.periodic_table module
    • pymatgen.core.sites module
    • pymatgen.core.spectrum module
    • pymatgen.core.structure module
    • pymatgen.core.surface module
    • pymatgen.core.units module
    • pymatgen.core.xcfunc module
  • Module contents
• pymatgen.electronic_structure package
  • Subpackages
  • Submodules
    • pymatgen.electronic_structure.bandstructure module
    • pymatgen.electronic_structure.boltztrap module
    • pymatgen.electronic_structure.core module
    • pymatgen.electronic_structure.dos module
    • pymatgen.electronic_structure.plotter module
  • Module contents
• pymatgen.entries package
  • Subpackages
  • Submodules
    • pymatgen.entries.compatibility module
    • pymatgen.entries.computed_entries module
    • pymatgen.entries.entry_tools module
    • pymatgen.entries.exp_entries module
    • pymatgen.entries.post_processors_abc module
  • Module contents
• pymatgen.ext package
  • Subpackages
  • Submodules
    • pymatgen.ext.cod module
    • pymatgen.ext.jhu module
    • pymatgen.ext.matproj module
  • Module contents
• pymatgen.io package
  • Subpackages
    • pymatgen.io.abinit package
      • Subpackages
      • Submodules
        • pymatgen.io.abinit.abiinspect module
        • pymatgen.io.abinit.abiobjects module
        • pymatgen.io.abinit.abitimer module
        • pymatgen.io.abinit.calculations module
        • pymatgen.io.abinit.db module
        • pymatgen.io.abinit.events module
        • pymatgen.io.abinit.flows module
        • pymatgen.io.abinit.helpers module
        • pymatgen.io.abinit.launcher module
        • pymatgen.io.abinit.netcdf module
        • pymatgen.io.abinit.nodes module
        • pymatgen.io.abinit.pseudos module
        • pymatgen.io.abinit.qadapters module
        • pymatgen.io.abinit.qjobs module
        • pymatgen.io.abinit.qutils module
        • pymatgen.io.abinit.scheduler_error_handlers module
        • pymatgen.io.abinit.scheduler_error_parsers module
        • pymatgen.io.abinit.tasks module
        • pymatgen.io.abinit.utils module
        • pymatgen.io.abinit.works module
        • pymatgen.io.abinit.wrappers module
      • Module contents
    • pymatgen.io.exciting package
      • Submodules
        • pymatgen.io.exciting.inputs module
      • Module contents
    • pymatgen.io.feff package
      • Subpackages
      • Submodules
        • pymatgen.io.feff.inputs module
        • pymatgen.io.feff.outputs module
        • pymatgen.io.feff.sets module
      • Module contents
    • pymatgen.io.lammps package
      • Subpackages
      • Submodules
        • pymatgen.io.lammps.data module
        • pymatgen.io.lammps.force_field module
        • pymatgen.io.lammps.input module
        • pymatgen.io.lammps.output module
        • pymatgen.io.lammps.sets module
        • pymatgen.io.lammps.topology module
        • pymatgen.io.lammps.utils module
      • Module contents
    • pymatgen.io.vasp package
      • Subpackages
      • Submodules
        • pymatgen.io.vasp.inputs module
        • pymatgen.io.vasp.outputs module
        • pymatgen.io.vasp.sets module
      • Module contents
  • Submodules
    • pymatgen.io.adf module
    • pymatgen.io.aiida module
    • pymatgen.io.ase module
    • pymatgen.io.babel module
    • pymatgen.io.cif module
    • pymatgen.io.cssr module
    • pymatgen.io.fiesta module
    • pymatgen.io.gaussian module
    • pymatgen.io.nwchem module
    • pymatgen.io.phonopy module
    • pymatgen.io.pwscf module
    • pymatgen.io.qchem module
    • pymatgen.io.xcrysden module
    • pymatgen.io.xr module
    • pymatgen.io.xyz module
    • pymatgen.io.zeopp module
  • Module contents
• pymatgen.matproj package
  • Submodules
    • pymatgen.matproj.rest module
    • pymatgen.matproj.snl module
  • Module contents
• pymatgen.optimization package
  • Subpackages
  • Submodules
    • pymatgen.optimization.linear_assignment module
    • pymatgen.optimization.linear_assignment_numpy module
  • Module contents
• pymatgen.phasediagram package
  • Submodules
    • pymatgen.phasediagram.analyzer module
    • pymatgen.phasediagram.entries module
    • pymatgen.phasediagram.maker module
    • pymatgen.phasediagram.plotter module
  • Module contents
• pymatgen.phonon package
  • Subpackages
  • Submodules
    • pymatgen.phonon.bandstructure module
    • pymatgen.phonon.dos module
    • pymatgen.phonon.plotter module
  • Module contents
• pymatgen.serializers package
  • Submodules
    • pymatgen.serializers.json_coders module
    • pymatgen.serializers.pickle_coders module
  • Module contents
• pymatgen.structure_prediction package
  • Submodules
    • pymatgen.structure_prediction.substitution_probability module
    • pymatgen.structure_prediction.substitutor module
  • Module contents
• pymatgen.symmetry package
  • Subpackages
  • Submodules
    • pymatgen.symmetry.analyzer module
    • pymatgen.symmetry.bandstructure module
    • pymatgen.symmetry.groups module
    • pymatgen.symmetry.maggroups module
    • pymatgen.symmetry.settings module
    • pymatgen.symmetry.structure module
  • Module contents
• pymatgen.transformations package
  • Subpackages
  • Submodules
    • pymatgen.transformations.advanced_transformations module
    • pymatgen.transformations.defect_transformations module
    • pymatgen.transformations.site_transformations module
    • pymatgen.transformations.standard_transformations module
    • pymatgen.transformations.transformation_abc module
  • Module contents
• pymatgen.util package
  • Subpackages
  • Submodules
    • pymatgen.util.convergence module
    • pymatgen.util.coord_utils module
    • pymatgen.util.coord_utils_cython module
    • pymatgen.util.io_utils module
    • pymatgen.util.num module
    • pymatgen.util.num_utils module
    • pymatgen.util.plotting module
    • pymatgen.util.plotting_utils module
    • pymatgen.util.provenance module
    • pymatgen.util.serialization module
    • pymatgen.util.string module
    • pymatgen.util.string_utils module
    • pymatgen.util.testing module
  • Module contents
• pymatgen.vis package
  • Subpackages
  • Submodules
    • pymatgen.vis.plotters module
    • pymatgen.vis.structure_chemview module
    • pymatgen.vis.structure_vtk module
  • Module contents

Submodules

• pymatgen.dao module

Module contents

get_structure_from_mp(formula)

Convenience method to get a crystal from the Materials Project database via the API. Requires PMG_MAPI_KEY to be set.

Parameters:formula (str) – A formula Returns:

(Structure) The lowest energy structure in Materials Project with that

formula.