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 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}
}

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.1.3.tar.gz (46.8 kB 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.1.3-py3-none-any.whl (52.6 kB view details)

Uploaded Python 3

File details

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

File metadata

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

File hashes

Hashes for similarity_bl-0.1.3.tar.gz
Algorithm Hash digest
SHA256 a22d8a2e3f3bb27af96e1fe54bed4b6616c07195350d8e3ca9a901e75b0942db
MD5 e1d10572fa51d370e47298da90831d7c
BLAKE2b-256 db44bf81443486a2f3f81dbef107d7ffb704a762e687fc69944dbf1b8961bcf0

See more details on using hashes here.

Provenance

The following attestation bundles were made for similarity_bl-0.1.3.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.1.3-py3-none-any.whl.

File metadata

  • Download URL: similarity_bl-0.1.3-py3-none-any.whl
  • Upload date:
  • Size: 52.6 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.1.3-py3-none-any.whl
Algorithm Hash digest
SHA256 573e9a66b05347ca284eb630b488c3e83bd28642077f70aac99ec865f02fd9a2
MD5 1411bc2a453df1670d027ec56c1d2788
BLAKE2b-256 e8e395ad257d4019053070807465af4a1b3f9d815d5d1deb7e45f81f1e1a6341

See more details on using hashes here.

Provenance

The following attestation bundles were made for similarity_bl-0.1.3-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