ProjectedBS

class emmet.core.band_theory.ProjectedBS(**data)

Bases: BaseModel

Light memory model for projected band structure data.

Only C order is used.

When the data is unraveled by numpy, you should get a 4-index tensor where:

  • Index 1: band index

  • Index 2: k-point index

  • Index 3: site index

  • Index 4: index for the orbital character, ordered as

    s, py, pz, px, dxy, dyz, dz2, dxz, dx2-y2,…

Parameters:
  • spin_up (list[float] | None)

  • spin_down (list[float] | None)

  • rank (tuple[int, int, int, int])

model_config: ClassVar[ConfigDict] = {}

Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].