emmet.core.types.enums

Define enums with custom de-/serialization behavior.

Note that only the base classes for enums and enums that are used widely across the code base should be put here.

For example, ValueEnum is defined here, with custom pydantic serialization features.

Similarly, TaskState is used across many sub-modules in emmet-core and therefore is defined here.

Enums which only have one purpose / exist only within one module, can and should remain in that module.

Classes

BatteryType

Enum for battery type

DeprecationMessage

DocEnum

Enum with docstrings support from: https://stackoverflow.com/a/50473952

IgnoreCaseEnum

Enum that permits case-insensitve lookup.

StoreTrajectoryOption

TYPE_CHECKING

bool(x) -> bool

TaskState

VASP Calculation State

ThermoType

Thermodynamic hull types used in the database.

ValueEnum

Enum that serializes to string as the value.

VaspObject

Types of VASP data objects.

XasEdge

The interaction edge for XAS There are 2n-1 sub-components to each edge where K: n=1 L: n=2 M: n=3 N: n=4

XasType

The type of XAS Spectrum XANES - Just the near-edge region EXAFS - Just the extended region XAFS - Fully stitched XANES + EXAFS