nomogram 0.3.0__tar.gz → 0.5.0__tar.gz

nomogram-0.5.0/PKG-INFO

@@ -0,0 +1,199 @@
+Metadata-Version: 2.4
+Name: nomogram
+Version: 0.5.0
+Summary: Repository of scientific formulas: notations, units, validity domains
+Keywords: scientific computing,formulas,units,dimensional analysis,physics,thermodynamics,geoscience,atmospheric science,meteorology,hydrology,psychrometrics
+Author: miki4ia
+Author-email: miki4ia <miki4ia@gmail.com>
+License-Expression: BSD-3-Clause AND CC-BY-4.0 AND CC0-1.0
+License-File: LICENSE
+License-File: src/nomogram/data/NOTICE.md
+Classifier: Development Status :: 3 - Alpha
+Classifier: Intended Audience :: Science/Research
+Classifier: Operating System :: OS Independent
+Classifier: Programming Language :: Python :: 3
+Classifier: Programming Language :: Python :: 3 :: Only
+Classifier: Programming Language :: Python :: 3.12
+Classifier: Programming Language :: Python :: 3.13
+Classifier: Topic :: Scientific/Engineering
+Classifier: Topic :: Scientific/Engineering :: Atmospheric Science
+Classifier: Topic :: Scientific/Engineering :: Hydrology
+Classifier: Topic :: Scientific/Engineering :: Physics
+Classifier: Typing :: Typed
+Requires-Dist: numpy>=2.0
+Requires-Dist: pint>=0.24.4
+Requires-Dist: sympy>=1.13
+Requires-Dist: matplotlib>=3.10.7 ; extra == 'viz'
+Requires-Python: >=3.12
+Project-URL: Homepage, https://github.com/miki4iaml/nomogram
+Project-URL: Repository, https://github.com/miki4iaml/nomogram
+Project-URL: Issues, https://github.com/miki4iaml/nomogram/issues
+Project-URL: Changelog, https://github.com/miki4iaml/nomogram/blob/main/CHANGELOG.md
+Provides-Extra: viz
+Description-Content-Type: text/markdown
+
+<p align="center">
+  <picture>
+    <source media="(prefers-color-scheme: dark)" srcset="https://raw.githubusercontent.com/miki4iaml/nomogram/v0.5.0/docs/images/banner-dark.svg">
+    <img alt="nomogram" src="https://raw.githubusercontent.com/miki4iaml/nomogram/v0.5.0/docs/images/banner-light.svg" width="480">
+  </picture>
+</p>
+
+**English** | [Français](https://github.com/miki4iaml/nomogram/blob/v0.5.0/README.fr.md)
+
+[![CI](https://github.com/miki4iaml/nomogram/actions/workflows/ci.yml/badge.svg?branch=develop)](https://github.com/miki4iaml/nomogram/actions/workflows/ci.yml)
+[![CodeQL](https://github.com/miki4iaml/nomogram/actions/workflows/github-code-scanning/codeql/badge.svg)](https://github.com/miki4iaml/nomogram/actions/workflows/github-code-scanning/codeql)
+[![codecov](https://codecov.io/gh/miki4iaml/nomogram/graph/badge.svg?branch=develop)](https://codecov.io/gh/miki4iaml/nomogram)
+[![Python](https://img.shields.io/python/required-version-toml?tomlFilePath=https%3A%2F%2Fraw.githubusercontent.com%2Fmiki4iaml%2Fnomogram%2Fdevelop%2Fpyproject.toml)](https://github.com/miki4iaml/nomogram/blob/v0.5.0/pyproject.toml)
+[![License](https://img.shields.io/github/license/miki4iaml/nomogram)](https://github.com/miki4iaml/nomogram/blob/v0.5.0/LICENSE)
+[![DOI](https://zenodo.org/badge/DOI/10.5281/zenodo.23373134.svg)](https://doi.org/10.5281/zenodo.23373134)
+[![uv](https://img.shields.io/endpoint?url=https://raw.githubusercontent.com/astral-sh/uv/main/assets/badge/v0.json)](https://github.com/astral-sh/uv)
+[![Ruff](https://img.shields.io/endpoint?url=https://raw.githubusercontent.com/astral-sh/ruff/main/assets/badge/v2.json)](https://github.com/astral-sh/ruff)
+[![Checked with mypy](https://www.mypy-lang.org/static/mypy_badge.svg)](https://mypy-lang.org/)
+[![Conventional Commits](https://img.shields.io/badge/Conventional%20Commits-1.0.0-fe5196)](https://www.conventionalcommits.org/en/v1.0.0/)
+
+**Formulas as data, not as code.**
+
+nomogram does not hard-code functions: it catalogs formulas, each one
+
+- **meaningful**: QUDT quantity kinds and units, links to CF and
+  Wikidata, its source, its validity domain when stated;
+- **checked**: dimensions and units on loading, equivalences proved
+  symbolically, values cross-checked against references;
+- **ready to use**: compute, compose, invert, plot, and compare with its
+  alternatives.
+
+Built for trust, not for speed: to show that a calculation is right, and
+where it comes from.
+
+Pure Python, built on SymPy, numpy and pint; it works on an offline
+workstation (no online engine).
+
+> Early stage project (alpha).
+
+## Installation
+
+```
+pip install nomogram          # core
+pip install "nomogram[viz]"   # with plots (matplotlib)
+```
+
+## Installation from source
+
+```
+git clone https://github.com/miki4iaml/nomogram.git
+cd nomogram
+uv sync
+```
+
+Python 3.12 or later. Plots need the `viz` extra (matplotlib):
+`uv sync --extra viz`.
+
+## Example
+
+Every saturation vapour pressure formulation of the catalog against the
+IAPWS reference, from 0 to 60 °C and within 1 %; curves stop where a formulation leaves its
+stated validity domain, and the figure takes the option set of nomogram's
+documentation ([script](https://github.com/miki4iaml/nomogram/blob/v0.5.0/docs/examples/saturation_vapour_pressure.py)):
+
+```python
+import numpy as np
+import nomogram as nomo
+from nomogram.units import Q_
+
+catalog = nomo.catalog.catalog()
+formulations = catalog.formulations_of("SaturationVapourPressureOverWater")
+reference = catalog.formulations["iapws_sr1_86"]
+temperatures = Q_(np.linspace(-60, 110, 341), "degC")
+
+table = nomo.comparison.compare(
+    formulations, reference, {"ThermodynamicTemperature": temperatures}
+)
+with nomo.display.display_options(nomo.display.DisplayOptions.DOCUMENTATION):
+    nomo.plot.plot_deviations(table, xlim=(0, 60), ylim=(-1.0, 1.0))  # extra viz
+```
+
+![Deviation of saturation vapour pressure formulations from IAPWS](https://raw.githubusercontent.com/miki4iaml/nomogram/v0.5.0/docs/images/saturation-vapour-pressure.png)
+
+## Usage
+
+The table holds the values and the relative deviations, by formulation;
+values outside a formulation's validity domain are NaN unless asked
+otherwise (`outside="ignore"`). Formulations also chain, for instance
+the absolute humidity from any saturation vapour pressure formulation:
+
+```python
+ha = nomo.comparison.compose(
+    catalog.formulations["mass_concentration_ideal_gas"], {"e_s": reference}
+)
+ha.evaluate(RH=Q_(100, "percent"), T=Q_(20, "degC")).to("g/m^3")  # 17.29
+```
+
+`compare` gives each value to the input of its quantity kind. A
+formulation with several inputs of one kind, such as a scheme
+interpolating between two levels (the target pressure p and the
+pressures p_1 and p_2 of the levels), compares once all but one of them
+are fixed, which `compare` asks for: `partial` fixes inputs as `functools.partial` fixes arguments,
+here the two levels, and leaves a function of p alone, evaluated,
+compared and plotted like any formulation
+([Humidity between two levels](https://github.com/miki4iaml/nomogram/blob/v0.5.0/docs/vertical.md#humidity-between-two-levels)).
+It also fixes what is known in advance, such as the levels of a sounding,
+and names the curve in legends:
+
+```python
+levels = {"p_1": Q_(850, "hPa"), "p_2": Q_(500, "hPa"),
+          "T_1": Q_(278, "K"), "T_2": Q_(252, "K")}
+in_ln_p = nomo.comparison.partial(
+    catalog.formulations["log_pressure_interpolation_temperature"],
+    label="T linear in ln p", **levels,
+)
+in_ln_p.evaluate(p=Q_(700, "hPa")).to("K")  # 268.49
+```
+
+Formulations are found by words, wildcards and fields, whatever their
+notation ([Finding formulations](https://github.com/miki4iaml/nomogram/blob/v0.5.0/docs/search.md)):
+
+```python
+catalog.search(variable="rho*")                    # ρ in every notation
+catalog.search(kind="VapourPressure", source="buck*")
+```
+
+Each formulation keeps its units, validity domain, temperature scale and
+references. The vocabulary is mapped in [docs/rosetta.md](https://github.com/miki4iaml/nomogram/blob/v0.5.0/docs/rosetta.md);
+[How nomogram earns trust](https://github.com/miki4iaml/nomogram/blob/v0.5.0/docs/approach.md) explains what is checked and
+how, and [Displaying formulas](https://github.com/miki4iaml/nomogram/blob/v0.5.0/docs/display.md) shows formulas in notebooks,
+Markdown and plots. [Sea water](https://github.com/miki4iaml/nomogram/blob/v0.5.0/docs/sea-water.md) shows the salinity
+scales and the vapour pressure of sea water, and what its 2 % lowering
+changes at the sea surface. [The logo](https://github.com/miki4iaml/nomogram/blob/v0.5.0/docs/logo.md) is a working
+nomogram.
+
+## Contributing
+
+References to integrate, information or corrections about catalog
+entries, new formulas and code are all welcome: see the
+[ways to contribute](https://github.com/miki4iaml/nomogram/blob/v0.5.0/.github/CONTRIBUTING.md#ways-to-contribute) and
+the [catalog guide](https://github.com/miki4iaml/nomogram/blob/v0.5.0/docs/catalog.md).
+
+## Data sources
+
+nomogram's units come from QUDT, and so do its quantity kinds, except
+those QUDT lacks, which nomogram defines as specializations of QUDT
+kinds. nomogram links some kinds to CF standard names, which come, with
+their canonical units, from the CF standard name table. The package
+bundles a subset of each source:
+
+- QUDT — Quantities, Units, Dimensions and Types, by QUDT.org
+  (<https://qudt.org>), release 3.5.2, licensed under
+  [CC BY 4.0](https://creativecommons.org/licenses/by/4.0/);
+- the [CF standard name table](https://cfconventions.org/Data/cf-standard-names/95/build/cf-standard-name-table.html),
+  version 95, [CC0 1.0](https://creativecommons.org/publicdomain/zero/1.0/);
+- the UCUM codes of the units, as QUDT gives them: © Regenstrief
+  Institute, Inc., [UCUM License](https://ucum.org/license).
+
+What nomogram selects, changes and adds is listed in
+[NOTICE.md](https://github.com/miki4iaml/nomogram/blob/v0.5.0/src/nomogram/data/NOTICE.md).
+
+## License
+
+Code: [BSD-3-Clause](https://github.com/miki4iaml/nomogram/blob/v0.5.0/LICENSE). Bundled data: see
+[Data sources](#data-sources).

nomogram-0.5.0/README.md

@@ -0,0 +1,165 @@
+<p align="center">
+  <picture>
+    <source media="(prefers-color-scheme: dark)" srcset="https://raw.githubusercontent.com/miki4iaml/nomogram/v0.5.0/docs/images/banner-dark.svg">
+    <img alt="nomogram" src="https://raw.githubusercontent.com/miki4iaml/nomogram/v0.5.0/docs/images/banner-light.svg" width="480">
+  </picture>
+</p>
+
+**English** | [Français](https://github.com/miki4iaml/nomogram/blob/v0.5.0/README.fr.md)
+
+[![CI](https://github.com/miki4iaml/nomogram/actions/workflows/ci.yml/badge.svg?branch=develop)](https://github.com/miki4iaml/nomogram/actions/workflows/ci.yml)
+[![CodeQL](https://github.com/miki4iaml/nomogram/actions/workflows/github-code-scanning/codeql/badge.svg)](https://github.com/miki4iaml/nomogram/actions/workflows/github-code-scanning/codeql)
+[![codecov](https://codecov.io/gh/miki4iaml/nomogram/graph/badge.svg?branch=develop)](https://codecov.io/gh/miki4iaml/nomogram)
+[![Python](https://img.shields.io/python/required-version-toml?tomlFilePath=https%3A%2F%2Fraw.githubusercontent.com%2Fmiki4iaml%2Fnomogram%2Fdevelop%2Fpyproject.toml)](https://github.com/miki4iaml/nomogram/blob/v0.5.0/pyproject.toml)
+[![License](https://img.shields.io/github/license/miki4iaml/nomogram)](https://github.com/miki4iaml/nomogram/blob/v0.5.0/LICENSE)
+[![DOI](https://zenodo.org/badge/DOI/10.5281/zenodo.23373134.svg)](https://doi.org/10.5281/zenodo.23373134)
+[![uv](https://img.shields.io/endpoint?url=https://raw.githubusercontent.com/astral-sh/uv/main/assets/badge/v0.json)](https://github.com/astral-sh/uv)
+[![Ruff](https://img.shields.io/endpoint?url=https://raw.githubusercontent.com/astral-sh/ruff/main/assets/badge/v2.json)](https://github.com/astral-sh/ruff)
+[![Checked with mypy](https://www.mypy-lang.org/static/mypy_badge.svg)](https://mypy-lang.org/)
+[![Conventional Commits](https://img.shields.io/badge/Conventional%20Commits-1.0.0-fe5196)](https://www.conventionalcommits.org/en/v1.0.0/)
+
+**Formulas as data, not as code.**
+
+nomogram does not hard-code functions: it catalogs formulas, each one
+
+- **meaningful**: QUDT quantity kinds and units, links to CF and
+  Wikidata, its source, its validity domain when stated;
+- **checked**: dimensions and units on loading, equivalences proved
+  symbolically, values cross-checked against references;
+- **ready to use**: compute, compose, invert, plot, and compare with its
+  alternatives.
+
+Built for trust, not for speed: to show that a calculation is right, and
+where it comes from.
+
+Pure Python, built on SymPy, numpy and pint; it works on an offline
+workstation (no online engine).
+
+> Early stage project (alpha).
+
+## Installation
+
+```
+pip install nomogram          # core
+pip install "nomogram[viz]"   # with plots (matplotlib)
+```
+
+## Installation from source
+
+```
+git clone https://github.com/miki4iaml/nomogram.git
+cd nomogram
+uv sync
+```
+
+Python 3.12 or later. Plots need the `viz` extra (matplotlib):
+`uv sync --extra viz`.
+
+## Example
+
+Every saturation vapour pressure formulation of the catalog against the
+IAPWS reference, from 0 to 60 °C and within 1 %; curves stop where a formulation leaves its
+stated validity domain, and the figure takes the option set of nomogram's
+documentation ([script](https://github.com/miki4iaml/nomogram/blob/v0.5.0/docs/examples/saturation_vapour_pressure.py)):
+
+```python
+import numpy as np
+import nomogram as nomo
+from nomogram.units import Q_
+
+catalog = nomo.catalog.catalog()
+formulations = catalog.formulations_of("SaturationVapourPressureOverWater")
+reference = catalog.formulations["iapws_sr1_86"]
+temperatures = Q_(np.linspace(-60, 110, 341), "degC")
+
+table = nomo.comparison.compare(
+    formulations, reference, {"ThermodynamicTemperature": temperatures}
+)
+with nomo.display.display_options(nomo.display.DisplayOptions.DOCUMENTATION):
+    nomo.plot.plot_deviations(table, xlim=(0, 60), ylim=(-1.0, 1.0))  # extra viz
+```
+
+![Deviation of saturation vapour pressure formulations from IAPWS](https://raw.githubusercontent.com/miki4iaml/nomogram/v0.5.0/docs/images/saturation-vapour-pressure.png)
+
+## Usage
+
+The table holds the values and the relative deviations, by formulation;
+values outside a formulation's validity domain are NaN unless asked
+otherwise (`outside="ignore"`). Formulations also chain, for instance
+the absolute humidity from any saturation vapour pressure formulation:
+
+```python
+ha = nomo.comparison.compose(
+    catalog.formulations["mass_concentration_ideal_gas"], {"e_s": reference}
+)
+ha.evaluate(RH=Q_(100, "percent"), T=Q_(20, "degC")).to("g/m^3")  # 17.29
+```
+
+`compare` gives each value to the input of its quantity kind. A
+formulation with several inputs of one kind, such as a scheme
+interpolating between two levels (the target pressure p and the
+pressures p_1 and p_2 of the levels), compares once all but one of them
+are fixed, which `compare` asks for: `partial` fixes inputs as `functools.partial` fixes arguments,
+here the two levels, and leaves a function of p alone, evaluated,
+compared and plotted like any formulation
+([Humidity between two levels](https://github.com/miki4iaml/nomogram/blob/v0.5.0/docs/vertical.md#humidity-between-two-levels)).
+It also fixes what is known in advance, such as the levels of a sounding,
+and names the curve in legends:
+
+```python
+levels = {"p_1": Q_(850, "hPa"), "p_2": Q_(500, "hPa"),
+          "T_1": Q_(278, "K"), "T_2": Q_(252, "K")}
+in_ln_p = nomo.comparison.partial(
+    catalog.formulations["log_pressure_interpolation_temperature"],
+    label="T linear in ln p", **levels,
+)
+in_ln_p.evaluate(p=Q_(700, "hPa")).to("K")  # 268.49
+```
+
+Formulations are found by words, wildcards and fields, whatever their
+notation ([Finding formulations](https://github.com/miki4iaml/nomogram/blob/v0.5.0/docs/search.md)):
+
+```python
+catalog.search(variable="rho*")                    # ρ in every notation
+catalog.search(kind="VapourPressure", source="buck*")
+```
+
+Each formulation keeps its units, validity domain, temperature scale and
+references. The vocabulary is mapped in [docs/rosetta.md](https://github.com/miki4iaml/nomogram/blob/v0.5.0/docs/rosetta.md);
+[How nomogram earns trust](https://github.com/miki4iaml/nomogram/blob/v0.5.0/docs/approach.md) explains what is checked and
+how, and [Displaying formulas](https://github.com/miki4iaml/nomogram/blob/v0.5.0/docs/display.md) shows formulas in notebooks,
+Markdown and plots. [Sea water](https://github.com/miki4iaml/nomogram/blob/v0.5.0/docs/sea-water.md) shows the salinity
+scales and the vapour pressure of sea water, and what its 2 % lowering
+changes at the sea surface. [The logo](https://github.com/miki4iaml/nomogram/blob/v0.5.0/docs/logo.md) is a working
+nomogram.
+
+## Contributing
+
+References to integrate, information or corrections about catalog
+entries, new formulas and code are all welcome: see the
+[ways to contribute](https://github.com/miki4iaml/nomogram/blob/v0.5.0/.github/CONTRIBUTING.md#ways-to-contribute) and
+the [catalog guide](https://github.com/miki4iaml/nomogram/blob/v0.5.0/docs/catalog.md).
+
+## Data sources
+
+nomogram's units come from QUDT, and so do its quantity kinds, except
+those QUDT lacks, which nomogram defines as specializations of QUDT
+kinds. nomogram links some kinds to CF standard names, which come, with
+their canonical units, from the CF standard name table. The package
+bundles a subset of each source:
+
+- QUDT — Quantities, Units, Dimensions and Types, by QUDT.org
+  (<https://qudt.org>), release 3.5.2, licensed under
+  [CC BY 4.0](https://creativecommons.org/licenses/by/4.0/);
+- the [CF standard name table](https://cfconventions.org/Data/cf-standard-names/95/build/cf-standard-name-table.html),
+  version 95, [CC0 1.0](https://creativecommons.org/publicdomain/zero/1.0/);
+- the UCUM codes of the units, as QUDT gives them: © Regenstrief
+  Institute, Inc., [UCUM License](https://ucum.org/license).
+
+What nomogram selects, changes and adds is listed in
+[NOTICE.md](https://github.com/miki4iaml/nomogram/blob/v0.5.0/src/nomogram/data/NOTICE.md).
+
+## License
+
+Code: [BSD-3-Clause](https://github.com/miki4iaml/nomogram/blob/v0.5.0/LICENSE). Bundled data: see
+[Data sources](#data-sources).

{nomogram-0.3.0 → nomogram-0.5.0}/pyproject.toml

@@ -1,6 +1,6 @@
 [project]
 name = "nomogram"
-version = "0.3.0"
+version = "0.5.0"
 description = "Repository of scientific formulas: notations, units, validity domains"
 readme = "README.md"
 requires-python = ">=3.12"
@@ -120,6 +120,9 @@ fail_under = 80
 show_missing = true
 exclude_also = ['if __name__ == "__main__":']
 
+[tool.ruff.format]
+exclude = ["*.md"]
+
 [tool.ruff.lint]
 extend-select = [
     "ARG",
@@ -138,6 +141,7 @@ extend-select = [
 
 [tool.codespell]
 skip = "*.fr.md,uv.lock"
+ignore-words-list = "flate,alph,mesures"
 
 [tool.repo-review.ignore]
 PC110 = "ruff format runs as a local hook through uv run --frozen (single version source: uv.lock)"

{nomogram-0.3.0 → nomogram-0.5.0}/pyproject.toml.orig

@@ -1,6 +1,6 @@
 [project]
 name = "nomogram"
-version = "0.3.0"
+version = "0.5.0"
 description = "Repository of scientific formulas: notations, units, validity domains"
 readme = "README.md"
 authors = [
@@ -102,6 +102,12 @@ fail_under = 80
 show_missing = true
 exclude_also = ['if __name__ == "__main__":']
 
+[tool.ruff.format]
+# ruff also formats the code blocks of Markdown files when run without
+# arguments; the documents keep their own layout (aligned comments), and
+# tests/test_examples.py reads the values their code comments state.
+exclude = ["*.md"]
+
 [tool.ruff.lint]
 # On top of ruff's default selection, which Dependabot bumps surface in CI.
 extend-select = ["ARG", "B", "C4", "PIE", "PT", "PTH", "RET", "T20"]
@@ -114,6 +120,9 @@ extend-select = ["ARG", "B", "C4", "PIE", "PT", "PTH", "RET", "T20"]
 
 [tool.codespell]
 skip = "*.fr.md,uv.lock"
+# Format terms: the Flate filter of PDF, the ALPH chunk of WebP; the
+# French name of the BIPM (Bureau International des Poids et Mesures).
+ignore-words-list = "flate,alph,mesures"
 
 [tool.repo-review.ignore]
 PC110 = "ruff format runs as a local hook through uv run --frozen (single version source: uv.lock)"

nomogram-0.5.0/src/nomogram/__init__.py

@@ -0,0 +1,72 @@
+# SPDX-FileCopyrightText: 2026 Miki
+# SPDX-License-Identifier: BSD-3-Clause
+
+"""nomogram: a repository of scientific formulas.
+
+Submodules are imported on demand, so that ``import nomogram`` stays
+light: :mod:`nomogram.units` (pint), :mod:`nomogram.expression`
+(SymPy), :mod:`nomogram.semantics` (bundled QUDT and CF subsets),
+:mod:`nomogram.model` and :mod:`nomogram.catalog` (formulations),
+:mod:`nomogram.dimensions`, :mod:`nomogram.comparison`,
+:mod:`nomogram.inversion`, :mod:`nomogram.relations`,
+:mod:`nomogram.search`, :mod:`nomogram.display` and :mod:`nomogram.plot`.
+
+Each is also an attribute of the package, imported the first time it is
+used (PEP 562)::
+
+    import nomogram as nomo
+
+    formulations = nomo.catalog.catalog().formulations_of("VapourPressure")
+"""
+
+from importlib import import_module
+from importlib.metadata import version
+from typing import TYPE_CHECKING
+
+if TYPE_CHECKING:
+    from nomogram import catalog as catalog
+    from nomogram import comparison as comparison
+    from nomogram import dimensions as dimensions
+    from nomogram import display as display
+    from nomogram import expression as expression
+    from nomogram import inversion as inversion
+    from nomogram import model as model
+    from nomogram import plot as plot
+    from nomogram import relations as relations
+    from nomogram import search as search
+    from nomogram import semantics as semantics
+    from nomogram import units as units
+
+__all__ = [
+    "__version__",
+    "catalog",
+    "comparison",
+    "dimensions",
+    "display",
+    "expression",
+    "inversion",
+    "model",
+    "plot",
+    "relations",
+    "search",
+    "semantics",
+    "units",
+]
+
+#: Submodules reachable as attributes of the package.
+_SUBMODULES = frozenset(__all__) - {"__version__"}
+
+__version__ = version("nomogram")
+
+
+def __getattr__(name: str) -> object:
+    """Import a submodule the first time it is used as an attribute."""
+    if name in _SUBMODULES:
+        return import_module(f"{__name__}.{name}")
+    msg = f"module {__name__!r} has no attribute {name!r}"
+    raise AttributeError(msg)
+
+
+def __dir__() -> list[str]:
+    """The names of the package, submodules included before their import."""
+    return sorted({*globals(), *_SUBMODULES})