tardis.io.atom_data.atomic_data_summary module
Create publication-ready summaries of TARDIS atomic data.
- tardis.io.atom_data.atomic_data_summary.build_atom_data_summary(levels: DataFrame, lines: DataFrame, elements: Iterable[str] | None = None) DataFrame[source]
Summarize usable atomic levels and lines by element.
- Parameters:
- levelspandas.DataFrame
TARDIS atomic level data containing atomic and ion numbers.
- linespandas.DataFrame
TARDIS atomic line data containing atomic and ion numbers.
- elementscollections.abc.Iterable[str], optional
Element symbols to include. All available elements are included by default.
- Returns:
- pandas.DataFrame
Element, ion-stage, level-count, and line-count columns, followed by a total row. Only ions having more than one level and at least one line are included.
- tardis.io.atom_data.atomic_data_summary.export_atom_data_summary(atom_data: AtomData | str | Path, output_path: str | Path, journal: str | Path = 'aas', elements: Iterable[str] | None = None) DataFrame[source]
Export a publication-ready atomic-data summary table.
- Parameters:
- atom_datatardis.io.atom_data.AtomData or str or pathlib.Path
Loaded TARDIS atomic data or a Carsus/TARDIS atomic HDF file.
- output_pathstr or pathlib.Path
Output basename or
.texpath. Matching.texand.txtfiles are written.- journal{“aa”, “aas”, “mnras”, “nature”} or pathlib.Path, optional
Built-in journal style or path to a custom JSON configuration.
- elementscollections.abc.Iterable[str], optional
Element symbols to include. All available elements are included by default.
- Returns:
- pandas.DataFrame
The summary written to disk.