BuffaloPanel 0.2.0

Structured 2D panel-method tools for aerodynamic case setup, solution, and post-processing.

Buffalo Panel

Buffalo Panel is an early-stage Python library for structured 2D panel-method workflows in aerodynamics. It currently focuses on case definition, solving, and post-processing for panelized airfoil problems, with small CLI, GUI, and TUI applications built around the same structured case schema.

What It Can Do Today

• Define simulation cases with typed Python dataclasses and YAML or JSON files.
• Load structured airfoil cases and solve the current 2D Hess-Smith workflow.
• Save solved artifacts for later inspection and post-processing.
• Export integrated coefficients and optional surface-quantity CSV data.
• Explore element influence fields and diagnostic views through example scripts.
• Reuse shared Buffalo ecosystem foundations such as numeric typing, diagnostics, and Buffalo Wings airfoil definitions.

How The Apps Fit Together

Buffalo Panel currently treats the structured case file as the source of truth.

• panel2d_tui helps browse and edit the case structure in a terminal UI.
• panel2d_gui provides a tree-based editor plus interactive geometry, surface, and flow-field views.
• panel2d_cli run solves one case file and writes one solved artifact.
• panel2d_cli inspect reviews artifact metadata and can reconstruct integrated results from the command line.

The normal workflow is:

1. Create or edit a case file.
2. Run the case to produce a solved artifact.
3. Inspect the artifact in the CLI or load it in the GUI for exploration.

Installation

Install from PyPI:

pip install BuffaloPanel

For local development with the repository-managed toolchain:

uv sync --extra docs

Quick Start

Run one of the packaged examples from the repository root:

panel2d_cli run examples/naca0012_designation.yaml
panel2d_cli inspect examples/naca0012_designation.solution.yaml --include-results

You can also use the Python API directly:

from buffalo_panel.config import load_panel_case, solve_panel_case

case = load_panel_case("examples/naca0012_designation.yaml")
results = solve_panel_case(case)

print(results.integrated.cl_pressure)

Documentation

The main documentation lives at buffaloherd.codeberg.page/BuffaloPanelDocs. Useful starting points are:

• Getting started
• First case workflow
• App workflow overview
• Project status
• CLI reference
• Examples
• API reference

Project Status

The library and apps are still in early development. The core structured-case workflow and the current 2D Hess-Smith and lumped-vortex paths are usable, but the public API and app behavior should still be expected to change as the project grows.

Contributing

Contributions, issue reports, and documentation improvements are welcome. See the contributing guide for development setup and workflow notes.

License

Buffalo Panel is released under the GNU General Public License v3.0 only.