Use convenience exports from pymatgen/core/__init__.py where no ris…

…k of circular imports (#3461)

* simplify imports using convenience exports from pymatgen/core/__init__.py

* revert composition.py and
structure.py

* more

pymatgen/alchemy/filters.py

@@ -9,7 +9,7 @@
 from monty.json import MSONable
 
 from pymatgen.analysis.structure_matcher import ElementComparator, StructureMatcher
-from pymatgen.core.periodic_table import get_el_sp
+from pymatgen.core import get_el_sp
 from pymatgen.symmetry.analyzer import SpacegroupAnalyzer
 
 if TYPE_CHECKING:

pymatgen/analysis/bond_valence.py

@@ -12,7 +12,7 @@
 import numpy as np
 from monty.serialization import loadfn
 
-from pymatgen.core.periodic_table import Element, Species, get_el_sp
+from pymatgen.core import Element, Species, get_el_sp
 from pymatgen.symmetry.analyzer import SpacegroupAnalyzer
 
 if TYPE_CHECKING:

pymatgen/analysis/chemenv/coordination_environments/structure_environments.py

@@ -17,9 +17,7 @@
 from pymatgen.analysis.chemenv.coordination_environments.voronoi import DetailedVoronoiContainer
 from pymatgen.analysis.chemenv.utils.chemenv_errors import ChemenvError
 from pymatgen.analysis.chemenv.utils.defs_utils import AdditionalConditions
-from pymatgen.core.periodic_table import Element, Species
-from pymatgen.core.sites import PeriodicSite
-from pymatgen.core.structure import PeriodicNeighbor, Structure
+from pymatgen.core import Element, PeriodicNeighbor, PeriodicSite, Species, Structure
 
 if TYPE_CHECKING:
     import matplotlib.pyplot as plt

pymatgen/analysis/cost.py

@@ -18,8 +18,7 @@
 from monty.design_patterns import singleton
 
 from pymatgen.analysis.phase_diagram import PDEntry, PhaseDiagram
-from pymatgen.core.composition import Composition
-from pymatgen.core.periodic_table import Element
+from pymatgen.core import Composition, Element
 from pymatgen.util.provenance import is_valid_bibtex
 
 __author__ = "Anubhav Jain"

pymatgen/analysis/hhi.py

@@ -15,8 +15,7 @@
 
 from monty.design_patterns import singleton
 
-from pymatgen.core.composition import Composition
-from pymatgen.core.periodic_table import Element
+from pymatgen.core import Composition, Element
 
 __author__ = "Anubhav Jain"
 __copyright__ = "Copyright 2014, The Materials Project"

pymatgen/analysis/magnetism/jahnteller.py

@@ -10,7 +10,7 @@
 
 from pymatgen.analysis.bond_valence import BVAnalyzer
 from pymatgen.analysis.local_env import LocalStructOrderParams, get_neighbors_of_site_with_index
-from pymatgen.core.periodic_table import Species, get_el_sp
+from pymatgen.core import Species, get_el_sp
 from pymatgen.symmetry.analyzer import SpacegroupAnalyzer
 
 if TYPE_CHECKING:

pymatgen/analysis/nmr.py

@@ -6,8 +6,7 @@
 
 import numpy as np
 
-from pymatgen.core.periodic_table import Species
-from pymatgen.core.structure import Site
+from pymatgen.core import Site, Species
 from pymatgen.core.tensors import SquareTensor
 from pymatgen.core.units import FloatWithUnit
 from pymatgen.util.due import Doi, due

pymatgen/analysis/phase_diagram.py

@@ -24,8 +24,8 @@
 from tqdm import tqdm
 
 from pymatgen.analysis.reaction_calculator import Reaction, ReactionError
+from pymatgen.core import DummySpecies, Element, get_el_sp
 from pymatgen.core.composition import Composition
-from pymatgen.core.periodic_table import DummySpecies, Element, get_el_sp
 from pymatgen.entries import Entry
 from pymatgen.util.coord import Simplex, in_coord_list
 from pymatgen.util.due import Doi, due

pymatgen/analysis/structure_analyzer.py

@@ -13,9 +13,7 @@
 from scipy.spatial import Voronoi
 
 from pymatgen.analysis.local_env import JmolNN, VoronoiNN
-from pymatgen.core.composition import Composition
-from pymatgen.core.periodic_table import Element, Species
-from pymatgen.core.sites import PeriodicSite
+from pymatgen.core import Composition, Element, PeriodicSite, Species
 from pymatgen.symmetry.analyzer import SpacegroupAnalyzer
 
 if TYPE_CHECKING:

pymatgen/analysis/structure_matcher.py

@@ -9,17 +9,16 @@
 import numpy as np
 from monty.json import MSONable
 
-from pymatgen.core.composition import Composition, SpeciesLike
-from pymatgen.core.lattice import Lattice
-from pymatgen.core.periodic_table import get_el_sp
-from pymatgen.core.structure import Structure
+from pymatgen.core import Composition, Lattice, Structure, get_el_sp
 from pymatgen.optimization.linear_assignment import LinearAssignment
 from pymatgen.util.coord import lattice_points_in_supercell
 from pymatgen.util.coord_cython import is_coord_subset_pbc, pbc_shortest_vectors
 
 if TYPE_CHECKING:
     from collections.abc import Mapping, Sequence
 
+    from pymatgen.util.typing import SpeciesLike
+
 __author__ = "William Davidson Richards, Stephen Dacek, Shyue Ping Ong"
 __copyright__ = "Copyright 2011, The Materials Project"
 __version__ = "1.0"

pymatgen/analysis/structure_prediction/dopant_predictor.py

@@ -7,7 +7,7 @@
 import numpy as np
 
 from pymatgen.analysis.structure_prediction.substitution_probability import SubstitutionPredictor
-from pymatgen.core.periodic_table import Element, Species
+from pymatgen.core import Element, Species
 
 
 def get_dopants_from_substitution_probabilities(structure, num_dopants=5, threshold=0.001, match_oxi_sign=False):

pymatgen/analysis/structure_prediction/substitutor.py

@@ -13,7 +13,7 @@
 from pymatgen.alchemy.materials import TransformedStructure
 from pymatgen.alchemy.transmuters import StandardTransmuter
 from pymatgen.analysis.structure_prediction.substitution_probability import SubstitutionProbability
-from pymatgen.core.periodic_table import get_el_sp
+from pymatgen.core import get_el_sp
 from pymatgen.transformations.standard_transformations import SubstitutionTransformation
 from pymatgen.util.due import Doi, due
 

pymatgen/analysis/xps.py

@@ -26,7 +26,7 @@
 import numpy as np
 import pandas as pd
 
-from pymatgen.core.periodic_table import Element
+from pymatgen.core import Element
 from pymatgen.core.spectrum import Spectrum
 from pymatgen.util.due import Doi, due
 

pymatgen/apps/battery/analyzer.py

@@ -7,8 +7,7 @@
 
 import scipy.constants as const
 
-from pymatgen.core.periodic_table import Element, Species
-from pymatgen.core.structure import Composition
+from pymatgen.core import Composition, Element, Species
 
 __author__ = "Anubhav Jain"
 __copyright__ = "Copyright 2011, The Materials Project"

pymatgen/apps/battery/conversion_battery.py

@@ -10,8 +10,7 @@
 from pymatgen.analysis.phase_diagram import PhaseDiagram
 from pymatgen.analysis.reaction_calculator import BalancedReaction
 from pymatgen.apps.battery.battery_abc import AbstractElectrode, AbstractVoltagePair
-from pymatgen.core.composition import Composition
-from pymatgen.core.periodic_table import Element
+from pymatgen.core import Composition, Element
 from pymatgen.core.units import Charge, Time
 
 if TYPE_CHECKING:

pymatgen/command_line/critic2_caller.py

@@ -55,7 +55,7 @@
 from scipy.spatial import KDTree
 
 from pymatgen.analysis.graphs import StructureGraph
-from pymatgen.core.periodic_table import DummySpecies
+from pymatgen.core import DummySpecies
 from pymatgen.io.vasp.inputs import Potcar
 from pymatgen.io.vasp.outputs import Chgcar, VolumetricData
 from pymatgen.util.due import Doi, due

pymatgen/command_line/enumlib_caller.py

@@ -40,9 +40,7 @@
 from monty.fractions import lcm
 from monty.tempfile import ScratchDir
 
-from pymatgen.core.periodic_table import DummySpecies
-from pymatgen.core.sites import PeriodicSite
-from pymatgen.core.structure import Structure
+from pymatgen.core import DummySpecies, PeriodicSite, Structure
 from pymatgen.io.vasp.inputs import Poscar
 from pymatgen.symmetry.analyzer import SpacegroupAnalyzer
 

pymatgen/command_line/gulp_caller.py

@@ -12,9 +12,7 @@
 from monty.tempfile import ScratchDir
 
 from pymatgen.analysis.bond_valence import BVAnalyzer
-from pymatgen.core.lattice import Lattice
-from pymatgen.core.periodic_table import Element
-from pymatgen.core.structure import Structure
+from pymatgen.core import Element, Lattice, Structure
 from pymatgen.symmetry.analyzer import SpacegroupAnalyzer
 
 __author__ = "Bharat Medasani, Wenhao Sun"

pymatgen/core/__init__.py

@@ -17,11 +17,13 @@
 from pymatgen.core.periodic_table import DummySpecies as DummySpecies
 from pymatgen.core.periodic_table import Element as Element
 from pymatgen.core.periodic_table import Species as Species
+from pymatgen.core.periodic_table import get_el_sp as get_el_sp
 from pymatgen.core.sites import PeriodicSite as PeriodicSite
 from pymatgen.core.sites import Site as Site
 from pymatgen.core.structure import IMolecule as IMolecule
 from pymatgen.core.structure import IStructure as IStructure
 from pymatgen.core.structure import Molecule as Molecule
+from pymatgen.core.structure import PeriodicNeighbor as PeriodicNeighbor
 from pymatgen.core.structure import SiteCollection as SiteCollection
 from pymatgen.core.structure import Structure as Structure
 from pymatgen.core.units import ArrayWithUnit as ArrayWithUnit

pymatgen/core/bonds.py

@@ -10,7 +10,7 @@
 import warnings
 from typing import TYPE_CHECKING
 
-from pymatgen.core.periodic_table import Element
+from pymatgen.core import Element
 
 if TYPE_CHECKING:
     from pymatgen.core.sites import Site

pymatgen/core/molecular_orbitals.py

@@ -6,8 +6,8 @@
 
 from itertools import chain, combinations
 
+from pymatgen.core import Element
 from pymatgen.core.composition import Composition
-from pymatgen.core.periodic_table import Element
 
 
 class MolecularOrbitals:

pymatgen/core/surface.py

@@ -29,10 +29,7 @@
 from scipy.spatial.distance import squareform
 
 from pymatgen.analysis.structure_matcher import StructureMatcher
-from pymatgen.core.lattice import Lattice
-from pymatgen.core.periodic_table import get_el_sp
-from pymatgen.core.sites import PeriodicSite
-from pymatgen.core.structure import Structure
+from pymatgen.core import Lattice, PeriodicSite, Structure, get_el_sp
 from pymatgen.symmetry.analyzer import SpacegroupAnalyzer
 from pymatgen.util.coord import in_coord_list
 from pymatgen.util.due import Doi, due

pymatgen/electronic_structure/bandstructure.py

@@ -11,9 +11,7 @@
 import numpy as np
 from monty.json import MSONable
 
-from pymatgen.core.lattice import Lattice
-from pymatgen.core.periodic_table import Element, get_el_sp
-from pymatgen.core.structure import Structure
+from pymatgen.core import Element, Lattice, Structure, get_el_sp
 from pymatgen.electronic_structure.core import Orbital, Spin
 from pymatgen.symmetry.analyzer import SpacegroupAnalyzer
 from pymatgen.util.coord import pbc_diff

pymatgen/electronic_structure/dos.py

@@ -12,9 +12,8 @@
 from scipy.constants import value as _cd
 from scipy.signal import hilbert
 
-from pymatgen.core.periodic_table import get_el_sp
+from pymatgen.core import Structure, get_el_sp
 from pymatgen.core.spectrum import Spectrum
-from pymatgen.core.structure import Structure
 from pymatgen.electronic_structure.core import Orbital, OrbitalType, Spin
 from pymatgen.util.coord import get_linear_interpolated_value
 

pymatgen/electronic_structure/plotter.py

@@ -18,7 +18,7 @@
 from monty.dev import requires
 from monty.json import jsanitize
 
-from pymatgen.core.periodic_table import Element
+from pymatgen.core import Element
 from pymatgen.electronic_structure.bandstructure import BandStructureSymmLine
 from pymatgen.electronic_structure.boltztrap import BoltztrapError
 from pymatgen.electronic_structure.core import OrbitalType, Spin
@@ -1823,7 +1823,7 @@ def _Orbitals_SumOrbitals(cls, dictio, sum_morbs):
     def _number_of_subfigures(self, dictio, dictpa, sum_atoms, sum_morbs):
         from collections import Counter
 
-        from pymatgen.core.periodic_table import Element
+        from pymatgen.core import Element
 
         if not isinstance(dictpa, dict):
             raise TypeError("The invalid type of 'dictpa' was bound. It should be dict type.")
@@ -1949,7 +1949,7 @@ def _number_of_subfigures(self, dictio, dictpa, sum_atoms, sum_morbs):
         return dictpa, sum_atoms, number_figs
 
     def _summarize_keys_for_plot(self, dictio, dictpa, sum_atoms, sum_morbs):
-        from pymatgen.core.periodic_table import Element
+        from pymatgen.core import Element
 
         individual_orbs = {
             "p": ["px", "py", "pz"],

pymatgen/entries/compatibility.py

@@ -19,8 +19,7 @@
 from uncertainties import ufloat
 
 from pymatgen.analysis.structure_analyzer import oxide_type, sulfide_type
-from pymatgen.core import SETTINGS
-from pymatgen.core.periodic_table import Element
+from pymatgen.core import SETTINGS, Element
 from pymatgen.entries.computed_entries import (
     CompositionEnergyAdjustment,
     ComputedEntry,

pymatgen/entries/correction_calculator.py

@@ -15,8 +15,7 @@
 
 from pymatgen.analysis.reaction_calculator import ComputedReaction
 from pymatgen.analysis.structure_analyzer import sulfide_type
-from pymatgen.core.composition import Composition
-from pymatgen.core.periodic_table import Element
+from pymatgen.core import Composition, Element
 
 
 class CorrectionCalculator:

pymatgen/entries/entry_tools.py

@@ -17,8 +17,7 @@
 
 from pymatgen.analysis.phase_diagram import PDEntry
 from pymatgen.analysis.structure_matcher import SpeciesComparator, StructureMatcher
-from pymatgen.core.composition import Composition
-from pymatgen.core.periodic_table import Element
+from pymatgen.core import Composition, Element
 
 if TYPE_CHECKING:
     from collections.abc import Iterable

pymatgen/ext/matproj_legacy.py

@@ -23,11 +23,8 @@
 from ruamel.yaml import YAML
 from tqdm import tqdm
 
-from pymatgen.core import SETTINGS
+from pymatgen.core import SETTINGS, Composition, Element, Structure
 from pymatgen.core import __version__ as PMG_VERSION
-from pymatgen.core.composition import Composition
-from pymatgen.core.periodic_table import Element
-from pymatgen.core.structure import Structure
 from pymatgen.core.surface import get_symmetrically_equivalent_miller_indices
 from pymatgen.entries.computed_entries import ComputedEntry, ComputedStructureEntry
 from pymatgen.entries.exp_entries import ExpEntry

pymatgen/ext/optimade.py

@@ -11,8 +11,7 @@
 import requests
 from tqdm import tqdm
 
-from pymatgen.core.periodic_table import DummySpecies
-from pymatgen.core.structure import Structure
+from pymatgen.core import DummySpecies, Structure
 from pymatgen.util.due import Doi, due
 from pymatgen.util.provenance import StructureNL
 

pymatgen/io/abinit/pseudos.py

@@ -21,7 +21,7 @@
 from monty.os.path import find_exts
 from tabulate import tabulate
 
-from pymatgen.core.periodic_table import Element
+from pymatgen.core import Element
 from pymatgen.core.xcfunc import XcFunc
 from pymatgen.io.core import ParseError
 from pymatgen.util.plotting import add_fig_kwargs, get_ax_fig

pymatgen/io/atat.py

@@ -5,9 +5,7 @@
 import numpy as np
 from monty.dev import deprecated
 
-from pymatgen.core.lattice import Lattice
-from pymatgen.core.periodic_table import get_el_sp
-from pymatgen.core.structure import Structure
+from pymatgen.core import Lattice, Structure, get_el_sp
 
 __author__ = "Matthew Horton"
 __copyright__ = "Copyright 2017, The Materials Project"

pymatgen/io/cif.py

@@ -19,12 +19,8 @@
 from monty.io import zopen
 from monty.serialization import loadfn
 
-from pymatgen.core.composition import Composition
-from pymatgen.core.lattice import Lattice
+from pymatgen.core import Composition, DummySpecies, Element, Lattice, PeriodicSite, Species, Structure, get_el_sp
 from pymatgen.core.operations import MagSymmOp, SymmOp
-from pymatgen.core.periodic_table import DummySpecies, Element, Species, get_el_sp
-from pymatgen.core.sites import PeriodicSite
-from pymatgen.core.structure import Structure
 from pymatgen.electronic_structure.core import Magmom
 from pymatgen.symmetry.analyzer import SpacegroupAnalyzer, SpacegroupOperations
 from pymatgen.symmetry.groups import SYMM_DATA, SpaceGroup

pymatgen/io/cp2k/inputs.py

@@ -39,7 +39,7 @@
 from monty.io import zopen
 from monty.json import MSONable
 
-from pymatgen.core.periodic_table import Element
+from pymatgen.core import Element
 from pymatgen.io.cp2k.utils import chunk, postprocessor, preprocessor
 from pymatgen.io.vasp.inputs import Kpoints as VaspKpoints
 from pymatgen.io.vasp.inputs import KpointsSupportedModes

pymatgen/io/exciting/inputs.py

@@ -9,9 +9,7 @@
 from monty.io import zopen
 from monty.json import MSONable
 
-from pymatgen.core.lattice import Lattice
-from pymatgen.core.periodic_table import Element
-from pymatgen.core.structure import Structure
+from pymatgen.core import Element, Lattice, Structure
 from pymatgen.symmetry.analyzer import SpacegroupAnalyzer
 from pymatgen.symmetry.bandstructure import HighSymmKpath
 

pymatgen/io/feff/inputs.py

@@ -16,9 +16,7 @@
 from monty.json import MSONable
 from tabulate import tabulate
 
-from pymatgen.core.lattice import Lattice
-from pymatgen.core.periodic_table import Element
-from pymatgen.core.structure import Molecule, Structure
+from pymatgen.core import Element, Lattice, Molecule, Structure
 from pymatgen.io.cif import CifParser
 from pymatgen.io.core import ParseError
 from pymatgen.symmetry.analyzer import SpacegroupAnalyzer