pynumgeo 2026.2.0.dev2__tar.gz

pynumgeo-2026.2.0.dev2/.gitignore

@@ -0,0 +1,37 @@
+# =~~=~~=~~=~~=~~=~~=~~=~~=~~=~~=~~=~~=~~=~~=~~=~~=~~=~~=~~=~~=~~=~~=~~=~~=~~=~~=~~=~~=~~=~~=~~=~~=~~=~=~
+#                                                pynumgeo
+#                              Python API for the finite element code numgeo
+#                                     Copyright (C) 2026 Jan Machacek
+# =~~=~~=~~=~~=~~=~~=~~=~~=~~=~~=~~=~~=~~=~~=~~=~~=~~=~~=~~=~~=~~=~~=~~=~~=~~=~~=~~=~~=~~=~~=~~=~~=~~=~=~
+#
+# Author: Jan Machacek
+#
+# pynumgeo writes, checks and runs numgeo input files and reads numgeo results. It follows the
+# development of numgeo: new developments in the numgeo source code are taken over into the API, and a
+# CI pipeline tests every change.
+#
+# License: BSD-3-Clause, see LICENSE.
+# =~~=~~=~~=~~=~~=~~=~~=~~=~~=~~=~~=~~=~~=~~=~~=~~=~~=~~=~~=~~=~~=~~=~~=~~=~~=~~=~~=~~=~~=~~=~~=~~=~~=~=~
+# Only the package and its documentation belong to this repository: everything else is ignored.
+/*
+!/src/
+!/tests/
+!/docs/
+!/README.md
+!/LICENSE
+!/NOTICE
+!/pyproject.toml
+!/zensical.toml
+!/.gitignore
+!/.github/
+/docs/changelog.md
+/docs/compatibility.md
+/docs/maintenance.md
+
+# Python and tool caches
+__pycache__/
+*.py[cod]
+*.egg-info/
+.pytest_cache/
+.mypy_cache/
+.ruff_cache/

pynumgeo-2026.2.0.dev2/LICENSE

@@ -0,0 +1,28 @@
+BSD 3-Clause License
+
+Copyright (c) 2026, Jan Machacek
+
+Redistribution and use in source and binary forms, with or without
+modification, are permitted provided that the following conditions are met:
+
+1. Redistributions of source code must retain the above copyright notice, this
+   list of conditions and the following disclaimer.
+
+2. Redistributions in binary form must reproduce the above copyright notice,
+   this list of conditions and the following disclaimer in the documentation
+   and/or other materials provided with the distribution.
+
+3. Neither the name of the copyright holder nor the names of its
+   contributors may be used to endorse or promote products derived from
+   this software without specific prior written permission.
+
+THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
+AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
+IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
+DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE
+FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
+DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
+SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER
+CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
+OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
+OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.

pynumgeo-2026.2.0.dev2/NOTICE

@@ -0,0 +1,19 @@
+pynumgeo
+Copyright (c) 2026 Jan Machacek
+Licensed under the BSD 3-Clause License, see LICENSE.
+
+The pynumgeo source code is written by Jan Machacek. In addition, the package ships data taken from
+numgeo, in src/pynumgeo/catalogue/data/:
+
+  * docs/reference/  - the keyword reference pages of the numgeo documentation
+                       (numgeo documentation commit eceee974);
+  * catalogue.json,
+    messages.json    - keyword, option and message tables derived from the numgeo source code
+                       (numgeo source commit 834564ed).
+
+These numgeo texts are
+
+  Copyright (c) 2018-2026 Jan Machacek, Patrick Staubach (the copyright holders of numgeo)
+
+and are redistributed with pynumgeo with the permission of the copyright holders. numgeo itself is
+not part of pynumgeo; see https://www.numgeo.de.

pynumgeo-2026.2.0.dev2/PKG-INFO

@@ -0,0 +1,103 @@
+Metadata-Version: 2.5
+Name: pynumgeo
+Version: 2026.2.0.dev2
+Summary: Python API for the finite element code numgeo: input decks, validation, runs and results
+Project-URL: Homepage, https://github.com/j-machacek/pynumgeo
+Project-URL: Documentation, https://j-machacek.github.io/pynumgeo/
+Project-URL: Source, https://github.com/j-machacek/pynumgeo
+Project-URL: numgeo, https://www.numgeo.de
+Author: Jan Machacek
+License-Expression: BSD-3-Clause
+License-File: LICENSE
+License-File: NOTICE
+Classifier: Development Status :: 4 - Beta
+Classifier: Operating System :: Microsoft :: Windows
+Classifier: Operating System :: POSIX :: Linux
+Classifier: Programming Language :: Python :: 3
+Classifier: Programming Language :: Python :: 3.11
+Classifier: Programming Language :: Python :: 3.12
+Classifier: Programming Language :: Python :: 3.13
+Classifier: Topic :: Scientific/Engineering
+Classifier: Typing :: Typed
+Requires-Python: >=3.11
+Requires-Dist: numpy>=1.23
+Requires-Dist: pydantic<3,>=2.5
+Provides-Extra: dev
+Requires-Dist: meshio>=5; extra == 'dev'
+Requires-Dist: mypy>=1.8; extra == 'dev'
+Requires-Dist: pre-commit; extra == 'dev'
+Requires-Dist: pytest-cov; extra == 'dev'
+Requires-Dist: pytest>=7; extra == 'dev'
+Requires-Dist: ruff>=0.5; extra == 'dev'
+Provides-Extra: docs
+Requires-Dist: mkdocstrings-python>=2.0; extra == 'docs'
+Requires-Dist: zensical>=0.0.73; extra == 'docs'
+Provides-Extra: meshio
+Requires-Dist: meshio>=5; extra == 'meshio'
+Provides-Extra: pandas
+Requires-Dist: pandas>=1.5; extra == 'pandas'
+Description-Content-Type: text/markdown
+
+<!--
+=~~=~~=~~=~~=~~=~~=~~=~~=~~=~~=~~=~~=~~=~~=~~=~~=~~=~~=~~=~~=~~=~~=~~=~~=~~=~~=~~=~~=~~=~~=~~=~~=~~=~=~
+                                               pynumgeo
+                             Python API for the finite element code numgeo
+                                    Copyright (C) 2026 Jan Machacek
+=~~=~~=~~=~~=~~=~~=~~=~~=~~=~~=~~=~~=~~=~~=~~=~~=~~=~~=~~=~~=~~=~~=~~=~~=~~=~~=~~=~~=~~=~~=~~=~~=~~=~=~
+
+Author: Jan Machacek
+
+pynumgeo writes, checks and runs numgeo input files and reads numgeo results. It follows the
+development of numgeo: new developments in the numgeo source code are taken over into the API, and a
+CI pipeline tests every change.
+
+License: BSD-3-Clause, see LICENSE.
+=~~=~~=~~=~~=~~=~~=~~=~~=~~=~~=~~=~~=~~=~~=~~=~~=~~=~~=~~=~~=~~=~~=~~=~~=~~=~~=~~=~~=~~=~~=~~=~~=~~=~=~
+-->
+
+<p align="center">
+  <picture>
+    <source media="(prefers-color-scheme: dark)" srcset="https://raw.githubusercontent.com/j-machacek/pynumgeo/main/docs/assets/pynumgeo-logo-dark.png">
+    <img src="https://raw.githubusercontent.com/j-machacek/pynumgeo/main/docs/assets/pynumgeo-logo.png" alt="pynumgeo" height="80">
+  </picture>
+</p>
+
+# pynumgeo
+
+[PyPI](https://pypi.org/project/pynumgeo/) ·
+[Documentation](https://j-machacek.github.io/pynumgeo/) ·
+[numgeo](https://www.numgeo.de) ·
+[numgeo documentation](https://j-machacek.github.io/numgeo/)
+
+Python API for the finite element code [numgeo](https://www.numgeo.de): the object model of a numgeo
+input deck, reading and writing input files, validation against what the solver accepts, running the
+solver, and reading its results — headless, on Windows and Linux.
+
+```python
+import pynumgeo as ng
+
+deck = ng.read("model.inp")              # numgeo input -> Deck (mesh, materials, steps, ...)
+issues = ng.validate(deck)               # what numgeo would reject or read differently
+ng.write(deck, "job/model.inp")          # normal-case, deterministic numgeo input
+res = ng.run(deck, "job", job="model")   # run numgeo, judge the outcome from its report files
+frames = ng.open_results("job", "model").frames()
+```
+
+```console
+pip install --pre pynumgeo               # Python 3.11+; runtime dependencies: numpy, pydantic 2
+pynumgeo validate model.inp              # every command also has --json
+pynumgeo run model.inp --workdir runs/m1
+pynumgeo info "*Initial conditions"
+pynumgeo --version
+```
+
+The [documentation](https://j-machacek.github.io/pynumgeo/) is built with [Zensical](https://zensical.org)
+from `docs/` (`pip install -e ".[docs]"`, then `zensical serve`); `docs/llms.txt` is a one-page summary for
+agents.
+
+pynumgeo `2026.2.0.dev2` is a pre-release (hence `pip install --pre`) built against the numgeo developer
+source `834564ed` (`numgeo2026-v2`); `2026.2.0` will be released together with numgeo2026-v2. Every input file it writes starts with a header that names the
+pynumgeo version, its author and the numgeo build it was written for.
+
+Author: Jan Machacek. Licence: BSD-3-Clause (`LICENSE`). The numgeo reference texts bundled with the
+package are covered by the numgeo copyright notice in `NOTICE`.

pynumgeo-2026.2.0.dev2/README.md

@@ -0,0 +1,63 @@
+<!--
+=~~=~~=~~=~~=~~=~~=~~=~~=~~=~~=~~=~~=~~=~~=~~=~~=~~=~~=~~=~~=~~=~~=~~=~~=~~=~~=~~=~~=~~=~~=~~=~~=~~=~=~
+                                               pynumgeo
+                             Python API for the finite element code numgeo
+                                    Copyright (C) 2026 Jan Machacek
+=~~=~~=~~=~~=~~=~~=~~=~~=~~=~~=~~=~~=~~=~~=~~=~~=~~=~~=~~=~~=~~=~~=~~=~~=~~=~~=~~=~~=~~=~~=~~=~~=~~=~=~
+
+Author: Jan Machacek
+
+pynumgeo writes, checks and runs numgeo input files and reads numgeo results. It follows the
+development of numgeo: new developments in the numgeo source code are taken over into the API, and a
+CI pipeline tests every change.
+
+License: BSD-3-Clause, see LICENSE.
+=~~=~~=~~=~~=~~=~~=~~=~~=~~=~~=~~=~~=~~=~~=~~=~~=~~=~~=~~=~~=~~=~~=~~=~~=~~=~~=~~=~~=~~=~~=~~=~~=~~=~=~
+-->
+
+<p align="center">
+  <picture>
+    <source media="(prefers-color-scheme: dark)" srcset="docs/assets/pynumgeo-logo-dark.svg">
+    <img src="docs/assets/pynumgeo-logo.svg" alt="pynumgeo" height="80">
+  </picture>
+</p>
+
+# pynumgeo
+
+[PyPI](https://pypi.org/project/pynumgeo/) ·
+[Documentation](https://j-machacek.github.io/pynumgeo/) ·
+[numgeo](https://www.numgeo.de) ·
+[numgeo documentation](https://j-machacek.github.io/numgeo/)
+
+Python API for the finite element code [numgeo](https://www.numgeo.de): the object model of a numgeo
+input deck, reading and writing input files, validation against what the solver accepts, running the
+solver, and reading its results — headless, on Windows and Linux.
+
+```python
+import pynumgeo as ng
+
+deck = ng.read("model.inp")              # numgeo input -> Deck (mesh, materials, steps, ...)
+issues = ng.validate(deck)               # what numgeo would reject or read differently
+ng.write(deck, "job/model.inp")          # normal-case, deterministic numgeo input
+res = ng.run(deck, "job", job="model")   # run numgeo, judge the outcome from its report files
+frames = ng.open_results("job", "model").frames()
+```
+
+```console
+pip install --pre pynumgeo               # Python 3.11+; runtime dependencies: numpy, pydantic 2
+pynumgeo validate model.inp              # every command also has --json
+pynumgeo run model.inp --workdir runs/m1
+pynumgeo info "*Initial conditions"
+pynumgeo --version
+```
+
+The [documentation](https://j-machacek.github.io/pynumgeo/) is built with [Zensical](https://zensical.org)
+from `docs/` (`pip install -e ".[docs]"`, then `zensical serve`); `docs/llms.txt` is a one-page summary for
+agents.
+
+pynumgeo `2026.2.0.dev2` is a pre-release (hence `pip install --pre`) built against the numgeo developer
+source `834564ed` (`numgeo2026-v2`); `2026.2.0` will be released together with numgeo2026-v2. Every input file it writes starts with a header that names the
+pynumgeo version, its author and the numgeo build it was written for.
+
+Author: Jan Machacek. Licence: BSD-3-Clause (`LICENSE`). The numgeo reference texts bundled with the
+package are covered by the numgeo copyright notice in `NOTICE`.

pynumgeo-2026.2.0.dev2/pyproject.toml

@@ -0,0 +1,101 @@
+# =~~=~~=~~=~~=~~=~~=~~=~~=~~=~~=~~=~~=~~=~~=~~=~~=~~=~~=~~=~~=~~=~~=~~=~~=~~=~~=~~=~~=~~=~~=~~=~~=~~=~=~
+#                                                pynumgeo
+#                              Python API for the finite element code numgeo
+#                                     Copyright (C) 2026 Jan Machacek
+# =~~=~~=~~=~~=~~=~~=~~=~~=~~=~~=~~=~~=~~=~~=~~=~~=~~=~~=~~=~~=~~=~~=~~=~~=~~=~~=~~=~~=~~=~~=~~=~~=~~=~=~
+#
+# Author: Jan Machacek
+#
+# pynumgeo writes, checks and runs numgeo input files and reads numgeo results. It follows the
+# development of numgeo: new developments in the numgeo source code are taken over into the API, and a
+# CI pipeline tests every change.
+#
+# License: BSD-3-Clause, see LICENSE.
+# =~~=~~=~~=~~=~~=~~=~~=~~=~~=~~=~~=~~=~~=~~=~~=~~=~~=~~=~~=~~=~~=~~=~~=~~=~~=~~=~~=~~=~~=~~=~~=~~=~~=~=~
+
+[build-system]
+requires = ["hatchling>=1.27", "hatch-fancy-pypi-readme>=24"]
+build-backend = "hatchling.build"
+
+[project]
+name = "pynumgeo"
+dynamic = ["version", "readme"]
+description = "Python API for the finite element code numgeo: input decks, validation, runs and results"
+license = "BSD-3-Clause"
+license-files = ["LICENSE", "NOTICE"]
+authors = [{ name = "Jan Machacek" }]
+requires-python = ">=3.11"
+dependencies = ["numpy>=1.23", "pydantic>=2.5,<3"]
+classifiers = [
+  "Development Status :: 4 - Beta",
+  "Programming Language :: Python :: 3",
+  "Programming Language :: Python :: 3.11",
+  "Programming Language :: Python :: 3.12",
+  "Programming Language :: Python :: 3.13",
+  "Operating System :: Microsoft :: Windows",
+  "Operating System :: POSIX :: Linux",
+  "Topic :: Scientific/Engineering",
+  "Typing :: Typed",
+]
+
+[project.urls]
+Homepage = "https://github.com/j-machacek/pynumgeo"
+Documentation = "https://j-machacek.github.io/pynumgeo/"
+Source = "https://github.com/j-machacek/pynumgeo"
+numgeo = "https://www.numgeo.de"
+
+[project.optional-dependencies]
+meshio = ["meshio>=5"]
+pandas = ["pandas>=1.5"]
+docs = ["zensical>=0.0.73", "mkdocstrings-python>=2.0"]
+dev = ["pytest>=7", "pytest-cov", "ruff>=0.5", "mypy>=1.8", "pre-commit", "meshio>=5"]
+
+[project.scripts]
+pynumgeo = "pynumgeo.cli.__main__:main"
+
+[tool.hatch.version]
+path = "src/pynumgeo/_version.py"
+
+# PyPI cannot show the logo through the relative paths that GitHub uses: rewrite them to absolute URLs
+# (PNG) in the package description only.
+[tool.hatch.metadata.hooks.fancy-pypi-readme]
+content-type = "text/markdown"
+
+[[tool.hatch.metadata.hooks.fancy-pypi-readme.fragments]]
+path = "README.md"
+
+[[tool.hatch.metadata.hooks.fancy-pypi-readme.substitutions]]
+pattern = '="docs/assets/(pynumgeo-logo(?:-dark)?)\.svg"'
+replacement = '="https://raw.githubusercontent.com/j-machacek/pynumgeo/main/docs/assets/\1.png"'
+
+[tool.hatch.build.targets.wheel]
+packages = ["src/pynumgeo"]
+
+[tool.hatch.build.targets.sdist]
+include = ["src/pynumgeo", "README.md", "LICENSE", "NOTICE", "pyproject.toml"]
+
+[tool.pytest.ini_options]
+testpaths = ["tests", "src/pynumgeo"]
+addopts = "--doctest-modules -ra"
+markers = [
+  "solver: needs a numgeo executable (NUMGEO_EXE)",
+  "source: needs a numgeo-src checkout (NUMGEO_SRC)",
+  "examples: needs the example decks (NUMGEO_EXAMPLES)",
+  "slow: long-running",
+]
+
+[tool.ruff]
+line-length = 120
+target-version = "py311"
+src = ["src", "tests", "scripts"]
+
+[tool.ruff.lint]
+select = ["E", "F", "W", "I", "B", "UP", "SIM", "RUF"]
+ignore = ["RUF001", "RUF002", "RUF003"]
+
+[tool.mypy]
+python_version = "3.12"  # numpy>=2.3 stubs need >=3.12 syntax; the code itself targets 3.11 (ruff)
+strict = true
+files = ["src/pynumgeo"]
+plugins = ["pydantic.mypy"]
+warn_unused_ignores = true

pynumgeo-2026.2.0.dev2/src/pynumgeo/__init__.py

@@ -0,0 +1,144 @@
+# =~~=~~=~~=~~=~~=~~=~~=~~=~~=~~=~~=~~=~~=~~=~~=~~=~~=~~=~~=~~=~~=~~=~~=~~=~~=~~=~~=~~=~~=~~=~~=~~=~~=~=~
+#                                                pynumgeo
+#                              Python API for the finite element code numgeo
+#                                     Copyright (C) 2026 Jan Machacek
+# =~~=~~=~~=~~=~~=~~=~~=~~=~~=~~=~~=~~=~~=~~=~~=~~=~~=~~=~~=~~=~~=~~=~~=~~=~~=~~=~~=~~=~~=~~=~~=~~=~~=~=~
+#
+# Author: Jan Machacek
+#
+# pynumgeo writes, checks and runs numgeo input files and reads numgeo results. It follows the
+# development of numgeo: new developments in the numgeo source code are taken over into the API, and a
+# CI pipeline tests every change.
+#
+# License: BSD-3-Clause, see LICENSE.
+# =~~=~~=~~=~~=~~=~~=~~=~~=~~=~~=~~=~~=~~=~~=~~=~~=~~=~~=~~=~~=~~=~~=~~=~~=~~=~~=~~=~~=~~=~~=~~=~~=~~=~=~
+"""pynumgeo — Python API for the finite element code numgeo.
+
+Read, build, validate and write numgeo input decks, run the solver and read its results::
+
+    import pynumgeo as ng
+
+    deck = ng.read("model.inp")              # numgeo input -> Deck (mesh, materials, steps, ...)
+    issues = ng.validate(deck)               # what numgeo would reject or read differently
+    ng.write(deck, "job/model.inp")          # normal-case, deterministic numgeo input
+    res = ng.run(deck, "job", job="model")   # run numgeo, judge the outcome from its logs
+    frames = ng.open_results("job", "model").frames()
+
+Everything numgeo-specific (keywords, options, element types, constitutive models, messages) comes from
+the catalogue (:mod:`pynumgeo.catalogue`), generated from the numgeo source. Submodules are imported
+lazily, so ``import pynumgeo`` stays fast. The functions ``run`` and ``validate`` live in the subpackages
+:mod:`pynumgeo.solver` and :mod:`pynumgeo.validation`; the subpackages are named differently from the
+functions so that importing one never replaces ``pynumgeo.run`` or ``pynumgeo.validate`` by a module.
+"""
+
+from __future__ import annotations
+
+import importlib
+from typing import TYPE_CHECKING, Any
+
+from pynumgeo._version import NUMGEO_DOCS_COMMIT, NUMGEO_SOURCE_COMMIT, NUMGEO_VERSION, __version__
+
+if TYPE_CHECKING:  # pragma: no cover
+    from pynumgeo import catalogue
+    from pynumgeo.deck import Amplitude, Deck, Keyword, Material, Section, Step, diff
+    from pynumgeo.io.reader import (
+        FragmentResult,
+        ReadError,
+        ReadResult,
+        data_tokens,
+        parse,
+        parse_fragment,
+        parse_text,
+        read,
+    )
+    from pynumgeo.io.writer import WriteError, format_keyword, format_material, write, write_text, write_texts
+    from pynumgeo.issue import Issue
+    from pynumgeo.mesh import Mesh
+    from pynumgeo.results import open_results
+    from pynumgeo.solver import RunResult, RunStatus, run
+    from pynumgeo.validation import BuildProfile, validate
+
+__all__ = [
+    "NUMGEO_DOCS_COMMIT",
+    "NUMGEO_SOURCE_COMMIT",
+    "NUMGEO_VERSION",
+    "Amplitude",
+    "BuildProfile",
+    "Deck",
+    "FragmentResult",
+    "Issue",
+    "Keyword",
+    "Material",
+    "Mesh",
+    "ReadError",
+    "ReadResult",
+    "RunResult",
+    "RunStatus",
+    "Section",
+    "Step",
+    "WriteError",
+    "__version__",
+    "catalogue",
+    "data_tokens",
+    "diff",
+    "format_keyword",
+    "format_material",
+    "open_results",
+    "parse",
+    "parse_fragment",
+    "parse_text",
+    "read",
+    "run",
+    "validate",
+    "write",
+    "write_text",
+    "write_texts",
+]
+
+_LAZY = {
+    "catalogue": ("pynumgeo.catalogue", None),
+    "Amplitude": ("pynumgeo.deck", "Amplitude"),
+    "Deck": ("pynumgeo.deck", "Deck"),
+    "Keyword": ("pynumgeo.deck", "Keyword"),
+    "Material": ("pynumgeo.deck", "Material"),
+    "Section": ("pynumgeo.deck", "Section"),
+    "Step": ("pynumgeo.deck", "Step"),
+    "diff": ("pynumgeo.deck", "diff"),
+    "Mesh": ("pynumgeo.mesh", "Mesh"),
+    "Issue": ("pynumgeo.issue", "Issue"),
+    "ReadError": ("pynumgeo.io.reader", "ReadError"),
+    "ReadResult": ("pynumgeo.io.reader", "ReadResult"),
+    "FragmentResult": ("pynumgeo.io.reader", "FragmentResult"),
+    "parse_fragment": ("pynumgeo.io.reader", "parse_fragment"),
+    "data_tokens": ("pynumgeo.io.reader", "data_tokens"),
+    "parse": ("pynumgeo.io.reader", "parse"),
+    "parse_text": ("pynumgeo.io.reader", "parse_text"),
+    "read": ("pynumgeo.io.reader", "read"),
+    "WriteError": ("pynumgeo.io.writer", "WriteError"),
+    "write": ("pynumgeo.io.writer", "write"),
+    "write_text": ("pynumgeo.io.writer", "write_text"),
+    "write_texts": ("pynumgeo.io.writer", "write_texts"),
+    "format_keyword": ("pynumgeo.io.writer", "format_keyword"),
+    "format_material": ("pynumgeo.io.writer", "format_material"),
+    "BuildProfile": ("pynumgeo.validation", "BuildProfile"),
+    "validate": ("pynumgeo.validation", "validate"),
+    "run": ("pynumgeo.solver", "run"),
+    "RunResult": ("pynumgeo.solver", "RunResult"),
+    "RunStatus": ("pynumgeo.solver", "RunStatus"),
+    "open_results": ("pynumgeo.results", "open_results"),
+}
+
+
+def __getattr__(name: str) -> Any:
+    try:
+        mod, attr = _LAZY[name]
+    except KeyError:
+        raise AttributeError(f"module 'pynumgeo' has no attribute {name!r}") from None
+    m = importlib.import_module(mod)
+    value = m if attr is None else getattr(m, attr)
+    globals()[name] = value
+    return value
+
+
+def __dir__() -> list[str]:
+    return sorted(__all__)

pynumgeo-2026.2.0.dev2/src/pynumgeo/_provenance.py

@@ -0,0 +1,77 @@
+# =~~=~~=~~=~~=~~=~~=~~=~~=~~=~~=~~=~~=~~=~~=~~=~~=~~=~~=~~=~~=~~=~~=~~=~~=~~=~~=~~=~~=~~=~~=~~=~~=~~=~=~
+#                                                pynumgeo
+#                              Python API for the finite element code numgeo
+#                                     Copyright (C) 2026 Jan Machacek
+# =~~=~~=~~=~~=~~=~~=~~=~~=~~=~~=~~=~~=~~=~~=~~=~~=~~=~~=~~=~~=~~=~~=~~=~~=~~=~~=~~=~~=~~=~~=~~=~~=~~=~=~
+#
+# Author: Jan Machacek
+#
+# pynumgeo writes, checks and runs numgeo input files and reads numgeo results. It follows the
+# development of numgeo: new developments in the numgeo source code are taken over into the API, and a
+# CI pipeline tests every change.
+#
+# License: BSD-3-Clause, see LICENSE.
+# =~~=~~=~~=~~=~~=~~=~~=~~=~~=~~=~~=~~=~~=~~=~~=~~=~~=~~=~~=~~=~~=~~=~~=~~=~~=~~=~~=~~=~~=~~=~~=~~=~~=~=~
+"""What pynumgeo writes into every file it creates: program, version and author.
+
+* Input files start with a banner of numgeo comment lines (``**``), in the style of the numgeo source
+  files: :func:`input_file_header`. numgeo cuts every line at ``**``, so the banner is not read.
+* The console log of a run (``<job>.console.log``) starts with :func:`console_header`; the console
+  parser skips that line.
+* The JSON reports of the command line carry :func:`provenance` under the key ``"pynumgeo"``.
+
+The creation date is not written: the same deck always gives the same file.
+
+Examples:
+    >>> print("\\n".join(input_file_header()))  # doctest: +ELLIPSIS
+    ** =~~=~~=...=~=~
+    ...numgeo input file
+    ...Created with pynumgeo ..., the Python API for numgeo by Jan Machacek
+    ...Written for numgeo... (numgeo source ...)
+    ** =~~=~~=...=~=~
+"""
+
+from __future__ import annotations
+
+from pynumgeo._version import NUMGEO_SOURCE_COMMIT, NUMGEO_VERSION, __version__
+
+__all__ = ["AUTHOR", "BANNER", "CONSOLE_MARK", "console_header", "input_file_header", "provenance"]
+
+#: The author of pynumgeo.
+AUTHOR = "Jan Machacek"
+#: Banner line of the numgeo source files (103 characters).
+BANNER = "=~~" * 33 + "=~=~"
+#: Start of the first line of a console log written by pynumgeo.
+CONSOLE_MARK = "pynumgeo "
+
+
+def _centre(text: str) -> str:
+    return " " * max((len(BANNER) - len(text)) // 2, 0) + text
+
+
+def input_file_header() -> list[str]:
+    """The comment lines at the top of every input file pynumgeo writes (each at most 106 characters)."""
+    lines = [
+        BANNER,
+        _centre("numgeo input file"),
+        _centre(f"Created with pynumgeo {__version__}, the Python API for numgeo by {AUTHOR}"),
+        _centre(f"Written for {NUMGEO_VERSION} (numgeo source {NUMGEO_SOURCE_COMMIT[:8]})"),
+        BANNER,
+    ]
+    return [f"** {ln}" for ln in lines]
+
+
+def console_header(command: list[str]) -> str:
+    """The first line of ``<job>.console.log``: who recorded it, and the command that started numgeo."""
+    return f"{CONSOLE_MARK}{__version__} (Python API for numgeo by {AUTHOR}): console output of {' '.join(command)}"
+
+
+def provenance() -> dict[str, str]:
+    """Program, version and author, plus the numgeo build pynumgeo was written for (JSON reports)."""
+    return {
+        "program": "pynumgeo",
+        "version": __version__,
+        "author": AUTHOR,
+        "numgeo_version": NUMGEO_VERSION,
+        "numgeo_source_commit": NUMGEO_SOURCE_COMMIT,
+    }

pynumgeo-2026.2.0.dev2/src/pynumgeo/_version.py

@@ -0,0 +1,28 @@
+# =~~=~~=~~=~~=~~=~~=~~=~~=~~=~~=~~=~~=~~=~~=~~=~~=~~=~~=~~=~~=~~=~~=~~=~~=~~=~~=~~=~~=~~=~~=~~=~~=~~=~=~
+#                                                pynumgeo
+#                              Python API for the finite element code numgeo
+#                                     Copyright (C) 2026 Jan Machacek
+# =~~=~~=~~=~~=~~=~~=~~=~~=~~=~~=~~=~~=~~=~~=~~=~~=~~=~~=~~=~~=~~=~~=~~=~~=~~=~~=~~=~~=~~=~~=~~=~~=~~=~=~
+#
+# Author: Jan Machacek
+#
+# pynumgeo writes, checks and runs numgeo input files and reads numgeo results. It follows the
+# development of numgeo: new developments in the numgeo source code are taken over into the API, and a
+# CI pipeline tests every change.
+#
+# License: BSD-3-Clause, see LICENSE.
+# =~~=~~=~~=~~=~~=~~=~~=~~=~~=~~=~~=~~=~~=~~=~~=~~=~~=~~=~~=~~=~~=~~=~~=~~=~~=~~=~~=~~=~~=~~=~~=~~=~~=~=~
+"""Version of pynumgeo and of the numgeo source it was derived from.
+
+pynumgeo follows the numgeo version: numgeo ``numgeo2026-v2`` corresponds to pynumgeo ``2026.2.x``
+(``.devN`` until it is released together with numgeo).
+"""
+
+__version__ = "2026.2.0.dev2"
+
+#: numgeo version string this pynumgeo was derived from (console banner of the solver).
+NUMGEO_VERSION = "numgeo2026-v2"
+#: numgeo-src commit the catalogue was generated from.
+NUMGEO_SOURCE_COMMIT = "834564ed77c2aa9ce5f6cdeabc03293c331520af"
+#: numgeo documentation commit the bundled reference pages come from.
+NUMGEO_DOCS_COMMIT = "eceee9749a1f0e47ff9aeedd50131707c4d7290a"