flow-props 0.1.0__tar.gz → 0.2.1__tar.gz
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- {flow_props-0.1.0 → flow_props-0.2.1}/.github/workflows/docs.yml +8 -6
- flow_props-0.2.1/.github/workflows/package.yml +41 -0
- flow_props-0.2.1/.github/workflows/publish.yml +86 -0
- flow_props-0.2.1/.github/workflows/test.yml +45 -0
- {flow_props-0.1.0 → flow_props-0.2.1}/.gitignore +4 -0
- flow_props-0.2.1/.vscode/settings.json +9 -0
- flow_props-0.2.1/CITATION.cff +17 -0
- flow_props-0.2.1/LICENSE +674 -0
- {flow_props-0.1.0 → flow_props-0.2.1}/PKG-INFO +45 -14
- {flow_props-0.1.0 → flow_props-0.2.1}/README.md +31 -8
- flow_props-0.2.1/docs/api/architecture.md +39 -0
- flow_props-0.2.1/docs/api/boundary-layer.md +29 -0
- flow_props-0.2.1/docs/api/entropy-layer.md +21 -0
- flow_props-0.2.1/docs/api/index.md +22 -0
- flow_props-0.2.1/docs/api/profiles.md +26 -0
- flow_props-0.2.1/docs/api/shock.md +45 -0
- flow_props-0.2.1/docs/api/wall.md +21 -0
- flow_props-0.2.1/docs/cli-reference/index.md +5 -0
- {flow_props-0.1.0 → flow_props-0.2.1}/docs/examples.md +1 -1
- flow_props-0.2.1/docs/index.md +51 -0
- flow_props-0.2.1/docs/installation.md +48 -0
- flow_props-0.2.1/docs/nomenclature.md +24 -0
- flow_props-0.2.1/docs/theory/boundary-layer.md +61 -0
- flow_props-0.2.1/docs/theory/entropy-layer.md +29 -0
- {flow_props-0.1.0 → flow_props-0.2.1}/docs/theory/index.md +1 -1
- flow_props-0.2.1/docs/theory/shock.md +108 -0
- flow_props-0.2.1/docs/theory/wall-quantities.md +39 -0
- flow_props-0.2.1/docs/user-guide/basic-usage.md +118 -0
- flow_props-0.2.1/docs/user-guide/cli.md +60 -0
- flow_props-0.2.1/docs/user-guide/config-files.md +89 -0
- flow_props-0.2.1/docs/user-guide/configuration.md +5 -0
- {flow_props-0.1.0 → flow_props-0.2.1}/docs/user-guide/index.md +1 -1
- flow_props-0.2.1/docs/user-guide/output.md +37 -0
- flow_props-0.2.1/docs/user-guide/workflow.md +5 -0
- flow_props-0.2.1/docs/vnv/index.md +5 -0
- flow_props-0.2.1/docs/vnv/validation/index.md +5 -0
- flow_props-0.2.1/docs/vnv/verification/index.md +5 -0
- {flow_props-0.1.0 → flow_props-0.2.1}/mkdocs.yml +26 -2
- {flow_props-0.1.0 → flow_props-0.2.1}/pyproject.toml +25 -6
- flow_props-0.2.1/src/flow_props/__init__.py +74 -0
- flow_props-0.2.1/src/flow_props/bl.py +520 -0
- flow_props-0.2.1/src/flow_props/calculators/__init__.py +67 -0
- flow_props-0.2.1/src/flow_props/calculators/bl.py +265 -0
- flow_props-0.2.1/src/flow_props/calculators/common.py +433 -0
- flow_props-0.2.1/src/flow_props/calculators/entropy_layer.py +162 -0
- flow_props-0.2.1/src/flow_props/calculators/profiles.py +137 -0
- flow_props-0.2.1/src/flow_props/calculators/shock.py +365 -0
- flow_props-0.2.1/src/flow_props/cli/__init__.py +5 -0
- flow_props-0.2.1/src/flow_props/cli/app.py +61 -0
- flow_props-0.2.1/src/flow_props/cli/callbacks.py +39 -0
- flow_props-0.2.1/src/flow_props/cli/cmd_calculator.py +107 -0
- flow_props-0.2.1/src/flow_props/cli/examples_command.py +186 -0
- flow_props-0.2.1/src/flow_props/entropy_layer.py +217 -0
- flow_props-0.2.1/src/flow_props/examples/bl/cone_7deg_m14/bl.toml +21 -0
- flow_props-0.2.1/src/flow_props/examples/bl/ogive_m5pt3/bl.toml +20 -0
- flow_props-0.2.1/src/flow_props/examples/bl/sharp_flat_plate_m5/bl.toml +21 -0
- flow_props-0.2.1/src/flow_props/output.py +368 -0
- flow_props-0.2.1/src/flow_props/profiles/__init__.py +13 -0
- flow_props-0.2.1/src/flow_props/profiles/api.py +42 -0
- flow_props-0.2.1/src/flow_props/profiles/geometry.py +128 -0
- flow_props-0.2.1/src/flow_props/profiles/grid_line.py +51 -0
- flow_props-0.2.1/src/flow_props/profiles/wall_normal.py +221 -0
- flow_props-0.2.1/src/flow_props/shock.py +741 -0
- flow_props-0.2.1/src/flow_props/wall.py +166 -0
- {flow_props-0.1.0 → flow_props-0.2.1}/src/flow_props.egg-info/PKG-INFO +45 -14
- flow_props-0.2.1/src/flow_props.egg-info/SOURCES.txt +81 -0
- flow_props-0.2.1/src/flow_props.egg-info/entry_points.txt +2 -0
- flow_props-0.2.1/src/flow_props.egg-info/requires.txt +10 -0
- flow_props-0.2.1/src/flow_props.egg-info/scm_file_list.json +77 -0
- flow_props-0.2.1/src/flow_props.egg-info/scm_version.json +8 -0
- flow_props-0.2.1/tests/synthetic.py +105 -0
- flow_props-0.2.1/tests/test_bl.py +319 -0
- flow_props-0.2.1/tests/test_calculators.py +145 -0
- flow_props-0.2.1/tests/test_cli.py +313 -0
- flow_props-0.2.1/tests/test_entropy_layer.py +111 -0
- flow_props-0.2.1/tests/test_output.py +90 -0
- flow_props-0.2.1/tests/test_profiles.py +189 -0
- flow_props-0.2.1/tests/test_shock.py +384 -0
- flow_props-0.2.1/tests/test_wall.py +68 -0
- flow_props-0.1.0/.github/workflows/publish.yml +0 -46
- flow_props-0.1.0/LICENSE +0 -28
- flow_props-0.1.0/docs/api/index.md +0 -5
- flow_props-0.1.0/docs/index.md +0 -10
- flow_props-0.1.0/docs/installation.md +0 -20
- flow_props-0.1.0/docs/nomenclature.md +0 -5
- flow_props-0.1.0/docs/user-guide/basic-usage.md +0 -5
- flow_props-0.1.0/src/flow_props/__init__.py +0 -5
- flow_props-0.1.0/src/flow_props.egg-info/SOURCES.txt +0 -22
- flow_props-0.1.0/src/flow_props.egg-info/requires.txt +0 -1
- {flow_props-0.1.0 → flow_props-0.2.1}/docs/javascripts/mathjax.js +0 -0
- {flow_props-0.1.0 → flow_props-0.2.1}/setup.cfg +0 -0
- {flow_props-0.1.0 → flow_props-0.2.1}/src/flow_props.egg-info/dependency_links.txt +0 -0
- {flow_props-0.1.0 → flow_props-0.2.1}/src/flow_props.egg-info/top_level.txt +0 -0
|
@@ -20,23 +20,25 @@ jobs:
|
|
|
20
20
|
build:
|
|
21
21
|
runs-on: ubuntu-latest
|
|
22
22
|
steps:
|
|
23
|
-
- uses: actions/checkout@
|
|
23
|
+
- uses: actions/checkout@v6
|
|
24
|
+
with:
|
|
25
|
+
fetch-depth: 0 # required for setuptools-scm to read git tags
|
|
24
26
|
|
|
25
27
|
- name: Set up Python
|
|
26
|
-
uses: actions/setup-python@
|
|
28
|
+
uses: actions/setup-python@v6
|
|
27
29
|
with:
|
|
28
30
|
python-version: "3.11"
|
|
29
31
|
|
|
30
32
|
- name: Install dependencies
|
|
31
33
|
run: |
|
|
32
|
-
pip install
|
|
34
|
+
pip install zensical
|
|
33
35
|
pip install -e .
|
|
34
36
|
|
|
35
37
|
- name: Build documentation
|
|
36
|
-
run:
|
|
38
|
+
run: zensical build --strict
|
|
37
39
|
|
|
38
40
|
- name: Upload artifact
|
|
39
|
-
uses: actions/upload-pages-artifact@
|
|
41
|
+
uses: actions/upload-pages-artifact@v5
|
|
40
42
|
with:
|
|
41
43
|
path: site
|
|
42
44
|
|
|
@@ -50,4 +52,4 @@ jobs:
|
|
|
50
52
|
steps:
|
|
51
53
|
- name: Deploy to GitHub Pages
|
|
52
54
|
id: deployment
|
|
53
|
-
uses: actions/deploy-pages@
|
|
55
|
+
uses: actions/deploy-pages@v5
|
|
@@ -0,0 +1,41 @@
|
|
|
1
|
+
# GPL-3.0-or-later - see LICENSE
|
|
2
|
+
name: Package
|
|
3
|
+
|
|
4
|
+
on:
|
|
5
|
+
push:
|
|
6
|
+
branches: [main]
|
|
7
|
+
pull_request:
|
|
8
|
+
branches: [main]
|
|
9
|
+
workflow_dispatch:
|
|
10
|
+
|
|
11
|
+
jobs:
|
|
12
|
+
build:
|
|
13
|
+
runs-on: ubuntu-latest
|
|
14
|
+
steps:
|
|
15
|
+
- uses: actions/checkout@v6
|
|
16
|
+
with:
|
|
17
|
+
fetch-depth: 0
|
|
18
|
+
|
|
19
|
+
- uses: actions/setup-python@v6
|
|
20
|
+
with:
|
|
21
|
+
python-version: "3.11"
|
|
22
|
+
|
|
23
|
+
- name: Build distributions
|
|
24
|
+
run: |
|
|
25
|
+
python -m pip install build twine
|
|
26
|
+
python -m build
|
|
27
|
+
python -m twine check dist/*
|
|
28
|
+
|
|
29
|
+
- name: Smoke-test wheel
|
|
30
|
+
run: |
|
|
31
|
+
python -m venv "${RUNNER_TEMP}/wheel-test"
|
|
32
|
+
"${RUNNER_TEMP}/wheel-test/bin/python" -m pip install dist/*.whl
|
|
33
|
+
cd "${RUNNER_TEMP}"
|
|
34
|
+
"${RUNNER_TEMP}/wheel-test/bin/python" -c "import flow_props"
|
|
35
|
+
"${RUNNER_TEMP}/wheel-test/bin/flow-props" --help
|
|
36
|
+
|
|
37
|
+
- name: Upload distributions
|
|
38
|
+
uses: actions/upload-artifact@v7
|
|
39
|
+
with:
|
|
40
|
+
name: distributions
|
|
41
|
+
path: dist/
|
|
@@ -0,0 +1,86 @@
|
|
|
1
|
+
name: Publish to PyPI
|
|
2
|
+
|
|
3
|
+
on:
|
|
4
|
+
push:
|
|
5
|
+
tags:
|
|
6
|
+
- "v*"
|
|
7
|
+
|
|
8
|
+
jobs:
|
|
9
|
+
test:
|
|
10
|
+
runs-on: ubuntu-latest
|
|
11
|
+
strategy:
|
|
12
|
+
matrix:
|
|
13
|
+
python-version: ["3.11", "3.12", "3.13", "3.14"]
|
|
14
|
+
steps:
|
|
15
|
+
- uses: actions/checkout@v6
|
|
16
|
+
|
|
17
|
+
- name: Set up Python ${{ matrix.python-version }}
|
|
18
|
+
uses: actions/setup-python@v6
|
|
19
|
+
with:
|
|
20
|
+
python-version: ${{ matrix.python-version }}
|
|
21
|
+
|
|
22
|
+
- name: Install package
|
|
23
|
+
run: pip install -e ".[dev]"
|
|
24
|
+
|
|
25
|
+
- name: Lint with ruff
|
|
26
|
+
run: ruff check src/
|
|
27
|
+
|
|
28
|
+
- name: Run tests
|
|
29
|
+
run: pytest tests/
|
|
30
|
+
|
|
31
|
+
build:
|
|
32
|
+
needs: test
|
|
33
|
+
runs-on: ubuntu-latest
|
|
34
|
+
steps:
|
|
35
|
+
- uses: actions/checkout@v6
|
|
36
|
+
|
|
37
|
+
- name: Set up Python
|
|
38
|
+
uses: actions/setup-python@v6
|
|
39
|
+
with:
|
|
40
|
+
python-version: "3.11"
|
|
41
|
+
|
|
42
|
+
- name: Install build tools
|
|
43
|
+
run: pip install build
|
|
44
|
+
|
|
45
|
+
- name: Build package
|
|
46
|
+
run: python -m build
|
|
47
|
+
|
|
48
|
+
- name: Upload dist artifacts
|
|
49
|
+
uses: actions/upload-artifact@v7
|
|
50
|
+
with:
|
|
51
|
+
name: dist
|
|
52
|
+
path: dist/
|
|
53
|
+
|
|
54
|
+
publish:
|
|
55
|
+
needs: build
|
|
56
|
+
runs-on: ubuntu-latest
|
|
57
|
+
environment: "pypi"
|
|
58
|
+
permissions:
|
|
59
|
+
id-token: write # Required for Trusted Publishing
|
|
60
|
+
|
|
61
|
+
steps:
|
|
62
|
+
- name: Download dist artifacts
|
|
63
|
+
uses: actions/download-artifact@v8
|
|
64
|
+
with:
|
|
65
|
+
name: dist
|
|
66
|
+
path: dist/
|
|
67
|
+
|
|
68
|
+
- name: Publish to PyPI
|
|
69
|
+
uses: pypa/gh-action-pypi-publish@release/v1
|
|
70
|
+
|
|
71
|
+
release:
|
|
72
|
+
needs: publish
|
|
73
|
+
runs-on: ubuntu-latest
|
|
74
|
+
permissions:
|
|
75
|
+
contents: write
|
|
76
|
+
steps:
|
|
77
|
+
- uses: actions/checkout@v6
|
|
78
|
+
- name: Create GitHub Release (skip if it already exists)
|
|
79
|
+
run: |
|
|
80
|
+
if gh release view "${{ github.ref_name }}" >/dev/null 2>&1; then
|
|
81
|
+
echo "Release ${{ github.ref_name }} already exists; skipping."
|
|
82
|
+
else
|
|
83
|
+
gh release create "${{ github.ref_name }}" --generate-notes
|
|
84
|
+
fi
|
|
85
|
+
env:
|
|
86
|
+
GH_TOKEN: ${{ secrets.GITHUB_TOKEN }}
|
|
@@ -0,0 +1,45 @@
|
|
|
1
|
+
name: Test
|
|
2
|
+
|
|
3
|
+
on:
|
|
4
|
+
push:
|
|
5
|
+
branches: [main]
|
|
6
|
+
pull_request:
|
|
7
|
+
branches: [main]
|
|
8
|
+
|
|
9
|
+
jobs:
|
|
10
|
+
test:
|
|
11
|
+
runs-on: ubuntu-latest
|
|
12
|
+
strategy:
|
|
13
|
+
matrix:
|
|
14
|
+
python-version: ["3.11", "3.12", "3.13", "3.14"]
|
|
15
|
+
|
|
16
|
+
steps:
|
|
17
|
+
- uses: actions/checkout@v6
|
|
18
|
+
with:
|
|
19
|
+
fetch-depth: 0
|
|
20
|
+
|
|
21
|
+
- name: Set up Python ${{ matrix.python-version }}
|
|
22
|
+
uses: actions/setup-python@v6
|
|
23
|
+
with:
|
|
24
|
+
python-version: ${{ matrix.python-version }}
|
|
25
|
+
|
|
26
|
+
- name: Install package
|
|
27
|
+
run: |
|
|
28
|
+
python -m pip install --upgrade pip
|
|
29
|
+
python -m pip install -e ".[dev]"
|
|
30
|
+
|
|
31
|
+
- name: Lint with ruff
|
|
32
|
+
if: matrix.python-version == '3.11'
|
|
33
|
+
run: ruff check src/
|
|
34
|
+
|
|
35
|
+
- name: Run tests with coverage
|
|
36
|
+
run: pytest --cov=flow_props --cov-report=xml -q tests/
|
|
37
|
+
|
|
38
|
+
- name: Upload coverage to Codecov
|
|
39
|
+
if: matrix.python-version == '3.13'
|
|
40
|
+
uses: codecov/codecov-action@v6
|
|
41
|
+
with:
|
|
42
|
+
files: coverage.xml
|
|
43
|
+
token: "${{ secrets.CODECOV_TOKEN }}"
|
|
44
|
+
slug: uahypersonics/flow-props
|
|
45
|
+
fail_ci_if_error: false
|
|
@@ -0,0 +1,17 @@
|
|
|
1
|
+
cff-version: 1.2.0
|
|
2
|
+
message: "If you use this software, please cite it as below."
|
|
3
|
+
title: "flow-props"
|
|
4
|
+
abstract: "Extract flow properties from CFD data: boundary layer thickness, entropy layer thickness, and related quantities"
|
|
5
|
+
type: software
|
|
6
|
+
authors:
|
|
7
|
+
- family-names: "Hader"
|
|
8
|
+
given-names: "Christoph"
|
|
9
|
+
orcid: "https://orcid.org/0000-0002-0956-000X"
|
|
10
|
+
repository-code: "https://github.com/uahypersonics/flow-props"
|
|
11
|
+
license: GPL-3.0-or-later
|
|
12
|
+
keywords:
|
|
13
|
+
- computational fluid dynamics
|
|
14
|
+
- boundary layer
|
|
15
|
+
- entropy layer
|
|
16
|
+
- flow properties
|
|
17
|
+
- hypersonic
|