pyflightstream 0.2.0__tar.gz → 0.3.0__tar.gz

pyflightstream-0.3.0/PKG-INFO

@@ -0,0 +1,191 @@
+Metadata-Version: 2.4
+Name: pyflightstream
+Version: 0.3.0
+Summary: Version-aware, didactic Python driver for the FlightStream panel-method solver
+Author: Geovana Neves
+License: MIT
+Project-URL: Repository, https://github.com/nevesgeovana/pyflightstream
+Project-URL: Documentation, https://nevesgeovana.github.io/pyflightstream/
+Project-URL: Changelog, https://github.com/nevesgeovana/pyflightstream/blob/main/CHANGELOG.md
+Project-URL: Issues, https://github.com/nevesgeovana/pyflightstream/issues
+Classifier: Development Status :: 4 - Beta
+Classifier: Intended Audience :: Science/Research
+Classifier: License :: OSI Approved :: MIT License
+Classifier: Operating System :: OS Independent
+Classifier: Programming Language :: Python :: 3
+Classifier: Programming Language :: Python :: 3.11
+Classifier: Programming Language :: Python :: 3.12
+Classifier: Topic :: Scientific/Engineering :: Physics
+Requires-Python: >=3.11
+Description-Content-Type: text/markdown
+License-File: LICENSE
+Requires-Dist: numpy
+Requires-Dist: pandas
+Requires-Dist: pydantic
+Requires-Dist: pyyaml
+Requires-Dist: xarray
+Provides-Extra: plot
+Requires-Dist: matplotlib; extra == "plot"
+Provides-Extra: geom
+Requires-Dist: trimesh; extra == "geom"
+Requires-Dist: rtree; extra == "geom"
+Requires-Dist: scipy; extra == "geom"
+Provides-Extra: fsi
+Requires-Dist: PyNiteFEA>=3.0; extra == "fsi"
+Provides-Extra: dev
+Requires-Dist: pytest; extra == "dev"
+Requires-Dist: sybil; extra == "dev"
+Requires-Dist: ruff; extra == "dev"
+Requires-Dist: pre-commit; extra == "dev"
+Requires-Dist: properdocs; extra == "dev"
+Requires-Dist: mkdocs-material; extra == "dev"
+Requires-Dist: mkdocs-gen-files; extra == "dev"
+Requires-Dist: mkdocs-literate-nav; extra == "dev"
+Dynamic: license-file
+
+# pyflightstream
+
+[![ci](https://github.com/nevesgeovana/pyflightstream/actions/workflows/ci.yml/badge.svg)](https://github.com/nevesgeovana/pyflightstream/actions/workflows/ci.yml)
+[![PyPI](https://img.shields.io/pypi/v/pyflightstream)](https://pypi.org/project/pyflightstream/)
+[![DOI](https://zenodo.org/badge/DOI/10.5281/zenodo.21482925.svg)](https://doi.org/10.5281/zenodo.21482925)
+
+Version-aware, didactic Python driver for the FlightStream panel-method
+solver. Successor of the author's legacy research scripts. MIT licensed.
+
+Status: v0.2.0 is public on [PyPI](https://pypi.org/project/pyflightstream/)
+with the archived release on Zenodo (DOI recorded in CITATION.cff).
+Development continues toward v0.3.0; CHANGELOG.md carries the release
+history.
+
+```
+pip install pyflightstream
+```
+
+A first taste, no solver required (build time is where errors surface):
+
+```python
+from pyflightstream.commands import CommandNotInVersionError
+from pyflightstream.script import Script
+
+script = Script(version="26.12")  # the FlightStream version is explicit input
+script.emit("NEW_SIMULATION")
+script.emit("IMPORT", "METER", "STL", "wing.stl", clear=True)
+script.emit("SOLVER_SET_AOA", 4.0)
+script.emit("START_SOLVER")
+print(script.render())  # validated ASCII script, ready for the solver
+
+try:
+    Script(version="26.0").emit("SOLVER_SET_AOA", 4.0)
+except CommandNotInVersionError as error:
+    print(error)  # refused: no recorded evidence for that version
+```
+
+The worked examples in `examples/` take it from here to executed
+polars, campaigns, and coupled aeroelastic runs.
+
+Optional extras: `[fsi]` (aeroelastic coupling, PyNiteFEA), `[geom]`
+(probe-survey geometry gating, trimesh/rtree/scipy), `[plot]`
+(matplotlib for the plotting examples).
+
+## Why this package
+
+FlightStream is scripted through an ASCII command file, and the solver
+is under active development: the FlightStream team is responsive to
+user requests and works with intermediate hotfix builds that
+consolidate into stable releases. A fast-moving solver naturally means
+a scripting command set that evolves from version to version, faster
+than any single document can track. This package makes the
+FlightStream version an explicit input: every command it emits is
+validated against a per-version command database, and old versions are
+only ever added, never dropped, so campaigns stay reproducible across
+that evolution.
+
+Every database entry carries a manual page citation, and its status per
+version (documented, verified, broken) can only be promoted by citing a
+committed probe report from a licensed machine. Nothing is guessed; the
+honest gaps are reported as such.
+
+## What ships
+
+- Command database with per-version evidence and a manual citation on
+  every entry, browsable offline via `pyflightstream.help()` (including
+  a manual-coverage section) and as a generated docs site; the
+  compatibility matrix carries the live counts.
+- Validating script builder with curated helpers: phase ordering,
+  didactic refusals at build time, entity labels (recipes can name
+  frames, actuators, motions, and boundaries instead of raw indices),
+  and a solver-setup provenance snapshot recording the effective value
+  of every solver flag per run.
+- Campaign workspace: an input-artifact library (references, solver
+  presets, boundary groups, geometries, profiles, executables by build
+  id), a run manifest as the single identity authority, output naming
+  templates, campaign pre-flight with zero solver time, and resumable
+  incremental sweeps.
+- Runner and parsers: headless execution, anchor-based parsers for the
+  solver outputs, and a pandas table layer (per-result tables, one wide
+  row per run, whole-sweep DataFrame straight from the manifest).
+- Run-matrix support as a first-class interface: read, convert,
+  pre-flight, and run the pipe-delimited 15-column matrix format.
+- Far-field probe surveys (planar grids, geometry gating, VTK/Tecplot
+  writers, conservation ledgers on xarray) and an aeroelastic coupling
+  subpackage (structural beam, coupled driver, replay harness).
+- Architecture overview from the live module docstrings via
+  `pyflightstream.overview()`.
+- Predictable surfaces: a declared-options registry
+  (`pyflightstream.options`), one public exception catalog
+  (`pyflightstream.exceptions`), test assertions with quantified
+  reports (`pyflightstream.testing`), and the house conventions
+  rendered by `help()`.
+
+## Command-line tools
+
+| Tool | Purpose |
+|---|---|
+| `pyfs-qa` | Tier 2 command-validity probes, Tier 3 physics regression and cross-version drift, status promotion from committed reports |
+| `pyfs-workspace` | Initialize the managed campaign workspace tree |
+| `pyfs-matrix` | Convert and pre-flight run matrices |
+| `pyfs-fsi` | The structural executable of the aeroelastic coupling loop |
+
+## Supported FlightStream versions
+
+Registered: 26.000, 26.100, 26.120 (canonical 26.XXX scheme; the last
+digit indexes vendor hotfix builds). The ordered list in
+`src/pyflightstream/commands/_meta.yaml` is the only ordering
+authority. Evidence is strongest on 26.120 (probed on a licensed
+machine); 26.100 is partially backfilled from the manuals; the 26.000
+column is honestly empty until probed. The compatibility matrix in the
+docs is generated from the database at build time.
+
+## What is each folder?
+
+| Folder | Purpose in plain language |
+|---|---|
+| `src/pyflightstream/` | The package, one subpackage per pipeline stage (versions, commands, script, results, cases, run, workspace, post, qa, plus fsi, probes, farfield) |
+| `src/pyflightstream/commands/` | The command database: what exists in which FlightStream version, with manual page citations |
+| `tests/` | Tier 1 tests, runnable anywhere, no FlightStream needed |
+| `reports/` | Committed evidence from licensed machines: command validity (compat), physics regression, drift, and research cards |
+| `docs/` | Documentation source (ProperDocs); reference pages are generated from the database, never committed |
+| `examples/` | Runnable example scripts in percent format |
+| `guide/` | LaTeX source of the user guide (the built pdf never enters Git) |
+| `deprecated/` | Discontinued public items, grouped here instead of scattered at the top level |
+| `.claude/skills/` | Maintenance procedures (version updates, command additions, QA runs, releases) |
+| `_private/` | Local only, never committed: FlightStream manuals, executables, research geometry |
+
+## Development setup
+
+```
+pip install -e .[dev,fsi,geom]
+pre-commit install
+pytest
+```
+
+Tier 1 (the pytest suite) runs anywhere. Tier 2 (command validity
+probes) and Tier 3 (physics regression) require a local FlightStream
+license and are documented in CONTRIBUTING.md. The docs build with
+`properdocs build --strict`.
+
+## License
+
+MIT. Contributions must be original or MIT-compatible; code derived
+from the AGPL pyFlightscript package is not accepted. See
+CONTRIBUTING.md.

pyflightstream-0.3.0/README.md

@@ -0,0 +1,146 @@
+# pyflightstream
+
+[![ci](https://github.com/nevesgeovana/pyflightstream/actions/workflows/ci.yml/badge.svg)](https://github.com/nevesgeovana/pyflightstream/actions/workflows/ci.yml)
+[![PyPI](https://img.shields.io/pypi/v/pyflightstream)](https://pypi.org/project/pyflightstream/)
+[![DOI](https://zenodo.org/badge/DOI/10.5281/zenodo.21482925.svg)](https://doi.org/10.5281/zenodo.21482925)
+
+Version-aware, didactic Python driver for the FlightStream panel-method
+solver. Successor of the author's legacy research scripts. MIT licensed.
+
+Status: v0.2.0 is public on [PyPI](https://pypi.org/project/pyflightstream/)
+with the archived release on Zenodo (DOI recorded in CITATION.cff).
+Development continues toward v0.3.0; CHANGELOG.md carries the release
+history.
+
+```
+pip install pyflightstream
+```
+
+A first taste, no solver required (build time is where errors surface):
+
+```python
+from pyflightstream.commands import CommandNotInVersionError
+from pyflightstream.script import Script
+
+script = Script(version="26.12")  # the FlightStream version is explicit input
+script.emit("NEW_SIMULATION")
+script.emit("IMPORT", "METER", "STL", "wing.stl", clear=True)
+script.emit("SOLVER_SET_AOA", 4.0)
+script.emit("START_SOLVER")
+print(script.render())  # validated ASCII script, ready for the solver
+
+try:
+    Script(version="26.0").emit("SOLVER_SET_AOA", 4.0)
+except CommandNotInVersionError as error:
+    print(error)  # refused: no recorded evidence for that version
+```
+
+The worked examples in `examples/` take it from here to executed
+polars, campaigns, and coupled aeroelastic runs.
+
+Optional extras: `[fsi]` (aeroelastic coupling, PyNiteFEA), `[geom]`
+(probe-survey geometry gating, trimesh/rtree/scipy), `[plot]`
+(matplotlib for the plotting examples).
+
+## Why this package
+
+FlightStream is scripted through an ASCII command file, and the solver
+is under active development: the FlightStream team is responsive to
+user requests and works with intermediate hotfix builds that
+consolidate into stable releases. A fast-moving solver naturally means
+a scripting command set that evolves from version to version, faster
+than any single document can track. This package makes the
+FlightStream version an explicit input: every command it emits is
+validated against a per-version command database, and old versions are
+only ever added, never dropped, so campaigns stay reproducible across
+that evolution.
+
+Every database entry carries a manual page citation, and its status per
+version (documented, verified, broken) can only be promoted by citing a
+committed probe report from a licensed machine. Nothing is guessed; the
+honest gaps are reported as such.
+
+## What ships
+
+- Command database with per-version evidence and a manual citation on
+  every entry, browsable offline via `pyflightstream.help()` (including
+  a manual-coverage section) and as a generated docs site; the
+  compatibility matrix carries the live counts.
+- Validating script builder with curated helpers: phase ordering,
+  didactic refusals at build time, entity labels (recipes can name
+  frames, actuators, motions, and boundaries instead of raw indices),
+  and a solver-setup provenance snapshot recording the effective value
+  of every solver flag per run.
+- Campaign workspace: an input-artifact library (references, solver
+  presets, boundary groups, geometries, profiles, executables by build
+  id), a run manifest as the single identity authority, output naming
+  templates, campaign pre-flight with zero solver time, and resumable
+  incremental sweeps.
+- Runner and parsers: headless execution, anchor-based parsers for the
+  solver outputs, and a pandas table layer (per-result tables, one wide
+  row per run, whole-sweep DataFrame straight from the manifest).
+- Run-matrix support as a first-class interface: read, convert,
+  pre-flight, and run the pipe-delimited 15-column matrix format.
+- Far-field probe surveys (planar grids, geometry gating, VTK/Tecplot
+  writers, conservation ledgers on xarray) and an aeroelastic coupling
+  subpackage (structural beam, coupled driver, replay harness).
+- Architecture overview from the live module docstrings via
+  `pyflightstream.overview()`.
+- Predictable surfaces: a declared-options registry
+  (`pyflightstream.options`), one public exception catalog
+  (`pyflightstream.exceptions`), test assertions with quantified
+  reports (`pyflightstream.testing`), and the house conventions
+  rendered by `help()`.
+
+## Command-line tools
+
+| Tool | Purpose |
+|---|---|
+| `pyfs-qa` | Tier 2 command-validity probes, Tier 3 physics regression and cross-version drift, status promotion from committed reports |
+| `pyfs-workspace` | Initialize the managed campaign workspace tree |
+| `pyfs-matrix` | Convert and pre-flight run matrices |
+| `pyfs-fsi` | The structural executable of the aeroelastic coupling loop |
+
+## Supported FlightStream versions
+
+Registered: 26.000, 26.100, 26.120 (canonical 26.XXX scheme; the last
+digit indexes vendor hotfix builds). The ordered list in
+`src/pyflightstream/commands/_meta.yaml` is the only ordering
+authority. Evidence is strongest on 26.120 (probed on a licensed
+machine); 26.100 is partially backfilled from the manuals; the 26.000
+column is honestly empty until probed. The compatibility matrix in the
+docs is generated from the database at build time.
+
+## What is each folder?
+
+| Folder | Purpose in plain language |
+|---|---|
+| `src/pyflightstream/` | The package, one subpackage per pipeline stage (versions, commands, script, results, cases, run, workspace, post, qa, plus fsi, probes, farfield) |
+| `src/pyflightstream/commands/` | The command database: what exists in which FlightStream version, with manual page citations |
+| `tests/` | Tier 1 tests, runnable anywhere, no FlightStream needed |
+| `reports/` | Committed evidence from licensed machines: command validity (compat), physics regression, drift, and research cards |
+| `docs/` | Documentation source (ProperDocs); reference pages are generated from the database, never committed |
+| `examples/` | Runnable example scripts in percent format |
+| `guide/` | LaTeX source of the user guide (the built pdf never enters Git) |
+| `deprecated/` | Discontinued public items, grouped here instead of scattered at the top level |
+| `.claude/skills/` | Maintenance procedures (version updates, command additions, QA runs, releases) |
+| `_private/` | Local only, never committed: FlightStream manuals, executables, research geometry |
+
+## Development setup
+
+```
+pip install -e .[dev,fsi,geom]
+pre-commit install
+pytest
+```
+
+Tier 1 (the pytest suite) runs anywhere. Tier 2 (command validity
+probes) and Tier 3 (physics regression) require a local FlightStream
+license and are documented in CONTRIBUTING.md. The docs build with
+`properdocs build --strict`.
+
+## License
+
+MIT. Contributions must be original or MIT-compatible; code derived
+from the AGPL pyFlightscript package is not accepted. See
+CONTRIBUTING.md.

{pyflightstream-0.2.0 → pyflightstream-0.3.0}/pyproject.toml

@@ -4,12 +4,26 @@ build-backend = "setuptools.build_meta"
 
 [project]
 name = "pyflightstream"
-version = "0.2.0"
+version = "0.3.0"
 description = "Version-aware, didactic Python driver for the FlightStream panel-method solver"
 readme = "README.md"
 license = {text = "MIT"}
 authors = [{name = "Geovana Neves"}]
 requires-python = ">=3.11"
+# PyPA well-known metadata (audit 2026-07-23). The SPDX license
+# expression form is deferred with the VCS-versioning item: it needs a
+# setuptools floor bump, and the build toolchain does not move in a
+# release week (PLN-024).
+classifiers = [
+    "Development Status :: 4 - Beta",
+    "Intended Audience :: Science/Research",
+    "License :: OSI Approved :: MIT License",
+    "Operating System :: OS Independent",
+    "Programming Language :: Python :: 3",
+    "Programming Language :: Python :: 3.11",
+    "Programming Language :: Python :: 3.12",
+    "Topic :: Scientific/Engineering :: Physics",
+]
 # xarray confirmed as a runtime dependency by the author's far-field
 # extraction instruction of 2026-07-21 (PLN-006 closed): the farfield
 # ledgers live on labeled (station, r, psi) arrays.
@@ -31,10 +45,16 @@ geom = ["trimesh", "rtree", "scipy"]
 fsi = ["PyNiteFEA>=3.0"]
 dev = [
     "pytest",
+    # Executable examples in CI: docstring doctests and markdown code
+    # blocks (INB-006 item 1e, decision Q-007). Config in conftest.py.
+    "sybil",
     "ruff",
     "pre-commit",
+    # Docs build tool (license evidence: reports/RPT-009). The material
+    # theme and the nav plugins keep their mkdocs package names and
+    # still pull the mkdocs library during the ecosystem transition.
+    "properdocs",
     "mkdocs-material",
-    "mkdocstrings[python]",
     "mkdocs-gen-files",
     "mkdocs-literate-nav",
 ]
@@ -42,9 +62,14 @@ dev = [
 [project.scripts]
 pyfs-qa = "pyflightstream.qa.cli:main"
 pyfs-fsi = "pyflightstream.fsi.cli:main"
+pyfs-workspace = "pyflightstream.workspace.cli:main"
+pyfs-matrix = "pyflightstream.cases.cli:main"
 
 [project.urls]
 Repository = "https://github.com/nevesgeovana/pyflightstream"
+Documentation = "https://nevesgeovana.github.io/pyflightstream/"
+Changelog = "https://github.com/nevesgeovana/pyflightstream/blob/main/CHANGELOG.md"
+Issues = "https://github.com/nevesgeovana/pyflightstream/issues"
 
 [tool.setuptools.packages.find]
 where = ["src"]

pyflightstream-0.3.0/src/pyflightstream/__init__.py

@@ -0,0 +1,79 @@
+"""pyflightstream: version-aware, didactic Python driver for FlightStream.
+
+The package automates the FlightStream panel-method solver through its
+ASCII scripting interface. The FlightStream version is an explicit
+input: every command emitted is validated against the per-version
+command database in ``pyflightstream.commands``, where each entry
+carries a manual page citation and, when probed on a licensed machine,
+empirical evidence of its status. The script builder refuses at build
+time what the solver would reject (or silently ignore) at run time.
+
+Pipeline layers, dependencies flowing strictly downward:
+
+- ``versions``: canonical 26.XXX version identifiers and ordering.
+- ``commands``: the evidence-backed per-version command database.
+- ``script``: the validating ASCII script builder.
+- ``results``: anchor-based parsers for solver output files.
+- ``cases``: simulation and campaign definitions.
+- ``run`` and ``workspace``: execution, run manifest, and the managed
+  workspace (input-artifact library plus run layout); the old
+  ``files`` name survives as a deprecation shim.
+- ``post``: results into engineering data (sweep assembly, exports).
+- ``qa``: probe harness and physics regression tooling.
+
+Side packages follow the same downward-only rule:
+
+- ``fsi``: the structural executable of the aeroelastic coupling loop.
+- ``probes`` and ``farfield``: probe lattices for far-field surveys and
+  the conservation ledgers computed on them.
+- ``reference``: the command reference renderer behind ``help()``.
+
+Cross-cutting support modules, importable from any layer:
+
+- ``options``: the declared, validated machine and QA knobs
+  (``get_option``/``set_option`` also re-exported here at top level).
+- ``exceptions``: the single catalog of every exception and warning.
+- ``testing``: public assertions with quantified violation reports.
+
+Where to start:
+
+- :func:`pyflightstream.help` opens the offline HTML command reference,
+  rendered from the installed command database.
+- :func:`pyflightstream.overview` opens the offline HTML architecture
+  overview, rendered from the live module docstrings.
+- The published docs site carries the same reference and overview plus
+  the compatibility matrix and worked examples.
+"""
+
+from importlib import metadata
+
+try:
+    __version__ = metadata.version("pyflightstream")
+except metadata.PackageNotFoundError:
+    # Source tree imported without an installation (for example a
+    # checkout placed on sys.path): no distribution metadata exists, so
+    # the version is honestly unknown instead of a stale hardcoded
+    # string. Install the package (pip install -e .) to expose the real
+    # version.
+    __version__ = "0.0.0+uninstalled"
+
+from pyflightstream.options import (  # noqa: E402
+    describe_option,
+    get_option,
+    option_context,
+    reset_option,
+    set_option,
+)
+from pyflightstream.overview import overview  # noqa: E402
+from pyflightstream.reference import help  # noqa: E402
+
+__all__ = [
+    "__version__",
+    "describe_option",
+    "get_option",
+    "help",
+    "option_context",
+    "overview",
+    "reset_option",
+    "set_option",
+]

pyflightstream-0.3.0/src/pyflightstream/_deprecations.py

@@ -0,0 +1,121 @@
+"""Deprecation ledger: every shim's recorded removal promise.
+
+Pipeline role: cross-cutting support module (no solver semantics). A
+deprecation is a versioned promise: the old name keeps working until a
+stated package version and disappears at that version, never silently
+later. This module is the single home of those promises; the shim
+modules build their DeprecationWarning text from their ledger entry, so
+the message users see and the deadline the Tier 1 guard enforces
+(``tests/test_deprecation_deadline.py``) can never disagree (NFR-11).
+
+Lifecycle of an entry: it is added in the commit that creates the shim,
+its ``removal_version`` is cited by the shim's warning, and the entry
+is deleted together with the shim in the release that reaches that
+version. The Tier 1 guard fails the suite when a shim survives past its
+promise, so a release cannot ship an expired shim unnoticed.
+"""
+
+from __future__ import annotations
+
+from dataclasses import dataclass
+
+
+def parse_version(version: str) -> tuple[int, int, int]:
+    """Parse a plain SemVer string into a comparable tuple.
+
+    Parameters
+    ----------
+    version : str
+        A ``MAJOR.MINOR.PATCH`` string with integer fields, as used by
+        ``pyproject.toml``. Pre-release or local suffixes are not
+        accepted: removal promises are made against plain releases.
+
+    Returns
+    -------
+    tuple of int
+        ``(major, minor, patch)``, ordered like SemVer precedence.
+
+    Raises
+    ------
+    ValueError
+        If the string is not three dot-separated integers.
+    """
+    parts = version.split(".")
+    if len(parts) != 3 or not all(part.isdigit() for part in parts):
+        raise ValueError(
+            f"Expected a plain MAJOR.MINOR.PATCH version, got {version!r}; "
+            "deprecation promises are recorded against plain SemVer releases."
+        )
+    major, minor, patch = (int(part) for part in parts)
+    return (major, minor, patch)
+
+
+@dataclass(frozen=True)
+class DeprecatedModule:
+    """One deprecated module and its recorded removal promise.
+
+    Attributes
+    ----------
+    module : str
+        Dotted name of the shim module (the old import path).
+    replacement : str
+        Dotted name of the module that supersedes it.
+    deprecated_since : str
+        Package version (SemVer) whose release introduced the shim.
+    removal_version : str
+        First package version (SemVer) that must no longer carry the
+        shim. The Tier 1 deadline guard fails once ``pyproject.toml``
+        reaches this version with the shim still present.
+    extra : str
+        Optional extra sentence appended to the warning message, for
+        renames that involve more than the module path.
+    """
+
+    module: str
+    replacement: str
+    deprecated_since: str
+    removal_version: str
+    extra: str = ""
+
+    def message(self) -> str:
+        """Render the DeprecationWarning text emitted by the shim.
+
+        Returns
+        -------
+        str
+            One message stating the rename, the version that made the
+            promise, and the exact version that removes the old name.
+        """
+        text = (
+            f"{self.module} was renamed to {self.replacement} in "
+            f"v{self.deprecated_since} and will be removed in "
+            f"v{self.removal_version}; update the import to "
+            f"{self.replacement}."
+        )
+        if self.extra:
+            text = f"{text} {self.extra}"
+        return text
+
+
+#: Every live deprecation shim of the package, one entry each. The
+#: Tier 1 deadline guard iterates this tuple; an empty tuple means the
+#: package currently makes no deprecation promises.
+DEPRECATED_MODULES: tuple[DeprecatedModule, ...] = (
+    DeprecatedModule(
+        module="pyflightstream.files",
+        replacement="pyflightstream.workspace",
+        deprecated_since="0.3.0",
+        removal_version="0.4.0",
+        extra="The API is unchanged.",
+    ),
+    DeprecatedModule(
+        module="pyflightstream.cases.matrix_legacy",
+        replacement="pyflightstream.cases.matrix",
+        deprecated_since="0.3.0",
+        removal_version="0.4.0",
+        extra=(
+            "LegacyMatrixError is now MatrixError and LegacyRow is now "
+            "MatrixRow; everything else is unchanged."
+        ),
+    ),
+)

{pyflightstream-0.2.0 → pyflightstream-0.3.0}/src/pyflightstream/cases/__init__.py

@@ -5,9 +5,9 @@ by ``sim_id``) is one solver configuration with its sweep; a
 :class:`Campaign` groups cases with the FlightStream version and the
 executable path, both required and explicit: nothing is read from
 environment variables or guessed (SAD Section 5). Native persistence
-is ``campaign.toml``; the legacy pipe-delimited ``matriz.fs`` matrix
-of the predecessor scripts will be read unchanged, forever, by the
-legacy reader (FR-10, next step of milestone M2).
+is ``campaign.toml``; the pipe-delimited ``matrix.fs`` run matrix
+is read unchanged, forever, by the matrix reader
+(:mod:`pyflightstream.cases.matrix`, FR-10).
 
 Script recipes are explicitly imported functions satisfying the
 :class:`ScriptRecipe` protocol: ``build(case, script) -> None``. The