diff --git a/.github/workflows/test.yml b/.github/workflows/test.yml index 62d4b81009f..65fb74581ee 100644 --- a/.github/workflows/test.yml +++ b/.github/workflows/test.yml @@ -21,7 +21,7 @@ permissions: contents: read jobs: - pytest: + test: # prevent this action from running on forks if: github.repository == 'materialsproject/pymatgen' strategy: @@ -96,7 +96,7 @@ jobs: path: .coverage coverage: - needs: pytest + needs: test runs-on: ubuntu-latest steps: - uses: actions/checkout@v3 @@ -120,8 +120,7 @@ jobs: uses: AndreMiras/coveralls-python-action@v20201129 build_sdist: - needs: pytest - name: Build source distribution + needs: test runs-on: ubuntu-latest steps: - uses: actions/checkout@v3 @@ -137,7 +136,7 @@ jobs: path: dist/*.tar.gz build_wheels: - needs: pytest + needs: test strategy: matrix: os: [ubuntu-latest, macos-latest, windows-latest] diff --git a/docs/change_log.html b/docs/change_log.html index 35aac4f24d0..e490dd4c2bc 100644 --- a/docs/change_log.html +++ b/docs/change_log.html @@ -3340,7 +3340,7 @@

v2.8.0pymatgen.core.units and the +easy conversion. Please see pymatgen.core.units and the examples for a demonstration of house to use units in pymatgen.

  • Minor backwards-incompatible change. Structures are now sorted by diff --git a/docs/genindex.html b/docs/genindex.html index b6c0eaf0c49..f20316d1e99 100644 --- a/docs/genindex.html +++ b/docs/genindex.html @@ -117,1221 +117,1221 @@

    Index

    A

    @@ -1339,269 +1339,269 @@

    A

    B

    @@ -1609,747 +1609,747 @@

    B

    C

    @@ -2357,389 +2357,389 @@

    C

    D

    @@ -2747,453 +2747,453 @@

    D

    E

    @@ -3201,1115 +3201,1115 @@

    E

    F

    @@ -4317,2261 +4317,2261 @@

    F

    G

    @@ -6579,293 +6579,293 @@

    G

    H

    @@ -6873,655 +6873,655 @@

    H

    I

    @@ -7529,23 +7529,23 @@

    I

    J

    @@ -7553,107 +7553,107 @@

    J

    K

    @@ -7661,329 +7661,329 @@

    K

    L

    @@ -7991,443 +7991,443 @@

    L

    M

    @@ -9188,401 +9188,401 @@

    M

    N

    @@ -9590,211 +9590,211 @@

    N

    O

    @@ -9802,841 +9802,841 @@

    O

    P

    @@ -10938,42 +10938,42 @@

    P

    pymatgen.analysis.elasticity.strain
  • pymatgen.analysis.elasticity.stress
  • pymatgen.analysis.energy_models
  • pymatgen.analysis.eos
  • pymatgen.analysis.ewald
  • pymatgen.analysis.excitation
  • @@ -10987,21 +10987,21 @@

    P

    pymatgen.analysis.ferroelectricity.polarization
  • pymatgen.analysis.fragmenter
  • pymatgen.analysis.functional_groups
  • @@ -11015,35 +11015,35 @@

    P

    pymatgen.analysis.gb.grain
  • pymatgen.analysis.graphs
  • pymatgen.analysis.hhi
  • pymatgen.analysis.interface
  • pymatgen.analysis.interface_reactions
  • @@ -11057,28 +11057,28 @@

    P

    pymatgen.analysis.interfaces.coherent_interfaces
  • pymatgen.analysis.interfaces.substrate_analyzer
  • pymatgen.analysis.interfaces.zsl
  • pymatgen.analysis.local_env
  • @@ -11092,98 +11092,98 @@

    P

    pymatgen.analysis.magnetism.analyzer
  • pymatgen.analysis.magnetism.heisenberg
  • pymatgen.analysis.magnetism.jahnteller
  • pymatgen.analysis.molecule_matcher
  • pymatgen.analysis.molecule_structure_comparator
  • pymatgen.analysis.nmr
  • pymatgen.analysis.path_finder
  • pymatgen.analysis.phase_diagram
  • pymatgen.analysis.piezo
  • pymatgen.analysis.piezo_sensitivity
  • pymatgen.analysis.pourbaix_diagram
  • pymatgen.analysis.prototypes
  • pymatgen.analysis.quasiharmonic
  • pymatgen.analysis.reaction_calculator
  • @@ -11197,21 +11197,21 @@

    P

    pymatgen.analysis.solar.slme
  • pymatgen.analysis.structure_analyzer
  • pymatgen.analysis.structure_matcher
  • @@ -11225,42 +11225,42 @@

    P

    pymatgen.analysis.structure_prediction.dopant_predictor
  • pymatgen.analysis.structure_prediction.substitution_probability
  • pymatgen.analysis.structure_prediction.substitutor
  • pymatgen.analysis.structure_prediction.volume_predictor
  • pymatgen.analysis.surface_analysis
  • pymatgen.analysis.thermochemistry
  • @@ -11274,21 +11274,21 @@

    P

    pymatgen.analysis.topological.spillage
  • pymatgen.analysis.transition_state
  • pymatgen.analysis.wulff
  • @@ -11302,14 +11302,14 @@

    P

    pymatgen.analysis.xas.spectrum
  • pymatgen.analysis.xps
  • @@ -11330,35 +11330,35 @@

    P

    pymatgen.apps.battery.analyzer
  • pymatgen.apps.battery.battery_abc
  • pymatgen.apps.battery.conversion_battery
  • pymatgen.apps.battery.insertion_battery
  • pymatgen.apps.battery.plotter
  • @@ -11372,14 +11372,14 @@

    P

    pymatgen.apps.borg.hive
  • pymatgen.apps.borg.queen
  • @@ -11393,77 +11393,77 @@

    P

    pymatgen.cli.feff_plot_cross_section
  • pymatgen.cli.feff_plot_dos
  • pymatgen.cli.gaussian_analyzer
  • pymatgen.cli.get_environment
  • pymatgen.cli.pmg
  • pymatgen.cli.pmg_analyze
  • pymatgen.cli.pmg_config
  • pymatgen.cli.pmg_plot
  • pymatgen.cli.pmg_potcar
  • pymatgen.cli.pmg_query
  • pymatgen.cli.pmg_structure
  • @@ -11477,49 +11477,49 @@

    P

    pymatgen.command_line.bader_caller
  • pymatgen.command_line.chargemol_caller
  • pymatgen.command_line.critic2_caller
  • pymatgen.command_line.enumlib_caller
  • pymatgen.command_line.gulp_caller
  • pymatgen.command_line.mcsqs_caller
  • pymatgen.command_line.vampire_caller
  • @@ -11533,126 +11533,126 @@

    P

    pymatgen.core.bonds
  • pymatgen.core.composition
  • pymatgen.core.interface
  • pymatgen.core.ion
  • pymatgen.core.lattice
  • pymatgen.core.libxcfunc
  • pymatgen.core.molecular_orbitals
  • pymatgen.core.operations
  • pymatgen.core.periodic_table
  • pymatgen.core.sites
  • pymatgen.core.spectrum
  • pymatgen.core.structure
  • pymatgen.core.surface
  • pymatgen.core.tensors
  • pymatgen.core.trajectory
  • pymatgen.core.units
  • pymatgen.core.xcfunc
  • pymatgen.dao
  • @@ -11666,49 +11666,49 @@

    P

    pymatgen.electronic_structure.bandstructure
  • pymatgen.electronic_structure.boltztrap
  • pymatgen.electronic_structure.boltztrap2
  • pymatgen.electronic_structure.cohp
  • pymatgen.electronic_structure.core
  • pymatgen.electronic_structure.dos
  • pymatgen.electronic_structure.plotter
  • @@ -11722,42 +11722,42 @@

    P

    pymatgen.entries.compatibility
  • pymatgen.entries.computed_entries
  • pymatgen.entries.correction_calculator
  • pymatgen.entries.entry_tools
  • pymatgen.entries.exp_entries
  • pymatgen.entries.mixing_scheme
  • @@ -11771,21 +11771,21 @@

    P

    pymatgen.ext.cod
  • pymatgen.ext.matproj
  • pymatgen.ext.optimade
  • @@ -11806,91 +11806,91 @@

    P

    pymatgen.io.abinit.abiobjects
  • pymatgen.io.abinit.abitimer
  • pymatgen.io.abinit.inputs
  • pymatgen.io.abinit.netcdf
  • pymatgen.io.abinit.pseudos
  • pymatgen.io.abinit.variable
  • pymatgen.io.adf
  • pymatgen.io.ase
  • pymatgen.io.atat
  • pymatgen.io.babel
  • pymatgen.io.cif
  • pymatgen.io.common
  • pymatgen.io.core
  • @@ -11904,35 +11904,35 @@

    P

    pymatgen.io.cp2k.inputs
  • pymatgen.io.cp2k.outputs
  • pymatgen.io.cp2k.sets
  • pymatgen.io.cp2k.utils
  • pymatgen.io.cssr
  • @@ -11946,7 +11946,7 @@

    P

    pymatgen.io.exciting.inputs
  • @@ -11960,42 +11960,42 @@

    P

    pymatgen.io.feff.inputs
  • pymatgen.io.feff.outputs
  • pymatgen.io.feff.sets
  • pymatgen.io.fiesta
  • pymatgen.io.gaussian
  • pymatgen.io.jarvis
  • @@ -12009,49 +12009,49 @@

    P

    pymatgen.io.lammps.data
  • pymatgen.io.lammps.generators
  • pymatgen.io.lammps.inputs
  • pymatgen.io.lammps.outputs
  • pymatgen.io.lammps.sets
  • pymatgen.io.lammps.utils
  • pymatgen.io.lmto
  • @@ -12065,56 +12065,56 @@

    P

    pymatgen.io.lobster.inputs
  • pymatgen.io.lobster.lobsterenv
  • pymatgen.io.lobster.outputs
  • pymatgen.io.nwchem
  • pymatgen.io.packmol
  • pymatgen.io.phonopy
  • pymatgen.io.prismatic
  • pymatgen.io.pwscf
  • @@ -12128,49 +12128,49 @@

    P

    pymatgen.io.qchem.inputs
  • pymatgen.io.qchem.outputs
  • pymatgen.io.qchem.sets
  • pymatgen.io.qchem.utils
  • pymatgen.io.res
  • pymatgen.io.shengbte
  • pymatgen.io.template
  • @@ -12184,56 +12184,56 @@

    P

    pymatgen.io.vasp.help
  • pymatgen.io.vasp.inputs
  • pymatgen.io.vasp.optics
  • pymatgen.io.vasp.outputs
  • pymatgen.io.vasp.sets
  • pymatgen.io.wannier90
  • pymatgen.io.xcrysden
  • pymatgen.io.xr
  • @@ -12247,28 +12247,28 @@

    P

    pymatgen.io.xtb.inputs
  • pymatgen.io.xtb.outputs
  • pymatgen.io.xyz
  • pymatgen.io.zeopp
  • @@ -12282,21 +12282,21 @@

    P

    pymatgen.optimization.linear_assignment
  • pymatgen.optimization.linear_assignment_numpy
  • pymatgen.optimization.neighbors
  • @@ -12310,42 +12310,42 @@

    P

    pymatgen.phonon.bandstructure
  • pymatgen.phonon.dos
  • pymatgen.phonon.gruneisen
  • pymatgen.phonon.ir_spectra
  • pymatgen.phonon.plotter
  • pymatgen.phonon.thermal_displacements
  • @@ -12359,56 +12359,56 @@

    P

    pymatgen.symmetry.analyzer
  • pymatgen.symmetry.bandstructure
  • pymatgen.symmetry.groups
  • pymatgen.symmetry.kpath
  • pymatgen.symmetry.maggroups
  • pymatgen.symmetry.settings
  • pymatgen.symmetry.site_symmetries
  • pymatgen.symmetry.structure
  • @@ -12422,28 +12422,28 @@

    P

    pymatgen.transformations.advanced_transformations
  • pymatgen.transformations.site_transformations
  • pymatgen.transformations.standard_transformations
  • pymatgen.transformations.transformation_abc
  • @@ -12457,91 +12457,91 @@

    P

    pymatgen.util.convergence
  • pymatgen.util.coord
  • pymatgen.util.coord_cython
  • pymatgen.util.due
  • pymatgen.util.graph_hashing
  • pymatgen.util.io_utils
  • pymatgen.util.num
  • pymatgen.util.numba
  • pymatgen.util.plotting
  • pymatgen.util.provenance
  • pymatgen.util.string
  • pymatgen.util.testing
  • pymatgen.util.typing
  • @@ -12555,28 +12555,28 @@

    P

    pymatgen.vis.plotters
  • pymatgen.vis.structure_chemview
  • pymatgen.vis.structure_vtk
  • -
  • pymatgen_mol (BabelMolAdaptor property) +
  • pymatgen_mol (BabelMolAdaptor property)
  • -
  • PymatgenTest (class in pymatgen.util.testing) +
  • PymatgenTest (class in pymatgen.util.testing)
  • -
  • pz (Orbital attribute) +
  • pz (Orbital attribute)
  • @@ -12584,27 +12584,27 @@

    P

    Q

    @@ -12612,469 +12612,469 @@

    Q

    R

    @@ -13082,1075 +13082,1075 @@

    R

    S

    @@ -14158,411 +14158,411 @@

    S

    T

    @@ -14570,171 +14570,171 @@

    T

    U

    @@ -14742,225 +14742,225 @@

    U

    V

    @@ -14968,273 +14968,273 @@

    V

    W

    @@ -15242,77 +15242,77 @@

    W

    X

    @@ -15320,40 +15320,40 @@

    X

    Y

    @@ -15362,73 +15362,73 @@

    Y

    Z

    diff --git a/docs/installation.html b/docs/installation.html index 77ecbb731ac..95b13ce42a2 100644 --- a/docs/installation.html +++ b/docs/installation.html @@ -159,8 +159,8 @@

    Optional non-Python programshttp://www.ffmpeg.org.

  • enum: For the use of -pymatgen.transformations.advanced_transformations.EnumerateStructureTransformation -and pymatgen.command_line.enumlib_caller module. This library by Gus +pymatgen.transformations.advanced_transformations.EnumerateStructureTransformation +and pymatgen.command_line.enumlib_caller module. This library by Gus Hart provides a robust way to enumerate derivative structures. It can be used to completely enumerate all symmetrically distinct ordered structures of disordered structures via EnumerateStructureTransformation. Many other @@ -168,11 +168,11 @@

    Optional non-Python programshttp://github.com/msg-byu/enumlib and follow the instructions to compile enum.x and makestr.x.

  • -
  • bader: For use with pymatgen.command_line.bader_caller.BaderAnalysis. +

  • bader: For use with pymatgen.command_line.bader_caller.BaderAnalysis. This library by Henkelmann et al. provides a robust way to calculate the Bader analysis from a CHGCAR. The bader executable must be in the path. Get it at http://theory.cm.utexas.edu/bader.

  • -
  • gulp: For use with pymatgen.command_line.gulp_caller, +

  • gulp: For use with pymatgen.command_line.gulp_caller, which is in turn used extensively by pymatgen.analysis.defects to compute empirical defect energies.

  • aconvasp: For use with the pymatgen.command_line.aconvasp_caller.

  • @@ -182,7 +182,7 @@

    Optional non-Python programshttps://github.com/aoterodelaroza/critic2): For topological analysis of critical points from electronic charge density. Provides more detailed information compared to bader. For use with -pymatgen.command_line.critic2_caller.Critic2Caller.

    +pymatgen.command_line.critic2_caller.Critic2Caller.

  • graphviz (http://graphviz.org): For visualization of graphs generated using critic2.

  • diff --git a/docs/modules.html b/docs/modules.html index 8aea3a3206f..d16b6b1a903 100644 --- a/docs/modules.html +++ b/docs/modules.html @@ -98,90 +98,88 @@

    pymatgenSubpackages -
  • Submodules