pyflightstream 0.2.0__py3-none-any.whl

pyflightstream/versions.py

@@ -0,0 +1,191 @@
+"""Canonical FlightStream version identifiers and their ordering.
+
+Pipeline role: the lowest layer. Everything else asks this module which
+FlightStream versions exist and how they are ordered.
+
+Canonical identifiers use the 26.XXX three-digit scheme (for example
+``26.120`` for the vendor release named 26.12); the last digit indexes
+vendor hotfix builds. Neither string nor float comparison orders vendor
+names correctly ("26.1" versus "26.12"), so the ordered list in
+``commands/_meta.yaml`` is the only ordering authority.
+"""
+
+from __future__ import annotations
+
+import re
+from dataclasses import dataclass
+from functools import lru_cache
+from importlib import resources
+
+import yaml
+
+_CANONICAL_PATTERN = re.compile(r"^\d{2}\.\d{3}$")
+
+
+class UnknownVersionError(ValueError):
+    """A FlightStream version identifier is not in the ordered registry.
+
+    Raised when a canonical identifier or display alias does not match
+    any entry of the ordered list in ``commands/_meta.yaml``. The message
+    lists every known version so the caller can correct the input or
+    register the new version first.
+    """
+
+
+@dataclass(frozen=True)
+class FsVersion:
+    """One registered FlightStream version.
+
+    Value object wrapping a canonical ``26.XXX`` identifier. Instances
+    are obtained through :func:`resolve` or :func:`known_versions`;
+    constructing one by hand bypasses the registry and is reserved to
+    this module.
+
+    Attributes
+    ----------
+    canonical : str
+        Canonical identifier in the three-fractional-digit scheme, for
+        example ``"26.120"``. The first two fractional digits carry the
+        official minor release, the last digit the vendor hotfix build
+        (0 means the official release).
+    alias : str
+        Vendor-facing release name, for example ``"26.12"``.
+    index : int
+        Position in the ordered list of ``commands/_meta.yaml``. All
+        ordering comparisons delegate to this index, never to string or
+        float comparison of the identifiers.
+    """
+
+    canonical: str
+    alias: str
+    index: int
+
+    def __post_init__(self) -> None:
+        """Reject identifiers that do not follow the canonical scheme."""
+        if not _CANONICAL_PATTERN.match(self.canonical):
+            raise UnknownVersionError(
+                f"{self.canonical!r} does not follow the canonical MAJOR.XXX "
+                "scheme with exactly three fractional digits (example: 26.120)."
+            )
+
+    def __str__(self) -> str:
+        """Return the canonical identifier."""
+        return self.canonical
+
+    def _index_against(self, other: object) -> int | None:
+        if isinstance(other, FsVersion):
+            return other.index
+        return None
+
+    def __lt__(self, other: object) -> bool:
+        """Order by release position in the registry list."""
+        other_index = self._index_against(other)
+        if other_index is None:
+            return NotImplemented
+        return self.index < other_index
+
+    def __le__(self, other: object) -> bool:
+        """Order by release position in the registry list."""
+        other_index = self._index_against(other)
+        if other_index is None:
+            return NotImplemented
+        return self.index <= other_index
+
+    def __gt__(self, other: object) -> bool:
+        """Order by release position in the registry list."""
+        other_index = self._index_against(other)
+        if other_index is None:
+            return NotImplemented
+        return self.index > other_index
+
+    def __ge__(self, other: object) -> bool:
+        """Order by release position in the registry list."""
+        other_index = self._index_against(other)
+        if other_index is None:
+            return NotImplemented
+        return self.index >= other_index
+
+
+@lru_cache(maxsize=1)
+def known_versions() -> tuple[FsVersion, ...]:
+    """Return every registered FlightStream version, in release order.
+
+    The list is read from ``commands/_meta.yaml`` inside the installed
+    package, so it is available from the wheel without repository access.
+
+    Returns
+    -------
+    tuple of FsVersion
+        Registered versions, ordered oldest first. The tuple position is
+        the ordering authority (CLAUDE.md invariant 4).
+    """
+    meta_text = (
+        resources.files("pyflightstream.commands")
+        .joinpath("_meta.yaml")
+        .read_text(encoding="utf-8")
+    )
+    meta = yaml.safe_load(meta_text)
+    return tuple(
+        FsVersion(canonical=entry["canonical"], alias=str(entry["alias"]), index=position)
+        for position, entry in enumerate(meta["versions"])
+    )
+
+
+@lru_cache(maxsize=1)
+def manual_editions() -> dict[str, str]:
+    """Return the registered manual edition per canonical version.
+
+    The mapping is read from ``commands/_meta.yaml`` and names the
+    manual edition (with its source id) that backs the ``documented``
+    statuses of each version. Versions without a registered edition are
+    absent; their commands await release-notes review or backfill
+    probing.
+
+    Returns
+    -------
+    dict of str to str
+        Manual edition description keyed by canonical identifier.
+    """
+    meta_text = (
+        resources.files("pyflightstream.commands")
+        .joinpath("_meta.yaml")
+        .read_text(encoding="utf-8")
+    )
+    meta = yaml.safe_load(meta_text)
+    editions = meta.get("manual_editions") or {}
+    return {str(key): str(value).strip() for key, value in editions.items()}
+
+
+def resolve(version: str | FsVersion) -> FsVersion:
+    """Resolve a canonical identifier or display alias to a registered version.
+
+    Parameters
+    ----------
+    version : str or FsVersion
+        Canonical identifier (``"26.120"``), display alias (``"26.12"``),
+        or an already resolved :class:`FsVersion`, returned unchanged.
+
+    Returns
+    -------
+    FsVersion
+        The registered version.
+
+    Raises
+    ------
+    UnknownVersionError
+        If the identifier matches no registered version. The message
+        lists the known versions; new versions are only added through
+        the ordered list in ``commands/_meta.yaml``.
+    """
+    if isinstance(version, FsVersion):
+        return version
+    for registered in known_versions():
+        if version in (registered.canonical, registered.alias):
+            return registered
+    known = ", ".join(f"{v.canonical} (vendor name {v.alias})" for v in known_versions())
+    raise UnknownVersionError(
+        f"FlightStream version {version!r} is not registered. Known versions, "
+        f"in release order: {known}. Canonical identifiers use the 26.XXX "
+        "three-digit scheme; register new versions in commands/_meta.yaml, "
+        "which is the only ordering authority."
+    )

