flow-inviscid 0.1.0__py3-none-any.whl

flow_inviscid/__init__.py

@@ -0,0 +1,18 @@
+"""flow-inviscid: inviscid supersonic and hypersonic surface solutions.
+
+Stub release v0.1.0 -- no modules implemented yet.
+"""
+
+# --------------------------------------------------
+# load version
+# --------------------------------------------------
+from __future__ import annotations
+
+from importlib.metadata import PackageNotFoundError, version
+
+try:
+    __version__ = version("flow-inviscid")
+except PackageNotFoundError:
+    __version__ = "unknown"
+
+__all__ = ["__version__"]

flow_inviscid/cli/__init__.py

@@ -0,0 +1,11 @@
+"""Command-line interface package for flow-inviscid."""
+
+# --------------------------------------------------
+# package imports
+# --------------------------------------------------
+from flow_inviscid.cli.app import cli
+
+# --------------------------------------------------
+# public api
+# --------------------------------------------------
+__all__ = ["cli"]

flow_inviscid/cli/app.py

@@ -0,0 +1,100 @@
+"""Typer application for the flow-inviscid command-line interface."""
+
+# --------------------------------------------------
+# load necessary modules
+# --------------------------------------------------
+from __future__ import annotations
+
+import logging
+import sys
+from typing import Annotated
+
+import typer
+
+from flow_inviscid.cli.cmd_newtonian import cmd_newtonian
+from flow_inviscid.cli.cmd_shock_expansion import cmd_shock_expansion
+
+# --------------------------------------------------
+# package imports
+# --------------------------------------------------
+from flow_inviscid.cli.cmd_tangent_cone import cmd_tangent_cone
+
+# --------------------------------------------------
+# set up typer app
+# --------------------------------------------------
+cli = typer.Typer(
+    name="flow-inviscid",
+    help="flow-inviscid: inviscid surface conditions for supersonic and hypersonic bodies",
+    no_args_is_help=True,
+    add_completion=False,
+)
+
+
+# --------------------------------------------------
+# version callback
+# --------------------------------------------------
+def _version_callback(value: bool) -> None:
+    """Print version and exit."""
+    if value:
+        from flow_inviscid import __version__
+        typer.echo(f"flow-inviscid {__version__}")
+        raise typer.Exit()
+
+
+# --------------------------------------------------
+# main callback
+# --------------------------------------------------
+@cli.callback()
+def main(
+    ctx: typer.Context,
+    version: Annotated[
+        bool | None,
+        typer.Option(
+            "--version",
+            "-V",
+            help="Show version and exit.",
+            callback=_version_callback,
+            is_eager=True,
+        ),
+    ] = None,
+    verbose: Annotated[
+        bool,
+        typer.Option("--verbose", "-v", help="Enable informational output."),
+    ] = False,
+) -> None:
+    """flow-inviscid: inviscid surface conditions for supersonic and hypersonic bodies."""
+
+    # store verbose flag in context for access by subcommands
+    ctx.ensure_object(dict)
+    ctx.obj["verbose"] = verbose
+
+    # configure logging if verbose is requested
+    if verbose:
+        logger = logging.getLogger("flow_inviscid")
+        logger.setLevel(logging.INFO)
+
+        # attach a stderr handler; guard prevents duplicates
+        has_stream_handler = any(
+            isinstance(h, logging.StreamHandler) and not isinstance(h, logging.FileHandler)
+            for h in logger.handlers
+        )
+        if not has_stream_handler:
+            handler = logging.StreamHandler(sys.stderr)
+            handler.setLevel(logging.INFO)
+            handler.setFormatter(logging.Formatter("[%(levelname)-7s] %(name)s: %(message)s"))
+            logger.addHandler(handler)
+
+
+# --------------------------------------------------
+# command registration
+# --------------------------------------------------
+cli.command("tangent-cone",    no_args_is_help=True)(cmd_tangent_cone)
+cli.command("newtonian",       no_args_is_help=True)(cmd_newtonian)
+cli.command("shock-expansion", no_args_is_help=True)(cmd_shock_expansion)
+
+
+# --------------------------------------------------
+# entry point
+# --------------------------------------------------
+if __name__ == "__main__":
+    cli()

flow_inviscid/cli/cmd_newtonian.py

@@ -0,0 +1,12 @@
+"""CLI handler for ``flow-inviscid newtonian``."""
+
+from __future__ import annotations
+
+import typer
+
+
+def cmd_newtonian() -> None:
+    """Modified Newtonian surface conditions (not yet implemented)."""
+    typer.echo("Not implemented yet.", err=True)
+    raise typer.Exit(1)
+

flow_inviscid/cli/cmd_shock_expansion.py

