flow-props 0.1.0__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/.github/workflows/docs.yml +53 -0
- flow_props-0.1.0/.github/workflows/publish.yml +46 -0
- flow_props-0.1.0/.gitignore +210 -0
- flow_props-0.1.0/LICENSE +28 -0
- flow_props-0.1.0/PKG-INFO +89 -0
- flow_props-0.1.0/README.md +66 -0
- flow_props-0.1.0/docs/api/index.md +5 -0
- flow_props-0.1.0/docs/examples.md +5 -0
- flow_props-0.1.0/docs/index.md +10 -0
- flow_props-0.1.0/docs/installation.md +20 -0
- flow_props-0.1.0/docs/javascripts/mathjax.js +16 -0
- flow_props-0.1.0/docs/nomenclature.md +5 -0
- flow_props-0.1.0/docs/theory/index.md +5 -0
- flow_props-0.1.0/docs/user-guide/basic-usage.md +5 -0
- flow_props-0.1.0/docs/user-guide/index.md +5 -0
- flow_props-0.1.0/mkdocs.yml +105 -0
- flow_props-0.1.0/pyproject.toml +46 -0
- flow_props-0.1.0/setup.cfg +4 -0
- flow_props-0.1.0/src/flow_props/__init__.py +5 -0
- flow_props-0.1.0/src/flow_props.egg-info/PKG-INFO +89 -0
- flow_props-0.1.0/src/flow_props.egg-info/SOURCES.txt +22 -0
- flow_props-0.1.0/src/flow_props.egg-info/dependency_links.txt +1 -0
- flow_props-0.1.0/src/flow_props.egg-info/requires.txt +1 -0
- flow_props-0.1.0/src/flow_props.egg-info/top_level.txt +1 -0
|
@@ -0,0 +1,53 @@
|
|
|
1
|
+
name: Documentation
|
|
2
|
+
|
|
3
|
+
on:
|
|
4
|
+
push:
|
|
5
|
+
branches: [main]
|
|
6
|
+
pull_request:
|
|
7
|
+
branches: [main]
|
|
8
|
+
workflow_dispatch:
|
|
9
|
+
|
|
10
|
+
permissions:
|
|
11
|
+
contents: read
|
|
12
|
+
pages: write
|
|
13
|
+
id-token: write
|
|
14
|
+
|
|
15
|
+
concurrency:
|
|
16
|
+
group: "pages"
|
|
17
|
+
cancel-in-progress: false
|
|
18
|
+
|
|
19
|
+
jobs:
|
|
20
|
+
build:
|
|
21
|
+
runs-on: ubuntu-latest
|
|
22
|
+
steps:
|
|
23
|
+
- uses: actions/checkout@v4
|
|
24
|
+
|
|
25
|
+
- name: Set up Python
|
|
26
|
+
uses: actions/setup-python@v5
|
|
27
|
+
with:
|
|
28
|
+
python-version: "3.11"
|
|
29
|
+
|
|
30
|
+
- name: Install dependencies
|
|
31
|
+
run: |
|
|
32
|
+
pip install mkdocs-material
|
|
33
|
+
pip install -e .
|
|
34
|
+
|
|
35
|
+
- name: Build documentation
|
|
36
|
+
run: mkdocs build --strict
|
|
37
|
+
|
|
38
|
+
- name: Upload artifact
|
|
39
|
+
uses: actions/upload-pages-artifact@v3
|
|
40
|
+
with:
|
|
41
|
+
path: site
|
|
42
|
+
|
|
43
|
+
deploy:
|
|
44
|
+
if: github.ref == 'refs/heads/main'
|
|
45
|
+
needs: build
|
|
46
|
+
runs-on: ubuntu-latest
|
|
47
|
+
environment:
|
|
48
|
+
name: "github-pages"
|
|
49
|
+
url: ${{ steps.deployment.outputs.page_url }}
|
|
50
|
+
steps:
|
|
51
|
+
- name: Deploy to GitHub Pages
|
|
52
|
+
id: deployment
|
|
53
|
+
uses: actions/deploy-pages@v4
|
|
@@ -0,0 +1,46 @@
|
|
|
1
|
+
name: Publish to PyPI
|
|
2
|
+
|
|
3
|
+
on:
|
|
4
|
+
push:
|
|
5
|
+
tags:
|
|
6
|
+
- "v*"
|
|
7
|
+
|
|
8
|
+
jobs:
|
|
9
|
+
build:
|
|
10
|
+
runs-on: ubuntu-latest
|
|
11
|
+
steps:
|
|
12
|
+
- uses: actions/checkout@v4
|
|
13
|
+
|
|
14
|
+
- name: Set up Python
|
|
15
|
+
uses: actions/setup-python@v5
|
|
16
|
+
with:
|
|
17
|
+
python-version: "3.11"
|
|
18
|
+
|
|
19
|
+
- name: Install build tools
|
|
20
|
+
run: pip install build
|
|
21
|
+
|
|
22
|
+
- name: Build package
|
|
23
|
+
run: python -m build
|
|
24
|
+
|
|
25
|
+
- name: Upload dist artifacts
|
|
26
|
+
uses: actions/upload-artifact@v4
|
|
27
|
+
with:
|
|
28
|
+
name: dist
|
|
29
|
+
path: dist/
|
|
30
|
+
|
|
31
|
+
publish:
|
|
32
|
+
needs: build
|
|
33
|
+
runs-on: ubuntu-latest
|
|
34
|
+
environment: "pypi"
|
|
35
|
+
permissions:
|
|
36
|
+
id-token: write # Required for Trusted Publishing
|
|
37
|
+
|
|
38
|
+
steps:
|
|
39
|
+
- name: Download dist artifacts
|
|
40
|
+
uses: actions/download-artifact@v4
|
|
41
|
+
with:
|
|
42
|
+
name: dist
|
|
43
|
+
path: dist/
|
|
44
|
+
|
|
45
|
+
- name: Publish to PyPI
|
|
46
|
+
uses: pypa/gh-action-pypi-publish@release/v1
|
|
@@ -0,0 +1,210 @@
|
|
|
1
|
+
# Byte-compiled / optimized / DLL files
|
|
2
|
+
__pycache__/
|
|
3
|
+
*.py[codz]
|
|
4
|
+
*$py.class
|
|
5
|
+
|
|
6
|
+
# C extensions
|
|
7
|
+
*.so
|
|
8
|
+
|
|
9
|
+
# Distribution / packaging
|
|
10
|
+
.Python
|
|
11
|
+
build/
|
|
12
|
+
develop-eggs/
|
|
13
|
+
dist/
|
|
14
|
+
downloads/
|
|
15
|
+
eggs/
|
|
16
|
+
.eggs/
|
|
17
|
+
lib/
|
|
18
|
+
lib64/
|
|
19
|
+
parts/
|
|
20
|
+
sdist/
|
|
21
|
+
var/
|
|
22
|
+
wheels/
|
|
23
|
+
share/python-wheels/
|
|
24
|
+
*.egg-info/
|
|
25
|
+
.installed.cfg
|
|
26
|
+
*.egg
|
|
27
|
+
MANIFEST
|
|
28
|
+
|
|
29
|
+
# PyInstaller
|
|
30
|
+
# Usually these files are written by a python script from a template
|
|
31
|
+
# before PyInstaller builds the exe, so as to inject date/other infos into it.
|
|
32
|
+
*.manifest
|
|
33
|
+
*.spec
|
|
34
|
+
|
|
35
|
+
# Installer logs
|
|
36
|
+
pip-log.txt
|
|
37
|
+
pip-delete-this-directory.txt
|
|
38
|
+
|
|
39
|
+
# Unit test / coverage reports
|
|
40
|
+
htmlcov/
|
|
41
|
+
.tox/
|
|
42
|
+
.nox/
|
|
43
|
+
.coverage
|
|
44
|
+
.coverage.*
|
|
45
|
+
.cache
|
|
46
|
+
nosetests.xml
|
|
47
|
+
coverage.xml
|
|
48
|
+
*.cover
|
|
49
|
+
*.py.cover
|
|
50
|
+
.hypothesis/
|
|
51
|
+
.pytest_cache/
|
|
52
|
+
cover/
|
|
53
|
+
|
|
54
|
+
# Translations
|
|
55
|
+
*.mo
|
|
56
|
+
*.pot
|
|
57
|
+
|
|
58
|
+
# Django stuff:
|
|
59
|
+
*.log
|
|
60
|
+
local_settings.py
|
|
61
|
+
db.sqlite3
|
|
62
|
+
db.sqlite3-journal
|
|
63
|
+
|
|
64
|
+
# Flask stuff:
|
|
65
|
+
instance/
|
|
66
|
+
.webassets-cache
|
|
67
|
+
|
|
68
|
+
# Scrapy stuff:
|
|
69
|
+
.scrapy
|
|
70
|
+
|
|
71
|
+
# Sphinx documentation
|
|
72
|
+
docs/_build/
|
|
73
|
+
|
|
74
|
+
# PyBuilder
|
|
75
|
+
.pybuilder/
|
|
76
|
+
target/
|
|
77
|
+
|
|
78
|
+
# Jupyter Notebook
|
|
79
|
+
.ipynb_checkpoints
|
|
80
|
+
|
|
81
|
+
# IPython
|
|
82
|
+
profile_default/
|
|
83
|
+
ipython_config.py
|
|
84
|
+
|
|
85
|
+
# pyenv
|
|
86
|
+
# For a library or package, you might want to ignore these files since the code is
|
|
87
|
+
# intended to run in multiple environments; otherwise, check them in:
|
|
88
|
+
# .python-version
|
|
89
|
+
|
|
90
|
+
# pipenv
|
|
91
|
+
# According to pypa/pipenv#598, it is recommended to include Pipfile.lock in version control.
|
|
92
|
+
# However, in case of collaboration, if having platform-specific dependencies or dependencies
|
|
93
|
+
# having no cross-platform support, pipenv may install dependencies that don't work, or not
|
|
94
|
+
# install all needed dependencies.
|
|
95
|
+
#Pipfile.lock
|
|
96
|
+
|
|
97
|
+
# UV
|
|
98
|
+
# Similar to Pipfile.lock, it is generally recommended to include uv.lock in version control.
|
|
99
|
+
# This is especially recommended for binary packages to ensure reproducibility, and is more
|
|
100
|
+
# commonly ignored for libraries.
|
|
101
|
+
#uv.lock
|
|
102
|
+
|
|
103
|
+
# poetry
|
|
104
|
+
# Similar to Pipfile.lock, it is generally recommended to include poetry.lock in version control.
|
|
105
|
+
# This is especially recommended for binary packages to ensure reproducibility, and is more
|
|
106
|
+
# commonly ignored for libraries.
|
|
107
|
+
# https://python-poetry.org/docs/basic-usage/#commit-your-poetrylock-file-to-version-control
|
|
108
|
+
#poetry.lock
|
|
109
|
+
#poetry.toml
|
|
110
|
+
|
|
111
|
+
# pdm
|
|
112
|
+
# Similar to Pipfile.lock, it is generally recommended to include pdm.lock in version control.
|
|
113
|
+
# pdm recommends including project-wide configuration in pdm.toml, but excluding .pdm-python.
|
|
114
|
+
# https://pdm-project.org/en/latest/usage/project/#working-with-version-control
|
|
115
|
+
#pdm.lock
|
|
116
|
+
#pdm.toml
|
|
117
|
+
.pdm-python
|
|
118
|
+
.pdm-build/
|
|
119
|
+
|
|
120
|
+
# pixi
|
|
121
|
+
# Similar to Pipfile.lock, it is generally recommended to include pixi.lock in version control.
|
|
122
|
+
#pixi.lock
|
|
123
|
+
# Pixi creates a virtual environment in the .pixi directory, just like venv module creates one
|
|
124
|
+
# in the .venv directory. It is recommended not to include this directory in version control.
|
|
125
|
+
.pixi
|
|
126
|
+
|
|
127
|
+
# PEP 582; used by e.g. github.com/David-OConnor/pyflow and github.com/pdm-project/pdm
|
|
128
|
+
__pypackages__/
|
|
129
|
+
|
|
130
|
+
# Celery stuff
|
|
131
|
+
celerybeat-schedule
|
|
132
|
+
celerybeat.pid
|
|
133
|
+
|
|
134
|
+
# SageMath parsed files
|
|
135
|
+
*.sage.py
|
|
136
|
+
|
|
137
|
+
# Environments
|
|
138
|
+
.env
|
|
139
|
+
.envrc
|
|
140
|
+
.venv
|
|
141
|
+
env/
|
|
142
|
+
venv/
|
|
143
|
+
ENV/
|
|
144
|
+
env.bak/
|
|
145
|
+
venv.bak/
|
|
146
|
+
|
|
147
|
+
# Spyder project settings
|
|
148
|
+
.spyderproject
|
|
149
|
+
.spyproject
|
|
150
|
+
|
|
151
|
+
# Rope project settings
|
|
152
|
+
.ropeproject
|
|
153
|
+
|
|
154
|
+
# mkdocs documentation
|
|
155
|
+
/site
|
|
156
|
+
|
|
157
|
+
# mypy
|
|
158
|
+
.mypy_cache/
|
|
159
|
+
.dmypy.json
|
|
160
|
+
dmypy.json
|
|
161
|
+
|
|
162
|
+
# Pyre type checker
|
|
163
|
+
.pyre/
|
|
164
|
+
|
|
165
|
+
# pytype static type analyzer
|
|
166
|
+
.pytype/
|
|
167
|
+
|
|
168
|
+
# Cython debug symbols
|
|
169
|
+
cython_debug/
|
|
170
|
+
|
|
171
|
+
# PyCharm
|
|
172
|
+
# JetBrains specific template is maintained in a separate JetBrains.gitignore that can
|
|
173
|
+
# be found at https://github.com/github/gitignore/blob/main/Global/JetBrains.gitignore
|
|
174
|
+
# and can be added to the global gitignore or merged into this file. For a more nuclear
|
|
175
|
+
# option (not recommended) you can uncomment the following to ignore the entire idea folder.
|
|
176
|
+
#.idea/
|
|
177
|
+
|
|
178
|
+
# Abstra
|
|
179
|
+
# Abstra is an AI-powered process automation framework.
|
|
180
|
+
# Ignore directories containing user credentials, local state, and settings.
|
|
181
|
+
# Learn more at https://abstra.io/docs
|
|
182
|
+
.abstra/
|
|
183
|
+
|
|
184
|
+
# Visual Studio Code
|
|
185
|
+
# Visual Studio Code specific template is maintained in a separate VisualStudioCode.gitignore
|
|
186
|
+
# that can be found at https://github.com/github/gitignore/blob/main/Global/VisualStudioCode.gitignore
|
|
187
|
+
# and can be added to the global gitignore or merged into this file. However, if you prefer,
|
|
188
|
+
# you could uncomment the following to ignore the entire vscode folder
|
|
189
|
+
# .vscode/
|
|
190
|
+
|
|
191
|
+
# Ruff stuff:
|
|
192
|
+
.ruff_cache/
|
|
193
|
+
|
|
194
|
+
# PyPI configuration file
|
|
195
|
+
.pypirc
|
|
196
|
+
|
|
197
|
+
# Local sandbox
|
|
198
|
+
sandbox/
|
|
199
|
+
|
|
200
|
+
# Cursor
|
|
201
|
+
# Cursor is an AI-powered code editor. `.cursorignore` specifies files/directories to
|
|
202
|
+
# exclude from AI features like autocomplete and code analysis. Recommended for sensitive data
|
|
203
|
+
# refer to https://docs.cursor.com/context/ignore-files
|
|
204
|
+
.cursorignore
|
|
205
|
+
.cursorindexingignore
|
|
206
|
+
|
|
207
|
+
# Marimo
|
|
208
|
+
marimo/_static/
|
|
209
|
+
marimo/_lsp/
|
|
210
|
+
__marimo__/
|
flow_props-0.1.0/LICENSE
ADDED
|
@@ -0,0 +1,28 @@
|
|
|
1
|
+
BSD 3-Clause License
|
|
2
|
+
|
|
3
|
+
Copyright (c) 2026, uahypersonics
|
|
4
|
+
|
|
5
|
+
Redistribution and use in source and binary forms, with or without
|
|
6
|
+
modification, are permitted provided that the following conditions are met:
|
|
7
|
+
|
|
8
|
+
1. Redistributions of source code must retain the above copyright notice, this
|
|
9
|
+
list of conditions and the following disclaimer.
|
|
10
|
+
|
|
11
|
+
2. Redistributions in binary form must reproduce the above copyright notice,
|
|
12
|
+
this list of conditions and the following disclaimer in the documentation
|
|
13
|
+
and/or other materials provided with the distribution.
|
|
14
|
+
|
|
15
|
+
3. Neither the name of the copyright holder nor the names of its
|
|
16
|
+
contributors may be used to endorse or promote products derived from
|
|
17
|
+
this software without specific prior written permission.
|
|
18
|
+
|
|
19
|
+
THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
|
|
20
|
+
AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
|
|
21
|
+
IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
|
|
22
|
+
DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE
|
|
23
|
+
FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
|
|
24
|
+
DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
|
|
25
|
+
SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER
|
|
26
|
+
CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
|
|
27
|
+
OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
|
|
28
|
+
OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
|
|
@@ -0,0 +1,89 @@
|
|
|
1
|
+
Metadata-Version: 2.4
|
|
2
|
+
Name: flow-props
|
|
3
|
+
Version: 0.1.0
|
|
4
|
+
Summary: Extract flow properties from CFD data: boundary layer thickness, entropy layer thickness
|
|
5
|
+
Author-email: Christoph Hader <chader@arizona.edu>
|
|
6
|
+
License: BSD-3-Clause
|
|
7
|
+
Project-URL: Homepage, https://github.com/uahypersonics/flow-props
|
|
8
|
+
Project-URL: Repository, https://github.com/uahypersonics/flow-props
|
|
9
|
+
Keywords: boundary-layer,entropy-layer,cfd,flow-properties,aerodynamics
|
|
10
|
+
Classifier: Development Status :: 1 - Planning
|
|
11
|
+
Classifier: Intended Audience :: Science/Research
|
|
12
|
+
Classifier: License :: OSI Approved :: BSD License
|
|
13
|
+
Classifier: Programming Language :: Python :: 3
|
|
14
|
+
Classifier: Programming Language :: Python :: 3.11
|
|
15
|
+
Classifier: Programming Language :: Python :: 3.12
|
|
16
|
+
Classifier: Programming Language :: Python :: 3.13
|
|
17
|
+
Classifier: Topic :: Scientific/Engineering :: Physics
|
|
18
|
+
Requires-Python: >=3.11
|
|
19
|
+
Description-Content-Type: text/markdown
|
|
20
|
+
License-File: LICENSE
|
|
21
|
+
Requires-Dist: numpy>=1.24.0
|
|
22
|
+
Dynamic: license-file
|
|
23
|
+
|
|
24
|
+
# flow-props
|
|
25
|
+
|
|
26
|
+
Python tool suite to extract flow properties from CFD data, such as boundary layer thickness and entropy layer thickness.
|
|
27
|
+
|
|
28
|
+
[](https://github.com/uahypersonics/flow-props/actions/workflows/test.yml)
|
|
29
|
+
[](https://pypi.org/project/flow-props/)
|
|
30
|
+
[](https://uahypersonics.github.io/flow-props/)
|
|
31
|
+
[](LICENSE)
|
|
32
|
+
[](https://www.python.org/downloads/)
|
|
33
|
+
[](https://github.com/astral-sh/ruff)
|
|
34
|
+
|
|
35
|
+
## Install
|
|
36
|
+
|
|
37
|
+
```bash
|
|
38
|
+
pip install flow-props
|
|
39
|
+
```
|
|
40
|
+
|
|
41
|
+
## Quick Start
|
|
42
|
+
|
|
43
|
+
```python
|
|
44
|
+
import flow_props
|
|
45
|
+
```
|
|
46
|
+
|
|
47
|
+
## Features
|
|
48
|
+
|
|
49
|
+
- under construction
|
|
50
|
+
|
|
51
|
+
## Documentation
|
|
52
|
+
|
|
53
|
+
Full documentation: https://uahypersonics.github.io/flow-props
|
|
54
|
+
|
|
55
|
+
## Code Style
|
|
56
|
+
|
|
57
|
+
This project follows established Python community conventions so that
|
|
58
|
+
contributors can focus on the physics rather than inventing formatting rules.
|
|
59
|
+
|
|
60
|
+
| Convention | What it covers | Reference |
|
|
61
|
+
|---|---|---|
|
|
62
|
+
| [PEP 8](https://peps.python.org/pep-0008/) | Code formatting, naming, whitespace | Python standard style guide |
|
|
63
|
+
| [PEP 257](https://peps.python.org/pep-0257/) | Docstring structure (triple-quoted, imperative mood) | Python standard docstring conventions |
|
|
64
|
+
| [Google style](https://google.github.io/styleguide/pyguide.html#38-comments-and-docstrings) | Docstring sections (`Args`, `Returns`, `Raises`) | Google Python style guide |
|
|
65
|
+
| [Ruff](https://docs.astral.sh/ruff/) | Automated linting and formatting | Enforces PEP 8 compliance automatically |
|
|
66
|
+
| [typing / TYPE_CHECKING](https://docs.python.org/3/library/typing.html#typing.TYPE_CHECKING) | Type hints for IDE support and static analysis | Python standard library |
|
|
67
|
+
|
|
68
|
+
## Versioning & Releasing
|
|
69
|
+
|
|
70
|
+
This project uses [Semantic Versioning](https://semver.org/) (`vMAJOR.MINOR.PATCH`):
|
|
71
|
+
|
|
72
|
+
- **MAJOR** (`v1.0.0`, `v2.0.0`): Breaking API changes
|
|
73
|
+
- **MINOR** (`v0.3.0`, `v0.4.0`): New features, backward-compatible
|
|
74
|
+
- **PATCH** (`v0.3.1`, `v0.3.2`): Bug fixes, minor corrections
|
|
75
|
+
|
|
76
|
+
To publish a new version to [PyPI](https://pypi.org/project/flow-props/):
|
|
77
|
+
|
|
78
|
+
1. Commit and push to `main`
|
|
79
|
+
2. Tag and push:
|
|
80
|
+
```bash
|
|
81
|
+
git tag -a vMAJOR.MINOR.PATCH -m "Release vMAJOR.MINOR.PATCH"
|
|
82
|
+
git push origin vMAJOR.MINOR.PATCH
|
|
83
|
+
```
|
|
84
|
+
|
|
85
|
+
The GitHub Actions workflow will automatically build and publish to PyPI via Trusted Publishing.
|
|
86
|
+
|
|
87
|
+
## License
|
|
88
|
+
|
|
89
|
+
BSD-3-Clause. See [LICENSE](LICENSE) for details.
|
|
@@ -0,0 +1,66 @@
|
|
|
1
|
+
# flow-props
|
|
2
|
+
|
|
3
|
+
Python tool suite to extract flow properties from CFD data, such as boundary layer thickness and entropy layer thickness.
|
|
4
|
+
|
|
5
|
+
[](https://github.com/uahypersonics/flow-props/actions/workflows/test.yml)
|
|
6
|
+
[](https://pypi.org/project/flow-props/)
|
|
7
|
+
[](https://uahypersonics.github.io/flow-props/)
|
|
8
|
+
[](LICENSE)
|
|
9
|
+
[](https://www.python.org/downloads/)
|
|
10
|
+
[](https://github.com/astral-sh/ruff)
|
|
11
|
+
|
|
12
|
+
## Install
|
|
13
|
+
|
|
14
|
+
```bash
|
|
15
|
+
pip install flow-props
|
|
16
|
+
```
|
|
17
|
+
|
|
18
|
+
## Quick Start
|
|
19
|
+
|
|
20
|
+
```python
|
|
21
|
+
import flow_props
|
|
22
|
+
```
|
|
23
|
+
|
|
24
|
+
## Features
|
|
25
|
+
|
|
26
|
+
- under construction
|
|
27
|
+
|
|
28
|
+
## Documentation
|
|
29
|
+
|
|
30
|
+
Full documentation: https://uahypersonics.github.io/flow-props
|
|
31
|
+
|
|
32
|
+
## Code Style
|
|
33
|
+
|
|
34
|
+
This project follows established Python community conventions so that
|
|
35
|
+
contributors can focus on the physics rather than inventing formatting rules.
|
|
36
|
+
|
|
37
|
+
| Convention | What it covers | Reference |
|
|
38
|
+
|---|---|---|
|
|
39
|
+
| [PEP 8](https://peps.python.org/pep-0008/) | Code formatting, naming, whitespace | Python standard style guide |
|
|
40
|
+
| [PEP 257](https://peps.python.org/pep-0257/) | Docstring structure (triple-quoted, imperative mood) | Python standard docstring conventions |
|
|
41
|
+
| [Google style](https://google.github.io/styleguide/pyguide.html#38-comments-and-docstrings) | Docstring sections (`Args`, `Returns`, `Raises`) | Google Python style guide |
|
|
42
|
+
| [Ruff](https://docs.astral.sh/ruff/) | Automated linting and formatting | Enforces PEP 8 compliance automatically |
|
|
43
|
+
| [typing / TYPE_CHECKING](https://docs.python.org/3/library/typing.html#typing.TYPE_CHECKING) | Type hints for IDE support and static analysis | Python standard library |
|
|
44
|
+
|
|
45
|
+
## Versioning & Releasing
|
|
46
|
+
|
|
47
|
+
This project uses [Semantic Versioning](https://semver.org/) (`vMAJOR.MINOR.PATCH`):
|
|
48
|
+
|
|
49
|
+
- **MAJOR** (`v1.0.0`, `v2.0.0`): Breaking API changes
|
|
50
|
+
- **MINOR** (`v0.3.0`, `v0.4.0`): New features, backward-compatible
|
|
51
|
+
- **PATCH** (`v0.3.1`, `v0.3.2`): Bug fixes, minor corrections
|
|
52
|
+
|
|
53
|
+
To publish a new version to [PyPI](https://pypi.org/project/flow-props/):
|
|
54
|
+
|
|
55
|
+
1. Commit and push to `main`
|
|
56
|
+
2. Tag and push:
|
|
57
|
+
```bash
|
|
58
|
+
git tag -a vMAJOR.MINOR.PATCH -m "Release vMAJOR.MINOR.PATCH"
|
|
59
|
+
git push origin vMAJOR.MINOR.PATCH
|
|
60
|
+
```
|
|
61
|
+
|
|
62
|
+
The GitHub Actions workflow will automatically build and publish to PyPI via Trusted Publishing.
|
|
63
|
+
|
|
64
|
+
## License
|
|
65
|
+
|
|
66
|
+
BSD-3-Clause. See [LICENSE](LICENSE) for details.
|
|
@@ -0,0 +1,20 @@
|
|
|
1
|
+
# Installation
|
|
2
|
+
|
|
3
|
+
## From PyPI
|
|
4
|
+
|
|
5
|
+
```bash
|
|
6
|
+
pip install flow-props
|
|
7
|
+
```
|
|
8
|
+
|
|
9
|
+
## From Source
|
|
10
|
+
|
|
11
|
+
```bash
|
|
12
|
+
git clone https://github.com/uahypersonics/flow-props.git
|
|
13
|
+
cd flow-props
|
|
14
|
+
pip install -e .
|
|
15
|
+
```
|
|
16
|
+
|
|
17
|
+
## Requirements
|
|
18
|
+
|
|
19
|
+
- Python >= 3.11
|
|
20
|
+
- NumPy >= 1.24
|
|
@@ -0,0 +1,16 @@
|
|
|
1
|
+
window.MathJax = {
|
|
2
|
+
tex: {
|
|
3
|
+
inlineMath: [["\\(", "\\)"]],
|
|
4
|
+
displayMath: [["\\[", "\\]"]],
|
|
5
|
+
processEscapes: true,
|
|
6
|
+
processEnvironments: true
|
|
7
|
+
},
|
|
8
|
+
options: {
|
|
9
|
+
ignoreHtmlClass: ".*|",
|
|
10
|
+
processHtmlClass: "arithmatex"
|
|
11
|
+
}
|
|
12
|
+
};
|
|
13
|
+
|
|
14
|
+
document$.subscribe(() => {
|
|
15
|
+
MathJax.typesetPromise()
|
|
16
|
+
})
|
|
@@ -0,0 +1,105 @@
|
|
|
1
|
+
# BSD-3-Clause License - see LICENSE file
|
|
2
|
+
|
|
3
|
+
# --------------------------------------------------
|
|
4
|
+
# site metadata
|
|
5
|
+
# --------------------------------------------------
|
|
6
|
+
site_name: flow_props
|
|
7
|
+
site_url: https://uahypersonics.github.io/flow-props
|
|
8
|
+
site_author: Christoph Hader
|
|
9
|
+
site_description: Extract flow properties from CFD data.
|
|
10
|
+
|
|
11
|
+
# --------------------------------------------------
|
|
12
|
+
# github repository (adds link in top right corner)
|
|
13
|
+
# --------------------------------------------------
|
|
14
|
+
repo_name: uahypersonics/flow-props
|
|
15
|
+
repo_url: https://github.com/uahypersonics/flow-props
|
|
16
|
+
edit_uri: edit/main/docs/
|
|
17
|
+
|
|
18
|
+
# --------------------------------------------------
|
|
19
|
+
# theme configuration
|
|
20
|
+
# --------------------------------------------------
|
|
21
|
+
theme:
|
|
22
|
+
name: material
|
|
23
|
+
palette:
|
|
24
|
+
- media: "(prefers-color-scheme)"
|
|
25
|
+
toggle:
|
|
26
|
+
icon: material/brightness-auto
|
|
27
|
+
name: Switch to light mode
|
|
28
|
+
- media: "(prefers-color-scheme: light)"
|
|
29
|
+
scheme: default
|
|
30
|
+
primary: blue grey
|
|
31
|
+
accent: blue grey
|
|
32
|
+
toggle:
|
|
33
|
+
icon: material/weather-sunny
|
|
34
|
+
name: Switch to dark mode
|
|
35
|
+
- media: "(prefers-color-scheme: dark)"
|
|
36
|
+
scheme: slate
|
|
37
|
+
primary: blue grey
|
|
38
|
+
accent: blue grey
|
|
39
|
+
toggle:
|
|
40
|
+
icon: material/weather-night
|
|
41
|
+
name: Switch to system preference
|
|
42
|
+
features:
|
|
43
|
+
- navigation.tabs
|
|
44
|
+
- navigation.sections
|
|
45
|
+
- navigation.indexes
|
|
46
|
+
- navigation.top
|
|
47
|
+
- content.code.copy
|
|
48
|
+
- content.code.annotate
|
|
49
|
+
- content.action.edit
|
|
50
|
+
- content.action.view
|
|
51
|
+
|
|
52
|
+
# --------------------------------------------------
|
|
53
|
+
# plugins
|
|
54
|
+
# --------------------------------------------------
|
|
55
|
+
plugins:
|
|
56
|
+
- search
|
|
57
|
+
|
|
58
|
+
# --------------------------------------------------
|
|
59
|
+
# markdown extensions
|
|
60
|
+
# --------------------------------------------------
|
|
61
|
+
markdown_extensions:
|
|
62
|
+
- pymdownx.highlight:
|
|
63
|
+
anchor_linenums: true
|
|
64
|
+
linenums: true
|
|
65
|
+
- pymdownx.superfences:
|
|
66
|
+
custom_fences:
|
|
67
|
+
- name: mermaid
|
|
68
|
+
class: mermaid
|
|
69
|
+
format: !!python/name:pymdownx.superfences.fence_code_format
|
|
70
|
+
- pymdownx.tabbed:
|
|
71
|
+
alternate_style: true
|
|
72
|
+
- pymdownx.arithmatex:
|
|
73
|
+
generic: true
|
|
74
|
+
- pymdownx.emoji:
|
|
75
|
+
emoji_index: !!python/name:material.extensions.emoji.twemoji
|
|
76
|
+
emoji_generator: !!python/name:material.extensions.emoji.to_svg
|
|
77
|
+
- admonition
|
|
78
|
+
- pymdownx.details
|
|
79
|
+
- tables
|
|
80
|
+
- attr_list
|
|
81
|
+
- md_in_html
|
|
82
|
+
- footnotes
|
|
83
|
+
|
|
84
|
+
# --------------------------------------------------
|
|
85
|
+
# javascript for MathJax
|
|
86
|
+
# --------------------------------------------------
|
|
87
|
+
extra_javascript:
|
|
88
|
+
- javascripts/mathjax.js
|
|
89
|
+
- https://unpkg.com/mathjax@3/es5/tex-mml-chtml.js
|
|
90
|
+
|
|
91
|
+
# --------------------------------------------------
|
|
92
|
+
# navigation
|
|
93
|
+
# --------------------------------------------------
|
|
94
|
+
nav:
|
|
95
|
+
- Home: index.md
|
|
96
|
+
- Installation: installation.md
|
|
97
|
+
- User Guide:
|
|
98
|
+
- user-guide/index.md
|
|
99
|
+
- Basic Usage: user-guide/basic-usage.md
|
|
100
|
+
- Theory:
|
|
101
|
+
- theory/index.md
|
|
102
|
+
- API Reference:
|
|
103
|
+
- api/index.md
|
|
104
|
+
- Examples: examples.md
|
|
105
|
+
- Nomenclature: nomenclature.md
|
|
@@ -0,0 +1,46 @@
|
|
|
1
|
+
[build-system]
|
|
2
|
+
requires = ["setuptools>=61.0", "setuptools-scm>=8", "wheel"]
|
|
3
|
+
build-backend = "setuptools.build_meta"
|
|
4
|
+
|
|
5
|
+
[project]
|
|
6
|
+
name = "flow-props"
|
|
7
|
+
dynamic = ["version"]
|
|
8
|
+
description = "Extract flow properties from CFD data: boundary layer thickness, entropy layer thickness"
|
|
9
|
+
readme = "README.md"
|
|
10
|
+
license = {text = "BSD-3-Clause"}
|
|
11
|
+
requires-python = ">=3.11"
|
|
12
|
+
authors = [
|
|
13
|
+
{name = "Christoph Hader", email = "chader@arizona.edu"},
|
|
14
|
+
]
|
|
15
|
+
classifiers = [
|
|
16
|
+
"Development Status :: 1 - Planning",
|
|
17
|
+
"Intended Audience :: Science/Research",
|
|
18
|
+
"License :: OSI Approved :: BSD License",
|
|
19
|
+
"Programming Language :: Python :: 3",
|
|
20
|
+
"Programming Language :: Python :: 3.11",
|
|
21
|
+
"Programming Language :: Python :: 3.12",
|
|
22
|
+
"Programming Language :: Python :: 3.13",
|
|
23
|
+
"Topic :: Scientific/Engineering :: Physics",
|
|
24
|
+
]
|
|
25
|
+
keywords = ["boundary-layer", "entropy-layer", "cfd", "flow-properties", "aerodynamics"]
|
|
26
|
+
|
|
27
|
+
dependencies = [
|
|
28
|
+
"numpy>=1.24.0",
|
|
29
|
+
]
|
|
30
|
+
|
|
31
|
+
[project.urls]
|
|
32
|
+
Homepage = "https://github.com/uahypersonics/flow-props"
|
|
33
|
+
Repository = "https://github.com/uahypersonics/flow-props"
|
|
34
|
+
|
|
35
|
+
[tool.setuptools.packages.find]
|
|
36
|
+
where = ["src"]
|
|
37
|
+
|
|
38
|
+
[tool.setuptools_scm]
|
|
39
|
+
|
|
40
|
+
[tool.ruff]
|
|
41
|
+
line-length = 100
|
|
42
|
+
target-version = "py311"
|
|
43
|
+
|
|
44
|
+
[tool.ruff.lint]
|
|
45
|
+
select = ["E", "F", "W", "I", "UP"]
|
|
46
|
+
ignore = ["E501"]
|
|
@@ -0,0 +1,89 @@
|
|
|
1
|
+
Metadata-Version: 2.4
|
|
2
|
+
Name: flow-props
|
|
3
|
+
Version: 0.1.0
|
|
4
|
+
Summary: Extract flow properties from CFD data: boundary layer thickness, entropy layer thickness
|
|
5
|
+
Author-email: Christoph Hader <chader@arizona.edu>
|
|
6
|
+
License: BSD-3-Clause
|
|
7
|
+
Project-URL: Homepage, https://github.com/uahypersonics/flow-props
|
|
8
|
+
Project-URL: Repository, https://github.com/uahypersonics/flow-props
|
|
9
|
+
Keywords: boundary-layer,entropy-layer,cfd,flow-properties,aerodynamics
|
|
10
|
+
Classifier: Development Status :: 1 - Planning
|
|
11
|
+
Classifier: Intended Audience :: Science/Research
|
|
12
|
+
Classifier: License :: OSI Approved :: BSD License
|
|
13
|
+
Classifier: Programming Language :: Python :: 3
|
|
14
|
+
Classifier: Programming Language :: Python :: 3.11
|
|
15
|
+
Classifier: Programming Language :: Python :: 3.12
|
|
16
|
+
Classifier: Programming Language :: Python :: 3.13
|
|
17
|
+
Classifier: Topic :: Scientific/Engineering :: Physics
|
|
18
|
+
Requires-Python: >=3.11
|
|
19
|
+
Description-Content-Type: text/markdown
|
|
20
|
+
License-File: LICENSE
|
|
21
|
+
Requires-Dist: numpy>=1.24.0
|
|
22
|
+
Dynamic: license-file
|
|
23
|
+
|
|
24
|
+
# flow-props
|
|
25
|
+
|
|
26
|
+
Python tool suite to extract flow properties from CFD data, such as boundary layer thickness and entropy layer thickness.
|
|
27
|
+
|
|
28
|
+
[](https://github.com/uahypersonics/flow-props/actions/workflows/test.yml)
|
|
29
|
+
[](https://pypi.org/project/flow-props/)
|
|
30
|
+
[](https://uahypersonics.github.io/flow-props/)
|
|
31
|
+
[](LICENSE)
|
|
32
|
+
[](https://www.python.org/downloads/)
|
|
33
|
+
[](https://github.com/astral-sh/ruff)
|
|
34
|
+
|
|
35
|
+
## Install
|
|
36
|
+
|
|
37
|
+
```bash
|
|
38
|
+
pip install flow-props
|
|
39
|
+
```
|
|
40
|
+
|
|
41
|
+
## Quick Start
|
|
42
|
+
|
|
43
|
+
```python
|
|
44
|
+
import flow_props
|
|
45
|
+
```
|
|
46
|
+
|
|
47
|
+
## Features
|
|
48
|
+
|
|
49
|
+
- under construction
|
|
50
|
+
|
|
51
|
+
## Documentation
|
|
52
|
+
|
|
53
|
+
Full documentation: https://uahypersonics.github.io/flow-props
|
|
54
|
+
|
|
55
|
+
## Code Style
|
|
56
|
+
|
|
57
|
+
This project follows established Python community conventions so that
|
|
58
|
+
contributors can focus on the physics rather than inventing formatting rules.
|
|
59
|
+
|
|
60
|
+
| Convention | What it covers | Reference |
|
|
61
|
+
|---|---|---|
|
|
62
|
+
| [PEP 8](https://peps.python.org/pep-0008/) | Code formatting, naming, whitespace | Python standard style guide |
|
|
63
|
+
| [PEP 257](https://peps.python.org/pep-0257/) | Docstring structure (triple-quoted, imperative mood) | Python standard docstring conventions |
|
|
64
|
+
| [Google style](https://google.github.io/styleguide/pyguide.html#38-comments-and-docstrings) | Docstring sections (`Args`, `Returns`, `Raises`) | Google Python style guide |
|
|
65
|
+
| [Ruff](https://docs.astral.sh/ruff/) | Automated linting and formatting | Enforces PEP 8 compliance automatically |
|
|
66
|
+
| [typing / TYPE_CHECKING](https://docs.python.org/3/library/typing.html#typing.TYPE_CHECKING) | Type hints for IDE support and static analysis | Python standard library |
|
|
67
|
+
|
|
68
|
+
## Versioning & Releasing
|
|
69
|
+
|
|
70
|
+
This project uses [Semantic Versioning](https://semver.org/) (`vMAJOR.MINOR.PATCH`):
|
|
71
|
+
|
|
72
|
+
- **MAJOR** (`v1.0.0`, `v2.0.0`): Breaking API changes
|
|
73
|
+
- **MINOR** (`v0.3.0`, `v0.4.0`): New features, backward-compatible
|
|
74
|
+
- **PATCH** (`v0.3.1`, `v0.3.2`): Bug fixes, minor corrections
|
|
75
|
+
|
|
76
|
+
To publish a new version to [PyPI](https://pypi.org/project/flow-props/):
|
|
77
|
+
|
|
78
|
+
1. Commit and push to `main`
|
|
79
|
+
2. Tag and push:
|
|
80
|
+
```bash
|
|
81
|
+
git tag -a vMAJOR.MINOR.PATCH -m "Release vMAJOR.MINOR.PATCH"
|
|
82
|
+
git push origin vMAJOR.MINOR.PATCH
|
|
83
|
+
```
|
|
84
|
+
|
|
85
|
+
The GitHub Actions workflow will automatically build and publish to PyPI via Trusted Publishing.
|
|
86
|
+
|
|
87
|
+
## License
|
|
88
|
+
|
|
89
|
+
BSD-3-Clause. See [LICENSE](LICENSE) for details.
|
|
@@ -0,0 +1,22 @@
|
|
|
1
|
+
.gitignore
|
|
2
|
+
LICENSE
|
|
3
|
+
README.md
|
|
4
|
+
mkdocs.yml
|
|
5
|
+
pyproject.toml
|
|
6
|
+
.github/workflows/docs.yml
|
|
7
|
+
.github/workflows/publish.yml
|
|
8
|
+
docs/examples.md
|
|
9
|
+
docs/index.md
|
|
10
|
+
docs/installation.md
|
|
11
|
+
docs/nomenclature.md
|
|
12
|
+
docs/api/index.md
|
|
13
|
+
docs/javascripts/mathjax.js
|
|
14
|
+
docs/theory/index.md
|
|
15
|
+
docs/user-guide/basic-usage.md
|
|
16
|
+
docs/user-guide/index.md
|
|
17
|
+
src/flow_props/__init__.py
|
|
18
|
+
src/flow_props.egg-info/PKG-INFO
|
|
19
|
+
src/flow_props.egg-info/SOURCES.txt
|
|
20
|
+
src/flow_props.egg-info/dependency_links.txt
|
|
21
|
+
src/flow_props.egg-info/requires.txt
|
|
22
|
+
src/flow_props.egg-info/top_level.txt
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
numpy>=1.24.0
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
flow_props
|