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.0.tar.gz (41.1 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.0-py3-none-any.whl (51.2 kB view details)

Uploaded Python 3

File details

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

File metadata

  • Download URL: similarity_bl-0.1.0.tar.gz
  • Upload date:
  • Size: 41.1 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.0.tar.gz
Algorithm Hash digest
SHA256 ed85ab475b18198c7d546a794889af56c25c0dcfb837d88b4c6401aac352dd92
MD5 4b186047f997a34f4b2923bb2da8bee4
BLAKE2b-256 13b82eeb5ccec51b712e846c57090845cc8888a9af8af524a8c139bd7430d975

See more details on using hashes here.

Provenance

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

File metadata

  • Download URL: similarity_bl-0.1.0-py3-none-any.whl
  • Upload date:
  • Size: 51.2 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.0-py3-none-any.whl
Algorithm Hash digest
SHA256 08d6ebde5d0441718a01670b340e0ab82af488e7a67590d5a657f5646c220feb
MD5 3459860785315a47796660603c63e0cc
BLAKE2b-256 285ecb821373ed4e45addd7966d43e1399017ab210f199706c9b5dd7b94af659

See more details on using hashes here.

Provenance

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