r"""|Cosmology| <-> html I/O, using |Cosmology.read| and |Cosmology.write|. We assume the following setup: >>> from pathlib import Path >>> from tempfile import TemporaryDirectory >>> temp_dir = TemporaryDirectory() Writing a cosmology to a html file will produce a table with the cosmology's type, name, and parameters as columns. >>> from astropy.cosmology import Planck18 >>> file = Path(temp_dir.name) / "file.html" >>> Planck18.write(file) >>> with open(file) as f: print(f.read())

cosmology	name	H0	Om0	Tcmb0	Neff	m_nu			Ob0
FlatLambdaCDM	Planck18	67.66	0.30966	2.7255	3.046	0.0	0.0	0.06	0.04897

The cosmology's metadata is not included in the file. To save the cosmology in an existing file, use ``overwrite=True``; otherwise, an error will be raised. >>> Planck18.write(file, overwrite=True) To use a different table class as the underlying writer, use the ``cls`` kwarg. For more information on the available table classes, see the documentation on Astropy's table classes and on ``Cosmology.to_format("astropy.table")``. By default the parameter names are not converted to LaTeX / MathJax format. To enable this, set ``latex_names=True``. >>> file = Path(temp_dir.name) / "file2.html" >>> Planck18.write(file, latex_names=True) >>> with open(file) as f: print(f.read()) ... cosmology name $$H_{0}$$ $$\Omega_{m,0}$$ $$T_{0}$$ $$N_{eff}$$ $$m_{nu}$$ $$\Omega_{b,0}$$ ... .. note:: A HTML file containing a Cosmology HTML table should have scripts enabling MathJax. .. code-block:: html .. testcleanup:: >>> temp_dir.cleanup() """ from __future__ import annotations from typing import TYPE_CHECKING, Any, TypeVar import astropy.cosmology.units as cu import astropy.units as u from astropy.cosmology.connect import readwrite_registry from astropy.cosmology.core import Cosmology from astropy.cosmology.parameter import Parameter from astropy.table import QTable from .table import from_table, to_table if TYPE_CHECKING: from astropy.cosmology._typing import _CosmoT from astropy.io.typing import PathLike, ReadableFileLike, WriteableFileLike from astropy.table import Table _TableT = TypeVar("_TableT", "Table") # Format look-up for conversion, {original_name: new_name} # TODO! move this information into the Parameters themselves _FORMAT_TABLE = { "H0": "$$H_{0}$$", "Om0": "$$\\Omega_{m,0}$$", "Ode0": "$$\\Omega_{\\Lambda,0}$$", "Tcmb0": "$$T_{0}$$", "Neff": "$$N_{eff}$$", "m_nu": "$$m_{nu}$$", "Ob0": "$$\\Omega_{b,0}$$", "w0": "$$w_{0}$$", "wa": "$$w_{a}$$", "wz": "$$w_{z}$$", "wp": "$$w_{p}$$", "zp": "$$z_{p}$$", } def read_html_table( filename: PathLike | ReadableFileLike[Table], index: int | str | None = None, *, move_to_meta: bool = False, cosmology: str | type[_CosmoT] | None = None, latex_names: bool = True, **kwargs: Any, ) -> _CosmoT: r"""Read a |Cosmology| from an HTML file. Parameters ---------- filename : path-like or file-like From where to read the Cosmology. index : int or str or None, optional Needed to select the row in tables with multiple rows. ``index`` can be an integer for the row number or, if the table is indexed by a column, the value of that column. If the table is not indexed and ``index`` is a string, the "name" column is used as the indexing column. move_to_meta : bool, optional keyword-only Whether to move keyword arguments that are not in the Cosmology class' signature to the Cosmology's metadata. This will only be applied if the Cosmology does NOT have a keyword-only argument (e.g. ``**kwargs``). Arguments moved to the metadata will be merged with existing metadata, preferring specified metadata in the case of a merge conflict (e.g. for ``Cosmology(meta={'key':10}, key=42)``, the ``Cosmology.meta`` will be ``{'key': 10}``). cosmology : str or |Cosmology| class or None, optional keyword-only The cosmology class (or string name thereof) to use when constructing the cosmology instance. The class also provides default parameter values, filling in any non-mandatory arguments missing in 'table'. latex_names : bool, optional keyword-only Whether the |Table| (might) have latex column names for the parameters that need to be mapped to the correct parameter name -- e.g. $$H_{0}$$ to 'H0'. This is `True` by default, but can be turned off (set to `False`) if there is a known name conflict (e.g. both an 'H0' and '$$H_{0}$$' column) as this will raise an error. In this case, the correct name ('H0') is preferred. **kwargs : Any Passed to ``QTable.read``. ``format`` is set to 'ascii.html', regardless of input. Returns ------- |Cosmology| subclass instance Raises ------ ValueError If the keyword argument 'format' is given and is not "ascii.html". """ # Check that the format is 'ascii.html' (or not specified) format = kwargs.pop("format", "ascii.html") if format != "ascii.html": raise ValueError(f"format must be 'ascii.html', not {format}") # Reading is handled by `QTable`. with u.add_enabled_units(cu): # (cosmology units not turned on by default) table = QTable.read(filename, format="ascii.html", **kwargs) # Need to map the table's column names to Cosmology inputs (parameter # names). # TODO! move the `latex_names` into `from_table` if latex_names: table_columns = set(table.colnames) for name, latex in _FORMAT_TABLE.items(): if latex in table_columns: table.rename_column(latex, name) # Build the cosmology from table, using the private backend. return from_table( table, index=index, move_to_meta=move_to_meta, cosmology=cosmology, rename=None ) def write_html_table( cosmology: Cosmology, file: PathLike | WriteableFileLike[_TableT], *, overwrite: bool = False, cls: type[_TableT] = QTable, latex_names: bool = False, **kwargs: Any, ) -> None: r"""Serialize the |Cosmology| into a HTML table. Parameters ---------- cosmology : |Cosmology| subclass instance The cosmology to serialize. file : path-like or file-like Where to write the html table. overwrite : bool, optional keyword-only Whether to overwrite the file, if it exists. cls : |Table| class, optional keyword-only Astropy |Table| (sub)class to use when writing. Default is |QTable| class. latex_names : bool, optional keyword-only Whether to format the parameters (column) names to latex -- e.g. 'H0' to $$H_{0}$$. **kwargs : Any Passed to ``cls.write``. Raises ------ TypeError If the optional keyword-argument 'cls' is not a subclass of |Table|. ValueError If the keyword argument 'format' is given and is not "ascii.html". Examples -------- We assume the following setup: >>> from pathlib import Path >>> from tempfile import TemporaryDirectory >>> temp_dir = TemporaryDirectory() Writing a cosmology to a html file will produce a table with the cosmology's type, name, and parameters as columns. >>> from astropy.cosmology import Planck18 >>> file = Path(temp_dir.name) / "file.html" >>> Planck18.write(file, overwrite=True) >>> with open(file) as f: print(f.read())

cosmology	name	H0	Om0	Tcmb0	Neff	m_nu			Ob0
FlatLambdaCDM	Planck18	67.66	0.30966	2.7255	3.046	0.0	0.0	0.06	0.04897