@@ -0,0 +1,12 @@
+"""CLI handler for ``flow-inviscid shock-expansion``."""
+
+from __future__ import annotations
+
+import typer
+
+
+def cmd_shock_expansion() -> None:
+    """Shock-expansion surface conditions (not yet implemented)."""
+    typer.echo("Not implemented yet.", err=True)
+    raise typer.Exit(1)
+

flow_inviscid/cli/cmd_tangent_cone.py

@@ -0,0 +1,12 @@
+"""CLI handler for ``flow-inviscid tangent-cone``."""
+
+from __future__ import annotations
+
+import typer
+
+
+def cmd_tangent_cone() -> None:
+    """Tangent-cone surface conditions (not yet implemented)."""
+    typer.echo("Not implemented yet.", err=True)
+    raise typer.Exit(1)
+

flow_inviscid-0.1.0.dist-info/METADATA

@@ -0,0 +1,90 @@
+Metadata-Version: 2.4
+Name: flow-inviscid
+Version: 0.1.0
+Summary: Inviscid supersonic and hypersonic surface solutions: Taylor-Maccoll, Newtonian, tangent-cone, shock-expansion
+Author-email: Christoph Hader <chader@arizona.edu>
+License: BSD-3-Clause
+Project-URL: Homepage, https://github.com/uahypersonics/flow-inviscid
+Project-URL: Repository, https://github.com/uahypersonics/flow-inviscid
+Keywords: aerodynamics,hypersonics,inviscid,taylor-maccoll,newtonian
+Classifier: Development Status :: 1 - Planning
+Classifier: Intended Audience :: Science/Research
+Classifier: License :: OSI Approved :: BSD License
+Classifier: Programming Language :: Python :: 3
+Classifier: Topic :: Scientific/Engineering :: Physics
+Requires-Python: >=3.11
+Description-Content-Type: text/markdown
+License-File: LICENSE
+Requires-Dist: numpy>=1.24.0
+Requires-Dist: scipy>=1.10.0
+Requires-Dist: typer>=0.9.0
+Provides-Extra: dev
+Requires-Dist: pytest>=7.0; extra == "dev"
+Requires-Dist: ruff>=0.1.0; extra == "dev"
+Requires-Dist: zensical; extra == "dev"
+Dynamic: license-file
+
+# flow-inviscid
+
+Computes inviscid surface Mach number, pressure, and temperature along a body
+contour using classical methods such as tangent-cone, tangent-wedge, Modified
+Newtonian, shock-expansion, method of characteristics, and linearized supersonic.     
+
+[![PyPI](https://img.shields.io/pypi/v/flow-inviscid)](https://pypi.org/project/flow-inviscid/)
+[![Docs](https://img.shields.io/badge/docs-zensical-blue)](https://uahypersonics.github.io/flow-inviscid/)
+[![License](https://img.shields.io/badge/License-BSD_3--Clause-blue.svg)](LICENSE)
+[![Python](https://img.shields.io/badge/python-%E2%89%A53.11-blue.svg)](https://www.python.org/downloads/)
+[![Ruff](https://img.shields.io/endpoint?url=https://raw.githubusercontent.com/astral-sh/ruff/main/assets/badge/v2.json)](https://github.com/astral-sh/ruff)
+
+## Install
+
+```bash
+pip install flow-inviscid
+```
+
+## Quick Start
+
+under construction
+
+## Documentation
+
+## Validation and Verification
+
+under construction
+
+## Code Style
+
+This project follows established Python community conventions so that
+contributors can focus on the physics rather than inventing formatting rules.
+
+| Convention | What it covers | Reference |
+|---|---|---|
+| [PEP 8](https://peps.python.org/pep-0008/) | Code formatting, naming, whitespace | Python standard style guide |
+| [PEP 257](https://peps.python.org/pep-0257/) | Docstring structure | Python standard docstring conventions |
+| [numpydoc](https://numpydoc.readthedocs.io/en/latest/format.html) | Docstring sections (`Parameters`, `Returns`, `Attributes`) | NumPy/SciPy docstring standard |
+| [Ruff](https://docs.astral.sh/ruff/) | Automated linting and formatting | Enforces PEP 8 compliance automatically |
+
+## Releasing
+
+This project uses [Semantic Versioning](https://semver.org/) (`vMAJOR.MINOR.PATCH`):
+
+- **MAJOR** (`v1.0.0`): Breaking API changes
+- **MINOR** (`v0.3.0`): New features, backward-compatible
+- **PATCH** (`v0.3.1`): Bug fixes
+
+To publish a new version:
+
+1. Verify locally:
+   ```bash
+   ruff check .
+   pytest
+   ```
+2. Commit and push to `main`
+3. Tag and push:
+   ```bash
+   git tag -a vMAJOR.MINOR.PATCH -m "Release vMAJOR.MINOR.PATCH"
+   git push origin vMAJOR.MINOR.PATCH
+   ```
+
+## Citation
+

flow_inviscid-0.1.0.dist-info/RECORD

@@ -0,0 +1,14 @@
+flow_inviscid/__init__.py,sha256=JSluizIKOUJRnVfziSlbAaPOHPMsDbG8E9dW01b3AjU,480
+flow_inviscid/cli/__init__.py,sha256=NaWRkyRH053xXwQ6OiAKTOUjfEoQPCvcvCvLK1u2lJk,357
+flow_inviscid/cli/app.py,sha256=hZU1DIA3uEUdrj47PAq-5Cn6SYjq2KN7UhvgbDaWTII,3222
+flow_inviscid/cli/cmd_newtonian.py,sha256=dEYGi59HmESlXrZUJZCJw-YFK2cgD2lVpSXQ9P9fLL8,277
+flow_inviscid/cli/cmd_shock_expansion.py,sha256=fNvJVNu35Awyk5TQa_d6qbEKm_GN9WlDHLMQwif5-Go,286
+flow_inviscid/cli/cmd_tangent_cone.py,sha256=jV8t3rpy15oMi8BCrDH7YEFD9QrYO_lCdQKyB5hf0GM,277
+flow_inviscid-0.1.0.dist-info/licenses/LICENSE,sha256=3UbyOgPeUUDwRiy_Xw1601ZvsOp6tRb38obYvKl4xuw,1500
+flow_inviscid-0.1.0.dist-info/METADATA,sha256=XtTWLrFV7rLu8sxhOmrt45VkgmoS5hOHsQ5uXyW9KMg,3262
+flow_inviscid-0.1.0.dist-info/WHEEL,sha256=K260EYznzXsJYBQGqmI8VTxEdiZYNvDZwW9cBh9-_MA,91
+flow_inviscid-0.1.0.dist-info/entry_points.txt,sha256=gEWfXEZk2XFoqeKt9Mt6rn7hKriW7uLM650MuqWI04A,56
+flow_inviscid-0.1.0.dist-info/scm_file_list.json,sha256=F6i9WJ_CVEo8LI4kSzGU6vSTum0M0h0OGyci6ijuaY8,569
+flow_inviscid-0.1.0.dist-info/scm_version.json,sha256=87mUwkLT-F8PqGC_nIwarXrWXZT0qoQ7Gm94o-ekcBU,160
+flow_inviscid-0.1.0.dist-info/top_level.txt,sha256=gQCqpQXSxDgGYw8D0vZPeJLrUZFWqDsczk7fEszTPPQ,14
+flow_inviscid-0.1.0.dist-info/RECORD,,

flow_inviscid-0.1.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
+

flow_inviscid-0.1.0.dist-info/entry_points.txt

@@ -0,0 +1,2 @@
+[console_scripts]
+flow-inviscid = flow_inviscid.cli:cli

flow_inviscid-0.1.0.dist-info/licenses/LICENSE

@@ -0,0 +1,28 @@
+BSD 3-Clause License
+
+Copyright (c) 2026, uahypersonics
+
+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.

flow_inviscid-0.1.0.dist-info/scm_file_list.json

@@ -0,0 +1,22 @@
+{
+  "files": [
+    "CITATION.cff",
+    "README.md",
+    "LICENSE",
+    "pyproject.toml",
+    "mkdocs.yml",
+    "CONTRIBUTING.md",
+    ".gitignore",
+    "docs/installation.md",
+    "docs/index.md",
+    "docs/javascripts/mathjax.js",
+    "src/flow_inviscid/__init__.py",
+    "src/flow_inviscid/cli/cmd_newtonian.py",
+    "src/flow_inviscid/cli/__init__.py",
+    "src/flow_inviscid/cli/cmd_shock_expansion.py",
+    "src/flow_inviscid/cli/app.py",
+    "src/flow_inviscid/cli/cmd_tangent_cone.py",
+    ".github/workflows/docs.yml",
+    ".github/workflows/publish.yml"
+  ]
+}

flow_inviscid-0.1.0.dist-info/scm_version.json

@@ -0,0 +1,8 @@
+{
+  "tag": "0.1.0",
+  "distance": 0,
+  "node": "gc70194da186a78b90e8f8dbd9735e322fb8f9339",
+  "dirty": false,
+  "branch": "HEAD",
+  "node_date": "2026-07-08"
+}

flow_inviscid-0.1.0.dist-info/top_level.txt

@@ -0,0 +1 @@
+flow_inviscid