tardis.io.model.arepo.readers module

tardis.io.model.arepo.readers.read_arepo_snapshot(filename: str | Path, species: list[str], speciesfile: str | Path, alpha: float = 0.0, beta: float = 0.0, gamma: float = 0.0) ArepoData[source]

Read an Arepo snapshot file and return ArepoData.

Loads relevant data from an Arepo snapshot for conversion to TARDIS model. Requires arepo-snap-util to be installed. The snapshot is rotated according to the provided Euler angles.

Parameters:
filenamestr or pathlib.Path

Path to the Arepo snapshot file.

specieslist of str

Names of the species to be exported. Must match the species-file of the Arepo simulation.

speciesfilestr or pathlib.Path

File specifying the species used in the Arepo simulation.

alphafloat, optional

Euler angle alpha (yaw) for rotation of the desired line-of-sight to the x-axis. Default: 0.0

betafloat, optional

Euler angle beta (pitch) for rotation of the desired line-of-sight to the x-axis. Default: 0.0

gammafloat, optional

Euler angle gamma (roll) for rotation of the desired line-of-sight to the x-axis. Default: 0.0

Returns:
ArepoData

Data structure containing the Arepo snapshot data.

Raises:
ImportError

If arepo-snap-util is not installed.