pyflightstream-0.2.0.dist-info/METADATA

@@ -0,0 +1,88 @@
+Metadata-Version: 2.4
+Name: pyflightstream
+Version: 0.2.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
+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: ruff; extra == "dev"
+Requires-Dist: pre-commit; extra == "dev"
+Requires-Dist: mkdocs-material; extra == "dev"
+Requires-Dist: mkdocstrings[python]; extra == "dev"
+Requires-Dist: mkdocs-gen-files; extra == "dev"
+Requires-Dist: mkdocs-literate-nav; extra == "dev"
+Dynamic: license-file
+
+# pyflightstream
+
+Version-aware, didactic Python driver for the FlightStream panel-method solver.
+Successor of the author's legacy research scripts. MIT licensed.
+
+Status: pre-alpha, milestone M0 (repository skeleton). The package installs and
+imports, but no functionality ships yet. See the milestone plan below.
+
+## Why this package
+
+FlightStream is scripted through an ASCII command file whose commands change
+between solver versions, and not every change reaches the changelog. 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.
+
+## What is each folder?
+
+| Folder | Purpose in plain language |
+|---|---|
+| `src/pyflightstream/` | The package itself, one subpackage per pipeline stage |
+| `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: which commands actually work (compat) and physics regression results |
+| `docs/` | Documentation source (mkdocs) |
+| `examples/` | Runnable example scripts in percent format |
+| `.claude/skills/` | Maintenance procedures (version updates, command additions, QA runs, releases) |
+| `_private/` | Local only, never committed: FlightStream manuals and research geometry |
+
+## Supported FlightStream versions
+
+Planned at launch: 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.
+
+## Development setup
+
+```
+pip install -e .[dev]
+pre-commit install
+pytest
+```
+
+Tier 2 (command validity probes) and Tier 3 (physics regression) require a
+local FlightStream license and are documented in CONTRIBUTING.md.
+
+## Milestones
+
+M0 skeleton (this) > M1 command database > M2 builder, runner, parser >
+M3 compat report > M4 physics cases > M5 docs and example > v0.1.0 (private).
+
+## 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.dist-info/RECORD

@@ -0,0 +1,71 @@
+pyflightstream/__init__.py,sha256=9KF_ePOp8WiabGyzrkfDi9DmwqD9xLO6OuHXKSJ_PVw,1150
+pyflightstream/reference.py,sha256=9EwpW6YePyRjALr_lJ9AzbMMwyiTQbFiZ0PTw1ZSoO0,17696
+pyflightstream/versions.py,sha256=ACXF8D0lo3aeaKjb4SUF_NSZAyaSMln1384gIInA-co,6897
+pyflightstream/cases/__init__.py,sha256=wN3SgxV2uyzCLPfNK-zhkn432lx-9BkDhkBXtUPB26o,11624
+pyflightstream/cases/matrix_legacy.py,sha256=76fJFCky_Wp3rKXjLQtMKPvYzgHqjZXtr9E0AnUbWJg,12102
+pyflightstream/commands/__init__.py,sha256=y2jirOauFQ6e_Yb2EvDfH2OUAQ9gQvmzqxR6KoBh6aU,21373
+pyflightstream/commands/_meta.yaml,sha256=ZAB1jlt0wy2aA9ddm6fMkDFABmlnDf3ACUFf02NqJY8,681
+pyflightstream/commands/actuators.yaml,sha256=rlk8by47uX7cMV7vU4UXOliIBzwNSM7gI1Bx1eW1gMc,4351
+pyflightstream/commands/advanced_settings.yaml,sha256=wAybL0xY2zfdOCQI6ps2B2n6dbPFsKtBxd_ozxz7-nY,3426
+pyflightstream/commands/aeroelastic_coupling.yaml,sha256=3roBumDYMcxM_89DXahFofhtBMA2AXGH37lvVmoBWa4,5460
+pyflightstream/commands/boundary_conditions.yaml,sha256=Fp28w0TnsxQMXdt9xaQioiDdz2DC6sLEbRuLZXW3qbk,4521
+pyflightstream/commands/ccs_wing_mesh.yaml,sha256=yLCLLLHMjPED3xJulSY6akXn-jB_hJ5Rpeam58eFMYg,2203
+pyflightstream/commands/coordinate_systems.yaml,sha256=E8i5FWyn8A5tvg0mXzdmtmpUU5m6jnkB2KKgDFufyC4,3169
+pyflightstream/commands/file_io.yaml,sha256=o-Z1y_YRdCTH4So9LMJQ1brX7bmGjItEOXb4zdveuKc,2567
+pyflightstream/commands/mesh_import_export.yaml,sha256=sK3vcwSOQlyfwXqUKEmnzVNYtU4hjVH_2r6YNRugOQ0,2271
+pyflightstream/commands/motion_definitions.yaml,sha256=YNe-pmc-2_ag--JsK_Xoo4k4UzBFb71URe2kBGTA4oo,5176
+pyflightstream/commands/probe_points.yaml,sha256=eB-ddRIV6nl-mW2ONFQPVnv4Ibk5jvv8rTCXM1qXzmg,3890
+pyflightstream/commands/runtime_settings.yaml,sha256=SJNi_bdY6z44IRPrpWoPIjg7cehT2v9keXpeZOsII74,4623
+pyflightstream/commands/scenes.yaml,sha256=FTvudHFNFJ3IT1Hch7RsFuHCHwsnM5tvtFitHyft3s4,468
+pyflightstream/commands/script_controls.yaml,sha256=mPBWPchbgUvD9JimXBYT7hhSMktWxoNa5hv5qztzv2k,1155
+pyflightstream/commands/simulation_controls.yaml,sha256=Nkxmprc-mtXAy74rk0fhYWkjcLSPyJuCCqxl717ySO4,943
+pyflightstream/commands/solver_analysis.yaml,sha256=ohUu3u7ZvzJGUOnZB6bjwODkzUVMweLcoiX4wxYBIJQ,3623
+pyflightstream/commands/solver_export.yaml,sha256=lysFWe0h4rjazyCLx_XJ1xJxkDS2cXTrQ9TnwTpZXAg,3981
+pyflightstream/commands/solver_initialization.yaml,sha256=G2-5YqZTwmcef4PxwrvKvk2kSCxcBDkXMV-Lz5yQqGA,3140
+pyflightstream/commands/solver_settings.yaml,sha256=RJ9NpNbSJUMvzI0FYm5X3GViw_hVnXvu_3IlUV7K4-g,3780
+pyflightstream/commands/streamlines.yaml,sha256=X1Qk3urRFgianRUbe9kK62VbDiykIkAXACc3vV1YHEA,1835
+pyflightstream/commands/surface_sections.yaml,sha256=-Z5n6FBl-deQ_5_D4kVJ8bm9YgSSWG9TjX1X5c39UfU,4647
+pyflightstream/commands/sweeper.yaml,sha256=EGD12KKo929iRHbIuLF5IBcdXxtxAADGQLersjdkjUU,3021
+pyflightstream/commands/unsteady_solver.yaml,sha256=yXrJzkFiBlDRwEDJUUGSfAfY842_CrBX8_0CxChXFeU,2152
+pyflightstream/commands/volume_sections.yaml,sha256=C3mPokKBnTEYBIxUJTji_TatYAZe_6Rm09jtTr1gVeo,3892
+pyflightstream/farfield/__init__.py,sha256=6i4O1aT893Ufz_jQdmThGCf8I4Ead8jUVmI4Gw7Cb44,22317
+pyflightstream/files/__init__.py,sha256=QLQCKZZ0tkdI4LlXII_iDo4nYRfqu9gCXjsA1z3ru3M,13683
+pyflightstream/fsi/__init__.py,sha256=Pd8X4PHJXETlDdXqX6Zw-5A8Ms7Q5HWhL7znYclq50A,2534
+pyflightstream/fsi/beam.py,sha256=oHAv_L13-HomFTq0-i5YBuZDvsx1BsMoeEvoZUhECX8,16258
+pyflightstream/fsi/centrifugal.py,sha256=ucBsDQykuHZ2N9pNoel3Gkp8xZKCPf9TWdRq7ixXxkc,15137
+pyflightstream/fsi/cli.py,sha256=zcapJU7U9JR45Xv0eVRB5bLwj_y-mbINhDaejmUP0xU,8891
+pyflightstream/fsi/config.py,sha256=zDwEBF45yyFVEdQ_EhIVQCJMRzRuozfKMof6Lg6XcmM,13038
+pyflightstream/fsi/driver.py,sha256=bec89tHusOTVMcmTtb7xMI-6oWjaqVgXC76r2MX2p2Q,20390
+pyflightstream/fsi/kinematics.py,sha256=-SCgTss3Lw255V70KSbMWl0tze0scfXmTZeDEggJg2c,6166
+pyflightstream/fsi/loads.py,sha256=NLWGlGZaAaQHU6amjxnS2OcpAcFIKr8NDWC8ETktydk,30977
+pyflightstream/fsi/nodes.py,sha256=1U7z6Qi421vBkmHX8ILL-hdo550UqvaVzydrereFB2s,18922
+pyflightstream/fsi/state.py,sha256=0uNFLY3bx5KVITpEjE2VNmRfRPEgxpN2iF0IsfmYk-Q,6318
+pyflightstream/post/__init__.py,sha256=7uPjAeVmeFqCx54wnQ91xs-_2p_YRVdQgegCO_J8qMA,689
+pyflightstream/post/writers.py,sha256=a6qIWJlazcbCyfVFq7YOfm_BH-7z_WIs4w2x4Q_kGw8,6578
+pyflightstream/probes/__init__.py,sha256=XhI-Zg0rGNsowM2jnPxv4E4T0EdVDB7KuLg9LxO1BWk,17103
+pyflightstream/probes/geometry.py,sha256=cLl4ODkFmvm6IRTCYMSS5z1oq9QEy4rnna0_QeeT9Do,10676
+pyflightstream/probes/planar.py,sha256=ZfLZCxw0jcHnAdv6ndlNIUPyOYkqyDkhOPhfcUWWJmI,18626
+pyflightstream/qa/__init__.py,sha256=pUQVOQZi7UDw2elps3481EkSFzVmQfRmxf366NrRFVg,1555
+pyflightstream/qa/cli.py,sha256=OA5jtnwBvf4ZinWXX2iIzAkReA7Xqk09Uutv7WQq-Ko,12933
+pyflightstream/qa/compat.py,sha256=C1laPeX5Wid-FCZpIPPmgdDgEmx-Jypx-jVAN6YrlWc,10966
+pyflightstream/qa/drift.py,sha256=FtQhfp-ydxJk7dhkOML-jOvbtOVhFIHW4JDPZcvGe9o,14092
+pyflightstream/qa/geometry.py,sha256=ReSsf_xafFf2TzBD3WEcBvfb9Qwc4vDkyEouM4fQRgE,15819
+pyflightstream/qa/physics.py,sha256=OZsoxWXfsyMtxVaQw2P6JIL44-HRIBYEVZkZ-OK_US8,66198
+pyflightstream/qa/probes.py,sha256=oQDaux50BdLEZL6yVP1jkKiWewYUYHlp204QxQyOy0U,38373
+pyflightstream/qa/specs.py,sha256=jcmjluSUmo5ZJZwNUisP3qmZ31eJD70Yq2pOrurQ3OA,47679
+pyflightstream/qa/references/PHY-01.yaml,sha256=MraZQBksXoLDHYvHtMR-Tr9lUvdKogQSPsVbKyeQtYg,817
+pyflightstream/qa/references/PHY-02.yaml,sha256=zEuujBxgOYHH47kZB4oe3Dxp7PRPXWXjWHGBe-kkjAE,721
+pyflightstream/qa/references/PHY-05.yaml,sha256=h5xQsnDYbF1bCHF8tda3jiSLEE3dsG3ENlOIq_GQN-g,805
+pyflightstream/qa/references/PHY-06.yaml,sha256=sCZFupHP9fPeppecwkXpEhU8zTVM9YNtqgqNBNH1ghk,2209
+pyflightstream/qa/references/SMI-01.yaml,sha256=RjEpKGri327id_vsHNKeNtwHMvbXsYPKfQB6IC9nNj8,628
+pyflightstream/qa/references/SMI-02.yaml,sha256=Unu1pau3sCAf-30msOjch0BBIhLIyVH57cqbxG_4Tl8,650
+pyflightstream/results/__init__.py,sha256=10d2t-Q-WsihEdflI0IQo1TFH4P-mTr7h1OwzIfcCtQ,20882
+pyflightstream/run/__init__.py,sha256=gFkOJ4xlMkKgIQvkXYBiWMOVFzj9qccwtstAj2MJP_k,25683
+pyflightstream/script/__init__.py,sha256=ABAEbSLN6ZZhrImH2FFR6Czvmjwit0I2oUjnQkj1t7c,19139
+pyflightstream/script/helpers.py,sha256=ObhdaWV0I6KeyV4-vuomPZwwHP8s-obZXttdWZ0cxsg,32616
+pyflightstream-0.2.0.dist-info/licenses/LICENSE,sha256=7o5R7Nl3SszAFmZ8W9juTDjFOADLPELVBh8X6L7lpG0,1070
+pyflightstream-0.2.0.dist-info/METADATA,sha256=GUSBlMM7iV5ghHnUMvaUWHjTB6YTjsbOxQfyNd2bhg0,3408
+pyflightstream-0.2.0.dist-info/WHEEL,sha256=K260EYznzXsJYBQGqmI8VTxEdiZYNvDZwW9cBh9-_MA,91
+pyflightstream-0.2.0.dist-info/entry_points.txt,sha256=tsBrgOAZnvvIp5nXb7SSyq00asFdWEw2pHGJW9nwQFM,94
+pyflightstream-0.2.0.dist-info/top_level.txt,sha256=0zB1FRd9vtcgUePn_8UtSjfiHj-IViFq1GmGPtfyTco,15
+pyflightstream-0.2.0.dist-info/RECORD,,

pyflightstream-0.2.0.dist-info/WHEEL

@@ -0,0 +1,5 @@
+Wheel-Version: 1.0
+Generator: setuptools (83.0.0)
+Root-Is-Purelib: true
+Tag: py3-none-any
+

pyflightstream-0.2.0.dist-info/entry_points.txt

@@ -0,0 +1,3 @@
+[console_scripts]
+pyfs-fsi = pyflightstream.fsi.cli:main
+pyfs-qa = pyflightstream.qa.cli:main

pyflightstream-0.2.0.dist-info/licenses/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2026 Geovana Neves
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

pyflightstream-0.2.0.dist-info/top_level.txt

@@ -0,0 +1 @@
+pyflightstream