Skip to main content

Compressible similarity boundary layer solver with Lees-Dorodnitsyn transformation

Project description

simbl

Compressible similarity boundary layer solver with Falkner-Skan and Falkner-Skan-Cooke support.

Test DOI PyPI Docs License Python Ruff

Install

pip install similarity-bl

Quick Start

API:

from simbl import SimilarityInputs, SolverOptions, solve_similarity

inputs = SimilarityInputs(mach_edge=6.0, temp_edge=55.0, wall_bc="adiabatic")
options = SolverOptions()

solution, info = solve_similarity(inputs, options)
print(f"f''(0) = {solution.fpp[0]:.6f}")
print(f"g(0)   = {solution.g[0]:.6f}")

CLI:

simbl init                   # generate a template config file
simbl solve config.toml      # solve from config
simbl solve --mach 6.0 --temp-edge 55.0 --wall adiabatic

Documentation

Full documentation: https://uahypersonics.github.io/similarity-bl

Citation

If you use simbl in your research, please cite it:

@software{simbl,
  author = {Hader, Christoph},
  title = {simbl: Compressible Similarity Boundary Layer Solver},
  url = {https://github.com/uahypersonics/similarity-bl},
  year = {2026}
}

Validation and Verification

Reproducible VnV cases comparing simbl against independent reference data are in vnv/.

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 Code formatting, naming, whitespace Python standard style guide
PEP 257 Docstring structure (triple-quoted, imperative mood) Python standard docstring conventions
numpydoc Docstring sections (Parameters, Returns, Attributes) NumPy/SciPy docstring standard — the norm for scientific Python
Ruff Automated linting and formatting Enforces PEP 8 compliance automatically
typing / TYPE_CHECKING Type hints for IDE support and static analysis Python standard library

Releasing

This project uses Semantic Versioning (vMAJOR.MINOR.PATCH):

  • MAJOR (v1.0.0, v2.0.0): Breaking API changes
  • MINOR (v0.3.0, v0.4.0): New features, backward-compatible
  • PATCH (v0.3.1, v0.3.2): Bug fixes, minor corrections

To publish a new version to PyPI:

  1. Commit and push to main
  2. Tag and push:
    git tag -a vMAJOR.MINOR.PATCH -m "Release vMAJOR.MINOR.PATCH"
    git push origin vMAJOR.MINOR.PATCH
    

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

similarity_bl-0.3.0.tar.gz (1.3 MB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

similarity_bl-0.3.0-py3-none-any.whl (59.7 kB view details)

Uploaded Python 3

File details

Details for the file similarity_bl-0.3.0.tar.gz.

File metadata

  • Download URL: similarity_bl-0.3.0.tar.gz
  • Upload date:
  • Size: 1.3 MB
  • Tags: Source
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/6.1.0 CPython/3.13.12

File hashes

Hashes for similarity_bl-0.3.0.tar.gz
Algorithm Hash digest
SHA256 66637ba865f24b81f5c0fd1cc0ec7d678de69df2e3ff14410e56f510f381e7b1
MD5 7172dec42ea2f34d553d1c495dcc5fa7
BLAKE2b-256 e4fd2e4b8202d757c506373a7edfd0e38dd654eb5ae88c4bfe8e57642b78e2d0

See more details on using hashes here.

Provenance

The following attestation bundles were made for similarity_bl-0.3.0.tar.gz:

Publisher: publish.yml on uahypersonics/similarity-bl

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

File details

Details for the file similarity_bl-0.3.0-py3-none-any.whl.

File metadata

  • Download URL: similarity_bl-0.3.0-py3-none-any.whl
  • Upload date:
  • Size: 59.7 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/6.1.0 CPython/3.13.12

File hashes

Hashes for similarity_bl-0.3.0-py3-none-any.whl
Algorithm Hash digest
SHA256 6ee1b8b85450023f4de1ae85a31460b1f5f2743e5b3d434095c200e4478b4c81
MD5 eb58c35cf08a179d4ef27e0c45ab6b6c
BLAKE2b-256 e3c292cab4305645da3df3cfe4fc9cd0a5dfd389029cdfe715786fec10e1551f

See more details on using hashes here.

Provenance

The following attestation bundles were made for similarity_bl-0.3.0-py3-none-any.whl:

Publisher: publish.yml on uahypersonics/similarity-bl

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page