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.2.tar.gz (46.9 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.2-py3-none-any.whl (52.7 kB view details)

Uploaded Python 3

File details

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

File metadata

  • Download URL: similarity_bl-0.1.2.tar.gz
  • Upload date:
  • Size: 46.9 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.2.tar.gz
Algorithm Hash digest
SHA256 4af3b6cb6e425d6146471976dcc00e0768d7d94a4bb20aaa65e82a12fdac7b06
MD5 ceae722291ee5fb3546b53d0eb259a2f
BLAKE2b-256 1f788ba1ba85f89096fa8d96fca1ffc82897940bba53f9d94cee357ff1c6c27a

See more details on using hashes here.

Provenance

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

File metadata

  • Download URL: similarity_bl-0.1.2-py3-none-any.whl
  • Upload date:
  • Size: 52.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.1.2-py3-none-any.whl
Algorithm Hash digest
SHA256 e8fe598671d6ec4e14fec7f2b972a155977a564968c118f6a59741d06b81a7df
MD5 2699555a330cfdaf733d69d5aee5adaa
BLAKE2b-256 ab9b3a8017146ca814e4570698b175138375dc8d39f9b98e3a13b1af8aee706c

See more details on using hashes here.

Provenance

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