flow-theory 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_theory-0.1.0/.github/workflows/docs.yml +54 -0
- flow_theory-0.1.0/.github/workflows/publish.yml +69 -0
- flow_theory-0.1.0/.github/workflows/test.yml +31 -0
- flow_theory-0.1.0/.gitignore +218 -0
- flow_theory-0.1.0/CITATION.cff +18 -0
- flow_theory-0.1.0/LICENSE +28 -0
- flow_theory-0.1.0/PKG-INFO +98 -0
- flow_theory-0.1.0/README.md +70 -0
- flow_theory-0.1.0/docs/index.md +16 -0
- flow_theory-0.1.0/docs/installation.md +13 -0
- flow_theory-0.1.0/mkdocs.yml +43 -0
- flow_theory-0.1.0/pyproject.toml +58 -0
- flow_theory-0.1.0/setup.cfg +4 -0
- flow_theory-0.1.0/src/flow_theory/__init__.py +8 -0
- flow_theory-0.1.0/src/flow_theory.egg-info/PKG-INFO +98 -0
- flow_theory-0.1.0/src/flow_theory.egg-info/SOURCES.txt +18 -0
- flow_theory-0.1.0/src/flow_theory.egg-info/dependency_links.txt +1 -0
- flow_theory-0.1.0/src/flow_theory.egg-info/requires.txt +7 -0
- flow_theory-0.1.0/src/flow_theory.egg-info/top_level.txt +1 -0
- flow_theory-0.1.0/tests/test_stub.py +7 -0
|
@@ -0,0 +1,54 @@
|
|
|
1
|
+
# BSD-3-Clause License - see LICENSE file
|
|
2
|
+
name: Documentation
|
|
3
|
+
|
|
4
|
+
on:
|
|
5
|
+
push:
|
|
6
|
+
branches: [main]
|
|
7
|
+
pull_request:
|
|
8
|
+
branches: [main]
|
|
9
|
+
workflow_dispatch:
|
|
10
|
+
|
|
11
|
+
permissions:
|
|
12
|
+
contents: read
|
|
13
|
+
pages: write
|
|
14
|
+
id-token: write
|
|
15
|
+
|
|
16
|
+
concurrency:
|
|
17
|
+
group: "pages"
|
|
18
|
+
cancel-in-progress: false
|
|
19
|
+
|
|
20
|
+
jobs:
|
|
21
|
+
build:
|
|
22
|
+
runs-on: ubuntu-latest
|
|
23
|
+
steps:
|
|
24
|
+
- uses: actions/checkout@v4
|
|
25
|
+
|
|
26
|
+
- name: Set up Python
|
|
27
|
+
uses: actions/setup-python@v5
|
|
28
|
+
with:
|
|
29
|
+
python-version: "3.11"
|
|
30
|
+
|
|
31
|
+
- name: Install dependencies
|
|
32
|
+
run: |
|
|
33
|
+
pip install mkdocs-material mkdocstrings[python]
|
|
34
|
+
pip install -e .
|
|
35
|
+
|
|
36
|
+
- name: Build documentation
|
|
37
|
+
run: mkdocs build --strict
|
|
38
|
+
|
|
39
|
+
- name: Upload artifact
|
|
40
|
+
uses: actions/upload-pages-artifact@v3
|
|
41
|
+
with:
|
|
42
|
+
path: site
|
|
43
|
+
|
|
44
|
+
deploy:
|
|
45
|
+
if: github.ref == 'refs/heads/main'
|
|
46
|
+
needs: build
|
|
47
|
+
runs-on: ubuntu-latest
|
|
48
|
+
environment:
|
|
49
|
+
name: github-pages
|
|
50
|
+
url: ${{ steps.deployment.outputs.page_url }}
|
|
51
|
+
steps:
|
|
52
|
+
- name: Deploy to GitHub Pages
|
|
53
|
+
id: deployment
|
|
54
|
+
uses: actions/deploy-pages@v4
|
|
@@ -0,0 +1,69 @@
|
|
|
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"]
|
|
14
|
+
steps:
|
|
15
|
+
- uses: actions/checkout@v4
|
|
16
|
+
|
|
17
|
+
- name: Set up Python ${{ matrix.python-version }}
|
|
18
|
+
uses: actions/setup-python@v5
|
|
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@v4
|
|
36
|
+
|
|
37
|
+
- name: Set up Python
|
|
38
|
+
uses: actions/setup-python@v5
|
|
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@v4
|
|
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@v4
|
|
64
|
+
with:
|
|
65
|
+
name: dist
|
|
66
|
+
path: dist/
|
|
67
|
+
|
|
68
|
+
- name: Publish to PyPI
|
|
69
|
+
uses: pypa/gh-action-pypi-publish@release/v1
|
|
@@ -0,0 +1,31 @@
|
|
|
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"]
|
|
15
|
+
|
|
16
|
+
steps:
|
|
17
|
+
- uses: actions/checkout@v4
|
|
18
|
+
|
|
19
|
+
- name: Set up Python ${{ matrix.python-version }}
|
|
20
|
+
uses: actions/setup-python@v5
|
|
21
|
+
with:
|
|
22
|
+
python-version: ${{ matrix.python-version }}
|
|
23
|
+
|
|
24
|
+
- name: Install package
|
|
25
|
+
run: pip install -e ".[dev]"
|
|
26
|
+
|
|
27
|
+
- name: Lint with ruff
|
|
28
|
+
run: ruff check src/
|
|
29
|
+
|
|
30
|
+
- name: Run tests
|
|
31
|
+
run: pytest tests/
|
|
@@ -0,0 +1,218 @@
|
|
|
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
|
+
# Redis
|
|
135
|
+
*.rdb
|
|
136
|
+
*.aof
|
|
137
|
+
*.pid
|
|
138
|
+
|
|
139
|
+
# RabbitMQ
|
|
140
|
+
mnesia/
|
|
141
|
+
rabbitmq/
|
|
142
|
+
rabbitmq-data/
|
|
143
|
+
|
|
144
|
+
# ActiveMQ
|
|
145
|
+
activemq-data/
|
|
146
|
+
|
|
147
|
+
# SageMath parsed files
|
|
148
|
+
*.sage.py
|
|
149
|
+
|
|
150
|
+
# Environments
|
|
151
|
+
.env
|
|
152
|
+
.envrc
|
|
153
|
+
.venv
|
|
154
|
+
env/
|
|
155
|
+
venv/
|
|
156
|
+
ENV/
|
|
157
|
+
env.bak/
|
|
158
|
+
venv.bak/
|
|
159
|
+
|
|
160
|
+
# Spyder project settings
|
|
161
|
+
.spyderproject
|
|
162
|
+
.spyproject
|
|
163
|
+
|
|
164
|
+
# Rope project settings
|
|
165
|
+
.ropeproject
|
|
166
|
+
|
|
167
|
+
# mkdocs documentation
|
|
168
|
+
/site
|
|
169
|
+
|
|
170
|
+
# mypy
|
|
171
|
+
.mypy_cache/
|
|
172
|
+
.dmypy.json
|
|
173
|
+
dmypy.json
|
|
174
|
+
|
|
175
|
+
# Pyre type checker
|
|
176
|
+
.pyre/
|
|
177
|
+
|
|
178
|
+
# pytype static type analyzer
|
|
179
|
+
.pytype/
|
|
180
|
+
|
|
181
|
+
# Cython debug symbols
|
|
182
|
+
cython_debug/
|
|
183
|
+
|
|
184
|
+
# PyCharm
|
|
185
|
+
# JetBrains specific template is maintained in a separate JetBrains.gitignore that can
|
|
186
|
+
# be found at https://github.com/github/gitignore/blob/main/Global/JetBrains.gitignore
|
|
187
|
+
# and can be added to the global gitignore or merged into this file. For a more nuclear
|
|
188
|
+
# option (not recommended) you can uncomment the following to ignore the entire idea folder.
|
|
189
|
+
# .idea/
|
|
190
|
+
|
|
191
|
+
# Abstra
|
|
192
|
+
# Abstra is an AI-powered process automation framework.
|
|
193
|
+
# Ignore directories containing user credentials, local state, and settings.
|
|
194
|
+
# Learn more at https://abstra.io/docs
|
|
195
|
+
.abstra/
|
|
196
|
+
|
|
197
|
+
# Visual Studio Code
|
|
198
|
+
# Visual Studio Code specific template is maintained in a separate VisualStudioCode.gitignore
|
|
199
|
+
# that can be found at https://github.com/github/gitignore/blob/main/Global/VisualStudioCode.gitignore
|
|
200
|
+
# and can be added to the global gitignore or merged into this file. However, if you prefer,
|
|
201
|
+
# you could uncomment the following to ignore the entire vscode folder
|
|
202
|
+
# .vscode/
|
|
203
|
+
# Temporary file for partial code execution
|
|
204
|
+
tempCodeRunnerFile.py
|
|
205
|
+
|
|
206
|
+
# Ruff stuff:
|
|
207
|
+
.ruff_cache/
|
|
208
|
+
|
|
209
|
+
# PyPI configuration file
|
|
210
|
+
.pypirc
|
|
211
|
+
|
|
212
|
+
# Marimo
|
|
213
|
+
marimo/_static/
|
|
214
|
+
marimo/_lsp/
|
|
215
|
+
__marimo__/
|
|
216
|
+
|
|
217
|
+
# Streamlit
|
|
218
|
+
.streamlit/secrets.toml
|
|
@@ -0,0 +1,18 @@
|
|
|
1
|
+
cff-version: 1.2.0
|
|
2
|
+
message: "If you use this software, please cite it as below."
|
|
3
|
+
title: "flow_theory"
|
|
4
|
+
abstract: "Theoretical estimates for high-speed aerodynamics"
|
|
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-theory"
|
|
11
|
+
url: "https://uahypersonics.github.io/flow-theory"
|
|
12
|
+
license: BSD-3-Clause
|
|
13
|
+
keywords:
|
|
14
|
+
- aerodynamics
|
|
15
|
+
- hypersonics
|
|
16
|
+
- skin friction
|
|
17
|
+
- boundary layer
|
|
18
|
+
- computational fluid dynamics
|
|
@@ -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,98 @@
|
|
|
1
|
+
Metadata-Version: 2.4
|
|
2
|
+
Name: flow-theory
|
|
3
|
+
Version: 0.1.0
|
|
4
|
+
Summary: Theoretical estimates for high-speed aerodynamics: skin friction, Stanton number, swallowing length, and more
|
|
5
|
+
Author-email: Christoph Hader <chader@arizona.edu>
|
|
6
|
+
License: BSD-3-Clause
|
|
7
|
+
Project-URL: Homepage, https://github.com/uahypersonics/flow-theory
|
|
8
|
+
Project-URL: Repository, https://github.com/uahypersonics/flow-theory
|
|
9
|
+
Project-URL: Documentation, https://uahypersonics.github.io/flow-theory
|
|
10
|
+
Keywords: aerodynamics,hypersonics,skin-friction,boundary-layer,cfd
|
|
11
|
+
Classifier: Development Status :: 3 - Alpha
|
|
12
|
+
Classifier: Intended Audience :: Science/Research
|
|
13
|
+
Classifier: License :: OSI Approved :: BSD License
|
|
14
|
+
Classifier: Programming Language :: Python :: 3
|
|
15
|
+
Classifier: Programming Language :: Python :: 3.11
|
|
16
|
+
Classifier: Programming Language :: Python :: 3.12
|
|
17
|
+
Classifier: Topic :: Scientific/Engineering :: Physics
|
|
18
|
+
Requires-Python: >=3.11
|
|
19
|
+
Description-Content-Type: text/markdown
|
|
20
|
+
License-File: LICENSE
|
|
21
|
+
Provides-Extra: dev
|
|
22
|
+
Requires-Dist: pytest>=7.0; extra == "dev"
|
|
23
|
+
Requires-Dist: pytest-cov>=4.0; extra == "dev"
|
|
24
|
+
Requires-Dist: ruff>=0.1.0; extra == "dev"
|
|
25
|
+
Requires-Dist: mkdocs-material>=9.0; extra == "dev"
|
|
26
|
+
Requires-Dist: mkdocstrings[python]>=0.24; extra == "dev"
|
|
27
|
+
Dynamic: license-file
|
|
28
|
+
|
|
29
|
+
# flow_theory
|
|
30
|
+
|
|
31
|
+
Theoretical estimates for high-speed aerodynamics.
|
|
32
|
+
|
|
33
|
+
[](https://github.com/uahypersonics/flow-theory/actions/workflows/test.yml)
|
|
34
|
+
[](https://pypi.org/project/flow-theory/)
|
|
35
|
+
[](https://uahypersonics.github.io/flow-theory/)
|
|
36
|
+
[](LICENSE)
|
|
37
|
+
[](https://www.python.org/downloads/)
|
|
38
|
+
[](https://github.com/astral-sh/ruff)
|
|
39
|
+
|
|
40
|
+
## Install
|
|
41
|
+
|
|
42
|
+
```bash
|
|
43
|
+
pip install flow-theory
|
|
44
|
+
```
|
|
45
|
+
|
|
46
|
+
## Quick Start
|
|
47
|
+
|
|
48
|
+
```python
|
|
49
|
+
import flow_theory
|
|
50
|
+
```
|
|
51
|
+
|
|
52
|
+
## Documentation
|
|
53
|
+
|
|
54
|
+
Full documentation: https://uahypersonics.github.io/flow-theory
|
|
55
|
+
|
|
56
|
+
## Citation
|
|
57
|
+
|
|
58
|
+
If you use `flow_theory` in your research, please cite it:
|
|
59
|
+
|
|
60
|
+
```bibtex
|
|
61
|
+
@software{flow_theory,
|
|
62
|
+
author = {Hader, Christoph},
|
|
63
|
+
title = {flow\_theory: Theoretical Estimates for High-Speed Aerodynamics},
|
|
64
|
+
url = {https://github.com/uahypersonics/flow-theory},
|
|
65
|
+
year = {2026}
|
|
66
|
+
}
|
|
67
|
+
```
|
|
68
|
+
|
|
69
|
+
## Code Style
|
|
70
|
+
|
|
71
|
+
This project follows established Python community conventions so that
|
|
72
|
+
contributors can focus on the physics rather than inventing formatting rules.
|
|
73
|
+
|
|
74
|
+
| Convention | What it covers | Reference |
|
|
75
|
+
|---|---|---|
|
|
76
|
+
| [PEP 8](https://peps.python.org/pep-0008/) | Code formatting, naming, whitespace | Python standard style guide |
|
|
77
|
+
| [PEP 257](https://peps.python.org/pep-0257/) | Docstring structure (triple-quoted, imperative mood) | Python standard docstring conventions |
|
|
78
|
+
| [numpydoc](https://numpydoc.readthedocs.io/en/latest/format.html) | Docstring sections (`Parameters`, `Returns`, `Attributes`) | NumPy/SciPy docstring standard — the norm for scientific Python |
|
|
79
|
+
| [Ruff](https://docs.astral.sh/ruff/) | Automated linting and formatting | Enforces PEP 8 compliance automatically |
|
|
80
|
+
| [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 |
|
|
81
|
+
|
|
82
|
+
## Releasing
|
|
83
|
+
|
|
84
|
+
This project uses [Semantic Versioning](https://semver.org/) (`vMAJOR.MINOR.PATCH`):
|
|
85
|
+
|
|
86
|
+
- **MAJOR** (`v1.0.0`, `v2.0.0`): Breaking API changes
|
|
87
|
+
- **MINOR** (`v0.3.0`, `v0.4.0`): New features, backward-compatible
|
|
88
|
+
- **PATCH** (`v0.3.1`, `v0.3.2`): Bug fixes, minor corrections
|
|
89
|
+
|
|
90
|
+
To publish a new version to [PyPI](https://pypi.org/project/flow-theory/):
|
|
91
|
+
|
|
92
|
+
1. Commit and push to `main`
|
|
93
|
+
2. Tag and push:
|
|
94
|
+
```bash
|
|
95
|
+
git tag -a vMAJOR.MINOR.PATCH -m "Release vMAJOR.MINOR.PATCH"
|
|
96
|
+
git push origin vMAJOR.MINOR.PATCH
|
|
97
|
+
```
|
|
98
|
+
|
|
@@ -0,0 +1,70 @@
|
|
|
1
|
+
# flow_theory
|
|
2
|
+
|
|
3
|
+
Theoretical estimates for high-speed aerodynamics.
|
|
4
|
+
|
|
5
|
+
[](https://github.com/uahypersonics/flow-theory/actions/workflows/test.yml)
|
|
6
|
+
[](https://pypi.org/project/flow-theory/)
|
|
7
|
+
[](https://uahypersonics.github.io/flow-theory/)
|
|
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-theory
|
|
16
|
+
```
|
|
17
|
+
|
|
18
|
+
## Quick Start
|
|
19
|
+
|
|
20
|
+
```python
|
|
21
|
+
import flow_theory
|
|
22
|
+
```
|
|
23
|
+
|
|
24
|
+
## Documentation
|
|
25
|
+
|
|
26
|
+
Full documentation: https://uahypersonics.github.io/flow-theory
|
|
27
|
+
|
|
28
|
+
## Citation
|
|
29
|
+
|
|
30
|
+
If you use `flow_theory` in your research, please cite it:
|
|
31
|
+
|
|
32
|
+
```bibtex
|
|
33
|
+
@software{flow_theory,
|
|
34
|
+
author = {Hader, Christoph},
|
|
35
|
+
title = {flow\_theory: Theoretical Estimates for High-Speed Aerodynamics},
|
|
36
|
+
url = {https://github.com/uahypersonics/flow-theory},
|
|
37
|
+
year = {2026}
|
|
38
|
+
}
|
|
39
|
+
```
|
|
40
|
+
|
|
41
|
+
## Code Style
|
|
42
|
+
|
|
43
|
+
This project follows established Python community conventions so that
|
|
44
|
+
contributors can focus on the physics rather than inventing formatting rules.
|
|
45
|
+
|
|
46
|
+
| Convention | What it covers | Reference |
|
|
47
|
+
|---|---|---|
|
|
48
|
+
| [PEP 8](https://peps.python.org/pep-0008/) | Code formatting, naming, whitespace | Python standard style guide |
|
|
49
|
+
| [PEP 257](https://peps.python.org/pep-0257/) | Docstring structure (triple-quoted, imperative mood) | Python standard docstring conventions |
|
|
50
|
+
| [numpydoc](https://numpydoc.readthedocs.io/en/latest/format.html) | Docstring sections (`Parameters`, `Returns`, `Attributes`) | NumPy/SciPy docstring standard — the norm for scientific Python |
|
|
51
|
+
| [Ruff](https://docs.astral.sh/ruff/) | Automated linting and formatting | Enforces PEP 8 compliance automatically |
|
|
52
|
+
| [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 |
|
|
53
|
+
|
|
54
|
+
## Releasing
|
|
55
|
+
|
|
56
|
+
This project uses [Semantic Versioning](https://semver.org/) (`vMAJOR.MINOR.PATCH`):
|
|
57
|
+
|
|
58
|
+
- **MAJOR** (`v1.0.0`, `v2.0.0`): Breaking API changes
|
|
59
|
+
- **MINOR** (`v0.3.0`, `v0.4.0`): New features, backward-compatible
|
|
60
|
+
- **PATCH** (`v0.3.1`, `v0.3.2`): Bug fixes, minor corrections
|
|
61
|
+
|
|
62
|
+
To publish a new version to [PyPI](https://pypi.org/project/flow-theory/):
|
|
63
|
+
|
|
64
|
+
1. Commit and push to `main`
|
|
65
|
+
2. Tag and push:
|
|
66
|
+
```bash
|
|
67
|
+
git tag -a vMAJOR.MINOR.PATCH -m "Release vMAJOR.MINOR.PATCH"
|
|
68
|
+
git push origin vMAJOR.MINOR.PATCH
|
|
69
|
+
```
|
|
70
|
+
|
|
@@ -0,0 +1,16 @@
|
|
|
1
|
+
# flow_theory
|
|
2
|
+
|
|
3
|
+
`flow_theory` is a Python toolkit for theoretical estimates in high-speed aerodynamics,
|
|
4
|
+
including laminar and turbulent skin friction, Stanton number, and swallowing length.
|
|
5
|
+
|
|
6
|
+
## Quick Start
|
|
7
|
+
|
|
8
|
+
```bash
|
|
9
|
+
pip install flow-theory
|
|
10
|
+
```
|
|
11
|
+
|
|
12
|
+
## Features
|
|
13
|
+
|
|
14
|
+
- Laminar and turbulent skin friction correlations
|
|
15
|
+
- Stanton number estimates
|
|
16
|
+
- Swallowing length calculations
|
|
@@ -0,0 +1,43 @@
|
|
|
1
|
+
# BSD-3-Clause License - see LICENSE file
|
|
2
|
+
|
|
3
|
+
# --------------------------------------------------
|
|
4
|
+
# site metadata
|
|
5
|
+
# --------------------------------------------------
|
|
6
|
+
site_name: flow_theory
|
|
7
|
+
site_url: https://uahypersonics.github.io/flow-theory
|
|
8
|
+
site_author: Christoph Hader
|
|
9
|
+
site_description: Theoretical estimates for high-speed aerodynamics.
|
|
10
|
+
|
|
11
|
+
# --------------------------------------------------
|
|
12
|
+
# github repository
|
|
13
|
+
# --------------------------------------------------
|
|
14
|
+
repo_name: uahypersonics/flow-theory
|
|
15
|
+
repo_url: https://github.com/uahypersonics/flow-theory
|
|
16
|
+
edit_uri: edit/main/docs/
|
|
17
|
+
|
|
18
|
+
# --------------------------------------------------
|
|
19
|
+
# theme
|
|
20
|
+
# --------------------------------------------------
|
|
21
|
+
theme:
|
|
22
|
+
name: material
|
|
23
|
+
palette:
|
|
24
|
+
- scheme: default
|
|
25
|
+
primary: indigo
|
|
26
|
+
accent: indigo
|
|
27
|
+
|
|
28
|
+
# --------------------------------------------------
|
|
29
|
+
# navigation
|
|
30
|
+
# --------------------------------------------------
|
|
31
|
+
nav:
|
|
32
|
+
- Home: index.md
|
|
33
|
+
- Installation: installation.md
|
|
34
|
+
|
|
35
|
+
# --------------------------------------------------
|
|
36
|
+
# plugins
|
|
37
|
+
# --------------------------------------------------
|
|
38
|
+
plugins:
|
|
39
|
+
- search
|
|
40
|
+
- mkdocstrings:
|
|
41
|
+
handlers:
|
|
42
|
+
python:
|
|
43
|
+
paths: [src]
|
|
@@ -0,0 +1,58 @@
|
|
|
1
|
+
# BSD-3-Clause License - see LICENSE file
|
|
2
|
+
[build-system]
|
|
3
|
+
requires = ["setuptools>=61.0", "setuptools-scm>=8", "wheel"]
|
|
4
|
+
build-backend = "setuptools.build_meta"
|
|
5
|
+
|
|
6
|
+
[project]
|
|
7
|
+
name = "flow-theory"
|
|
8
|
+
dynamic = ["version"]
|
|
9
|
+
description = "Theoretical estimates for high-speed aerodynamics: skin friction, Stanton number, swallowing length, and more"
|
|
10
|
+
readme = "README.md"
|
|
11
|
+
license = {text = "BSD-3-Clause"}
|
|
12
|
+
requires-python = ">=3.11"
|
|
13
|
+
authors = [
|
|
14
|
+
{name = "Christoph Hader", email = "chader@arizona.edu"},
|
|
15
|
+
]
|
|
16
|
+
classifiers = [
|
|
17
|
+
"Development Status :: 3 - Alpha",
|
|
18
|
+
"Intended Audience :: Science/Research",
|
|
19
|
+
"License :: OSI Approved :: BSD License",
|
|
20
|
+
"Programming Language :: Python :: 3",
|
|
21
|
+
"Programming Language :: Python :: 3.11",
|
|
22
|
+
"Programming Language :: Python :: 3.12",
|
|
23
|
+
"Topic :: Scientific/Engineering :: Physics",
|
|
24
|
+
]
|
|
25
|
+
keywords = ["aerodynamics", "hypersonics", "skin-friction", "boundary-layer", "cfd"]
|
|
26
|
+
|
|
27
|
+
dependencies = []
|
|
28
|
+
|
|
29
|
+
[project.optional-dependencies]
|
|
30
|
+
dev = [
|
|
31
|
+
"pytest>=7.0",
|
|
32
|
+
"pytest-cov>=4.0",
|
|
33
|
+
"ruff>=0.1.0",
|
|
34
|
+
"mkdocs-material>=9.0",
|
|
35
|
+
"mkdocstrings[python]>=0.24",
|
|
36
|
+
]
|
|
37
|
+
|
|
38
|
+
[project.urls]
|
|
39
|
+
Homepage = "https://github.com/uahypersonics/flow-theory"
|
|
40
|
+
Repository = "https://github.com/uahypersonics/flow-theory"
|
|
41
|
+
Documentation = "https://uahypersonics.github.io/flow-theory"
|
|
42
|
+
|
|
43
|
+
[tool.setuptools.packages.find]
|
|
44
|
+
where = ["src"]
|
|
45
|
+
|
|
46
|
+
[tool.setuptools_scm]
|
|
47
|
+
|
|
48
|
+
[tool.pytest.ini_options]
|
|
49
|
+
testpaths = ["tests"]
|
|
50
|
+
pythonpath = ["src"]
|
|
51
|
+
|
|
52
|
+
[tool.ruff]
|
|
53
|
+
line-length = 100
|
|
54
|
+
target-version = "py311"
|
|
55
|
+
|
|
56
|
+
[tool.ruff.lint]
|
|
57
|
+
select = ["E", "F", "W", "I", "UP"]
|
|
58
|
+
ignore = ["E501"]
|
|
@@ -0,0 +1,98 @@
|
|
|
1
|
+
Metadata-Version: 2.4
|
|
2
|
+
Name: flow-theory
|
|
3
|
+
Version: 0.1.0
|
|
4
|
+
Summary: Theoretical estimates for high-speed aerodynamics: skin friction, Stanton number, swallowing length, and more
|
|
5
|
+
Author-email: Christoph Hader <chader@arizona.edu>
|
|
6
|
+
License: BSD-3-Clause
|
|
7
|
+
Project-URL: Homepage, https://github.com/uahypersonics/flow-theory
|
|
8
|
+
Project-URL: Repository, https://github.com/uahypersonics/flow-theory
|
|
9
|
+
Project-URL: Documentation, https://uahypersonics.github.io/flow-theory
|
|
10
|
+
Keywords: aerodynamics,hypersonics,skin-friction,boundary-layer,cfd
|
|
11
|
+
Classifier: Development Status :: 3 - Alpha
|
|
12
|
+
Classifier: Intended Audience :: Science/Research
|
|
13
|
+
Classifier: License :: OSI Approved :: BSD License
|
|
14
|
+
Classifier: Programming Language :: Python :: 3
|
|
15
|
+
Classifier: Programming Language :: Python :: 3.11
|
|
16
|
+
Classifier: Programming Language :: Python :: 3.12
|
|
17
|
+
Classifier: Topic :: Scientific/Engineering :: Physics
|
|
18
|
+
Requires-Python: >=3.11
|
|
19
|
+
Description-Content-Type: text/markdown
|
|
20
|
+
License-File: LICENSE
|
|
21
|
+
Provides-Extra: dev
|
|
22
|
+
Requires-Dist: pytest>=7.0; extra == "dev"
|
|
23
|
+
Requires-Dist: pytest-cov>=4.0; extra == "dev"
|
|
24
|
+
Requires-Dist: ruff>=0.1.0; extra == "dev"
|
|
25
|
+
Requires-Dist: mkdocs-material>=9.0; extra == "dev"
|
|
26
|
+
Requires-Dist: mkdocstrings[python]>=0.24; extra == "dev"
|
|
27
|
+
Dynamic: license-file
|
|
28
|
+
|
|
29
|
+
# flow_theory
|
|
30
|
+
|
|
31
|
+
Theoretical estimates for high-speed aerodynamics.
|
|
32
|
+
|
|
33
|
+
[](https://github.com/uahypersonics/flow-theory/actions/workflows/test.yml)
|
|
34
|
+
[](https://pypi.org/project/flow-theory/)
|
|
35
|
+
[](https://uahypersonics.github.io/flow-theory/)
|
|
36
|
+
[](LICENSE)
|
|
37
|
+
[](https://www.python.org/downloads/)
|
|
38
|
+
[](https://github.com/astral-sh/ruff)
|
|
39
|
+
|
|
40
|
+
## Install
|
|
41
|
+
|
|
42
|
+
```bash
|
|
43
|
+
pip install flow-theory
|
|
44
|
+
```
|
|
45
|
+
|
|
46
|
+
## Quick Start
|
|
47
|
+
|
|
48
|
+
```python
|
|
49
|
+
import flow_theory
|
|
50
|
+
```
|
|
51
|
+
|
|
52
|
+
## Documentation
|
|
53
|
+
|
|
54
|
+
Full documentation: https://uahypersonics.github.io/flow-theory
|
|
55
|
+
|
|
56
|
+
## Citation
|
|
57
|
+
|
|
58
|
+
If you use `flow_theory` in your research, please cite it:
|
|
59
|
+
|
|
60
|
+
```bibtex
|
|
61
|
+
@software{flow_theory,
|
|
62
|
+
author = {Hader, Christoph},
|
|
63
|
+
title = {flow\_theory: Theoretical Estimates for High-Speed Aerodynamics},
|
|
64
|
+
url = {https://github.com/uahypersonics/flow-theory},
|
|
65
|
+
year = {2026}
|
|
66
|
+
}
|
|
67
|
+
```
|
|
68
|
+
|
|
69
|
+
## Code Style
|
|
70
|
+
|
|
71
|
+
This project follows established Python community conventions so that
|
|
72
|
+
contributors can focus on the physics rather than inventing formatting rules.
|
|
73
|
+
|
|
74
|
+
| Convention | What it covers | Reference |
|
|
75
|
+
|---|---|---|
|
|
76
|
+
| [PEP 8](https://peps.python.org/pep-0008/) | Code formatting, naming, whitespace | Python standard style guide |
|
|
77
|
+
| [PEP 257](https://peps.python.org/pep-0257/) | Docstring structure (triple-quoted, imperative mood) | Python standard docstring conventions |
|
|
78
|
+
| [numpydoc](https://numpydoc.readthedocs.io/en/latest/format.html) | Docstring sections (`Parameters`, `Returns`, `Attributes`) | NumPy/SciPy docstring standard — the norm for scientific Python |
|
|
79
|
+
| [Ruff](https://docs.astral.sh/ruff/) | Automated linting and formatting | Enforces PEP 8 compliance automatically |
|
|
80
|
+
| [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 |
|
|
81
|
+
|
|
82
|
+
## Releasing
|
|
83
|
+
|
|
84
|
+
This project uses [Semantic Versioning](https://semver.org/) (`vMAJOR.MINOR.PATCH`):
|
|
85
|
+
|
|
86
|
+
- **MAJOR** (`v1.0.0`, `v2.0.0`): Breaking API changes
|
|
87
|
+
- **MINOR** (`v0.3.0`, `v0.4.0`): New features, backward-compatible
|
|
88
|
+
- **PATCH** (`v0.3.1`, `v0.3.2`): Bug fixes, minor corrections
|
|
89
|
+
|
|
90
|
+
To publish a new version to [PyPI](https://pypi.org/project/flow-theory/):
|
|
91
|
+
|
|
92
|
+
1. Commit and push to `main`
|
|
93
|
+
2. Tag and push:
|
|
94
|
+
```bash
|
|
95
|
+
git tag -a vMAJOR.MINOR.PATCH -m "Release vMAJOR.MINOR.PATCH"
|
|
96
|
+
git push origin vMAJOR.MINOR.PATCH
|
|
97
|
+
```
|
|
98
|
+
|
|
@@ -0,0 +1,18 @@
|
|
|
1
|
+
.gitignore
|
|
2
|
+
CITATION.cff
|
|
3
|
+
LICENSE
|
|
4
|
+
README.md
|
|
5
|
+
mkdocs.yml
|
|
6
|
+
pyproject.toml
|
|
7
|
+
.github/workflows/docs.yml
|
|
8
|
+
.github/workflows/publish.yml
|
|
9
|
+
.github/workflows/test.yml
|
|
10
|
+
docs/index.md
|
|
11
|
+
docs/installation.md
|
|
12
|
+
src/flow_theory/__init__.py
|
|
13
|
+
src/flow_theory.egg-info/PKG-INFO
|
|
14
|
+
src/flow_theory.egg-info/SOURCES.txt
|
|
15
|
+
src/flow_theory.egg-info/dependency_links.txt
|
|
16
|
+
src/flow_theory.egg-info/requires.txt
|
|
17
|
+
src/flow_theory.egg-info/top_level.txt
|
|
18
|
+
tests/test_stub.py
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
flow_theory
|