Skip to main content

pyflightstream

ci PyPI DOI

Version-aware Python driver for the FlightStream panel-method solver: write a run matrix, and pyflightstream plans, runs and post-processes every point, from your workstation or a cluster. MIT licensed.

Status: v0.31.0 is the current release; CHANGELOG.md carries the history.

Documentation: nevesgeovana.github.io/pyflightstream

What it does

matrix  ->  plan  ->  run  ->  collect  ->  post  ->  products
(.fs)       (free,     (local     (cluster     (polars, rotor tables,
            no solver) or HPC)    jobs)        sections, averages, provenance)
  • One row, one simulation. A pipe-separated matrix names each case, its flight condition, its sweep and the input artifacts it uses (reference, setup, post-processing).
  • Checked before it costs a licence. plan builds every script without the solver and refuses what the target FlightStream build cannot run, with the reason.
  • Every command has evidence. Each solver command is validated against a per-version database; every entry cites a manual page or a committed probe report.
  • Products you open directly. CSV polars, rotor coefficient tables, sections, probes and time averages, each stating the flight condition it belongs to, plus a provenance record per run.

Install

pip install "pyflightstream[geom,fsi,plot,excel]"

Python 3.12 or newer. FlightStream itself is licensed separately and is located through your workspace, never guessed.

Quick start

pyfs-workspace init my-study            # the workspace tree and input folders
cd my-study                             # add a geometry, a matrix, a reference, a setup
pyfs-matrix plan matriz.fs              # zero solver time: what will run, what is refused
pyfs-matrix run matriz.fs               # runs every READY point
pyfs-matrix post --workspace .          # rebuilds the products from the records

Getting started walks a first workspace file by file, and From the GUI to pyfs maps each GUI step to the key that takes it here.

Command-line tools

Tool What it is for
pyfs-workspace Create a workspace; archive a simulation; reorganise the geometry library
pyfs-matrix Plan, run, collect and post a run matrix; storage (space-in-use, free-space, delete-sims) and sync between workspaces
pyfs-qa Command-validity probes and physics regression on a licensed machine
pyfs-fsi The structural executable of the aeroelastic coupling loop
pyfs-manual Maintainer tool: compare FlightStream manuals with the command database

Capability status

Capability Status
Command database, script builder, version refusals supported
Parsers, tables, run manifest, reconstruction supported
Campaigns, run matrices, workspace, pre-flight supported
Far-field ledgers and probe surveys experimental
FSI structural beam and modal analysis experimental (examples/wing_static_deflection.py, examples/fsi_campbell_diagram.py)
FSI coupled driver (the four-phase loop) experimental: offline replay only, never run against a live solver in CI
Rotary two-way coupling not validated

Experimental means the interface may change without a deprecation window, and the evidence behind it is narrower than for the supported rows.

Supported FlightStream versions

Version Vendor name Support level
25.000 25.0 documented
25.100 25.1 documented
26.000 26.0 documented
26.100 26.1 operational
26.101 26.1 operational
26.120 26.12 operational
26.121 26.12 operational
26.122 26.12 operational
26.123 26.12 operational
26.124 26.12 operational

operational means the minimal geometry-to-loads workflow builds for that version, checked by a test; documented means the manual has been read but nothing has been measured on the build yet. The details, and how to tell which build you have, are on Which build do I have:

import pyflightstream

for row in pyflightstream.support_table():
    print(row.summary)

Contributing

pip install -e .[dev,fsi,geom]
pre-commit install
pytest

The hard invariants are in CONTRIBUTING.md. Tier 1 runs anywhere; tiers 2 and 3 need a licensed FlightStream and are described in the test tiers.

Citing and license

Cite the release you used through its Zenodo DOI (CITATION.cff). MIT licensed; contributions must be original or MIT-compatible, and code derived from the AGPL pyFlightscript package is not accepted.

Metadata

Release files for pyflightstream 0.31.0

For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.

Source distribution (sdist)

Source distribution for pyflightstream 0.31.0
File Size Uploaded Provenance
pyflightstream-0.31.0.tar.gz 1.9 MB With provenance Details

Built distribution (wheel)

Table of built distributions (wheels) for pyflightstream 0.31.0
File Interpreter ABI Platform
pyflightstream-0.31.0-py3-none-any.whl Python 3 none any Details

Total release size: 4.0 MB

Release files / pyflightstream-0.31.0.tar.gz

Download URL pyflightstream-0.31.0.tar.gz
Size 1.9 MB
Tags Source
SHA-256 checksum
How to use checksums
a772244bfce66b22c9714aca5133d96c86fc3fe514b497039752319118624401
BLAKE2b-256 checksum
How to use checksums
f538d26c7702097bcbacbc6cebadad669a3f579976a12f64c718b7393ecf0a2a
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
Yes
Uploaded via twine/7.0.0 CPython/3.13.14

Provenance

Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.

PyPI Publish Attestation

PyPI verified that this artifact, at this checksum, originated from the publisher listed below.

Signed by GitHub Actions, verified by PyPI on Sep 29, 2026.

Transparency log

Release files / pyflightstream-0.31.0-py3-none-any.whl

Download URL pyflightstream-0.31.0-py3-none-any.whl
Size 2.0 MB
Tags Python 3
SHA-256 checksum
How to use checksums
9f077175b184afcd5250ffe0a8a965ea647cf6c6f02255f8522010eac8cdbca5
BLAKE2b-256 checksum
How to use checksums
b6320dc8b147148723fc088d6b61ed4da683a7237eb0f5a6a9253076e5fb9de8
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
Yes
Uploaded via twine/7.0.0 CPython/3.13.14

Provenance

Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.

PyPI Publish Attestation

PyPI verified that this artifact, at this checksum, originated from the publisher listed below.

Signed by GitHub Actions, verified by PyPI on Sep 29, 2026.

Transparency log

Security for pyflightstream 0.31.0

Provenance

Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.

Full provenance

All 2 files in this release have been uploaded with provenance metadata.

Select from 2 files

Attestation for pyflightstream-0.31.0.tar.gz

PyPI Publish Attestation

PyPI verified that this artifact, at this checksum, originated from the publisher listed below.

Signed by GitHub Actions, verified by PyPI on Sep 29, 2026.

Transparency log

A note on package security

PyPI is a repository for distributing packages, not a service for auditing them. While third-party security researchers and our staff do their best to detect and remove malicious packages, PyPI cannot guarantee the quality, security or suitability of any given package.

To learn more about protecting yourself from malicious actors, visit our package security documentation.

Release history Release notifications | RSS feed

This release

0.31.0 This release

2 release files Full provenance

Anthropic, PBC Visionary sponsor Bloomberg Visionary sponsor Hudson River Trading Visionary sponsor Meta Visionary sponsor NVIDIA Visionary sponsor Microsoft Sustainability sponsor Depot Continuous Integration AWS Cloud computing and Security Sponsor Datadog Monitoring Fastly CDN Google Download Analytics Sentry Error logging StatusPage Status page