OpenFLASH ⚡️
Open-source Flexible Library for Analytical and Semi-analytical Hydrodynamics
About The OpenFLASH Project
The OpenFLASH project is a Python package designed for solving hydrodynamic boundary value problems using eigenfunction expansion methods. It provides a modular framework for defining complex geometries, setting up multi-domain problems, performing numerical computations, and analyzing results, particularly for linear potential flow hydrodynamics. It can be significantly faster than Boundary Element Method calculations although is restricted to certain geometries (currently axisymmetric compound cylinders).
When referencing this work, please reference our citation.cff.
This project is licensed under the MIT License. See the LICENSE file for details.
Installation
Three common installation options are shown below. For more details, see the installation section of the docs.
Option 1: via pypi (recommended for users who manage environments with venv or similar)
pip install open-flash
Option 2: via conda (recommended for users who manage environments with conda)
conda create -n openflash-env sea-lab::open-flash
conda activate openflash-env
Option 3: via git (recommended for developers)
Note - if you are a developer outside of the SEA Lab, please create a fork and clone your fork.
- Clone the repository:
git clone https://github.com/symbiotic-engineering/OpenFLASH.git
cd OpenFLASH
- Install the package:
pip install -e .
- Install dependencies:
pip install -e .[dev]
Usage
Please see our documentation and tutorial notebook. The documentation provides detailed instructions and API reference for the different modules and classes within the openflash package.
If you prefer not to utilize the package programatically, the model can also be run with an interactive web app (the site may take several seconds to load).
Theory
Please see our equations documentation and references for mathematical background and derivations as well as validation information.
MATLAB
We also have a MATLAB code version, although the Python package is intended as primary for future development. MATLAB only supports bodies consisting of 2 concentric cylinders, rather than the arbitrary N concentric cylinders in the Python package.
See matlab/src/run_MEEM.m for the symbolic and numeric code, see matlab/test/ for some scripts to get results, and matlab/dev for various matlab experiments.
2 maintainers
Metadata
2 maintainers
Release files for open-flash 1.0.42
For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.
Source distribution (sdist)
| File | Size | Uploaded | Provenance | Actions |
|---|---|---|---|---|
| open_flash-1.0.42.tar.gz | 2.0 MB | With provenance | Details for open_flash-1.0.42.tar.gz |
Built distribution (wheel)
| File | Interpreter | ABI | Platform | Actions Reset |
|---|---|---|---|---|
| open_flash-1.0.42-py3-none-any.whl | Python 3 | none | any | Details for open_flash-1.0.42-py3-none-any.whl |
Total release size: 2.0 MB
Release files / open_flash-1.0.42.tar.gz
| Download URL | open_flash-1.0.42.tar.gz |
|---|---|
| Size | 2.0 MB |
| Tags | Source |
|
SHA-256 checksum How to use checksums |
2ea9ed758a96851d9732789e3b96b066491662d2b5ab7017e85e21f74a892840
|
|
BLAKE2b-256 checksum How to use checksums |
4e082ac38cbf7dec3cd4c1ef71278e82b7abf892537ef57c612abae59ffaaf8d
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
Yes |
| Uploaded via |
twine/7.0.0 CPython/3.13.16
|
Provenance
Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.
PyPI Publish Attestation
PyPI verified that this artifact, at this checksum, originated from the publisher listed below.
Signed by GitHub Actions, verified by PyPI on Oct 29, 2026.
Transparency logRelease files / open_flash-1.0.42-py3-none-any.whl
| Download URL | open_flash-1.0.42-py3-none-any.whl |
|---|---|
| Size | 38.6 kB |
| Tags | Python 3 |
|
SHA-256 checksum How to use checksums |
30c30b4e6598b6bebf5e57ce544544c01068b20a022b00951d2610cdcd2920a7
|
|
BLAKE2b-256 checksum How to use checksums |
a705df5c424c79f24e59d5c5c758602789d7991957e243088bdd53c2c8d4cfdd
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
Yes |
| Uploaded via |
twine/7.0.0 CPython/3.13.16
|
Provenance
Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.
PyPI Publish Attestation
PyPI verified that this artifact, at this checksum, originated from the publisher listed below.
Signed by GitHub Actions, verified by PyPI on Oct 29, 2026.
Transparency logSecurity for open-flash 1.0.42
Provenance
Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.
Full provenance
Both files in this release have been uploaded with provenance metadata.
Attestation for open_flash-1.0.42.tar.gz
PyPI Publish Attestation
PyPI verified that this artifact, at this checksum, originated from the publisher listed below.
Signed by GitHub Actions, verified by PyPI on Oct 29, 2026.
Transparency logA note on package security
PyPI is a repository for distributing packages, not a service for auditing them. While third-party security researchers and our staff do their best to detect and remove malicious packages, PyPI cannot guarantee the quality, security or suitability of any given package.
To learn more about protecting yourself from malicious actors, visit our package security documentation.
