flow-inviscid 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_inviscid-0.1.0/.github/workflows/docs.yml +56 -0
- flow_inviscid-0.1.0/.github/workflows/publish.yml +61 -0
- flow_inviscid-0.1.0/.gitignore +222 -0
- flow_inviscid-0.1.0/CITATION.cff +18 -0
- flow_inviscid-0.1.0/CONTRIBUTING.md +62 -0
- flow_inviscid-0.1.0/LICENSE +28 -0
- flow_inviscid-0.1.0/PKG-INFO +90 -0
- flow_inviscid-0.1.0/README.md +64 -0
- flow_inviscid-0.1.0/docs/index.md +24 -0
- flow_inviscid-0.1.0/docs/installation.md +15 -0
- flow_inviscid-0.1.0/docs/javascripts/mathjax.js +20 -0
- flow_inviscid-0.1.0/mkdocs.yml +98 -0
- flow_inviscid-0.1.0/pyproject.toml +56 -0
- flow_inviscid-0.1.0/setup.cfg +4 -0
- flow_inviscid-0.1.0/src/flow_inviscid/__init__.py +18 -0
- flow_inviscid-0.1.0/src/flow_inviscid/cli/__init__.py +11 -0
- flow_inviscid-0.1.0/src/flow_inviscid/cli/app.py +100 -0
- flow_inviscid-0.1.0/src/flow_inviscid/cli/cmd_newtonian.py +12 -0
- flow_inviscid-0.1.0/src/flow_inviscid/cli/cmd_shock_expansion.py +12 -0
- flow_inviscid-0.1.0/src/flow_inviscid/cli/cmd_tangent_cone.py +12 -0
- flow_inviscid-0.1.0/src/flow_inviscid.egg-info/PKG-INFO +90 -0
- flow_inviscid-0.1.0/src/flow_inviscid.egg-info/SOURCES.txt +26 -0
- flow_inviscid-0.1.0/src/flow_inviscid.egg-info/dependency_links.txt +1 -0
- flow_inviscid-0.1.0/src/flow_inviscid.egg-info/entry_points.txt +2 -0
- flow_inviscid-0.1.0/src/flow_inviscid.egg-info/requires.txt +8 -0
- flow_inviscid-0.1.0/src/flow_inviscid.egg-info/scm_file_list.json +22 -0
- flow_inviscid-0.1.0/src/flow_inviscid.egg-info/scm_version.json +8 -0
- flow_inviscid-0.1.0/src/flow_inviscid.egg-info/top_level.txt +1 -0
|
@@ -0,0 +1,56 @@
|
|
|
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@v6
|
|
25
|
+
with:
|
|
26
|
+
fetch-depth: 0 # required for setuptools-scm to read git tags
|
|
27
|
+
|
|
28
|
+
- name: Set up Python
|
|
29
|
+
uses: actions/setup-python@v6
|
|
30
|
+
with:
|
|
31
|
+
python-version: "3.11"
|
|
32
|
+
|
|
33
|
+
- name: Install dependencies
|
|
34
|
+
run: |
|
|
35
|
+
pip install zensical
|
|
36
|
+
pip install -e .
|
|
37
|
+
|
|
38
|
+
- name: Build documentation
|
|
39
|
+
run: zensical build --strict
|
|
40
|
+
|
|
41
|
+
- name: Upload artifact
|
|
42
|
+
uses: actions/upload-pages-artifact@v5
|
|
43
|
+
with:
|
|
44
|
+
path: site
|
|
45
|
+
|
|
46
|
+
deploy:
|
|
47
|
+
if: github.ref == 'refs/heads/main'
|
|
48
|
+
needs: build
|
|
49
|
+
runs-on: ubuntu-latest
|
|
50
|
+
environment:
|
|
51
|
+
name: github-pages
|
|
52
|
+
url: ${{ steps.deployment.outputs.page_url }}
|
|
53
|
+
steps:
|
|
54
|
+
- name: Deploy to GitHub Pages
|
|
55
|
+
id: deployment
|
|
56
|
+
uses: actions/deploy-pages@v5
|
|
@@ -0,0 +1,61 @@
|
|
|
1
|
+
# BSD-3-Clause License - see LICENSE file
|
|
2
|
+
name: Publish to PyPI
|
|
3
|
+
|
|
4
|
+
on:
|
|
5
|
+
push:
|
|
6
|
+
tags:
|
|
7
|
+
- "v*"
|
|
8
|
+
|
|
9
|
+
jobs:
|
|
10
|
+
build:
|
|
11
|
+
runs-on: ubuntu-latest
|
|
12
|
+
steps:
|
|
13
|
+
- uses: actions/checkout@v6
|
|
14
|
+
with:
|
|
15
|
+
fetch-depth: 0 # required for setuptools-scm to read git tags
|
|
16
|
+
|
|
17
|
+
- name: Set up Python
|
|
18
|
+
uses: actions/setup-python@v6
|
|
19
|
+
with:
|
|
20
|
+
python-version: "3.11"
|
|
21
|
+
|
|
22
|
+
- name: Install build tools
|
|
23
|
+
run: pip install build
|
|
24
|
+
|
|
25
|
+
- name: Build package
|
|
26
|
+
run: python -m build
|
|
27
|
+
|
|
28
|
+
- name: Upload dist artifacts
|
|
29
|
+
uses: actions/upload-artifact@v7
|
|
30
|
+
with:
|
|
31
|
+
name: dist
|
|
32
|
+
path: dist/
|
|
33
|
+
|
|
34
|
+
publish:
|
|
35
|
+
needs: build
|
|
36
|
+
runs-on: ubuntu-latest
|
|
37
|
+
environment: pypi
|
|
38
|
+
permissions:
|
|
39
|
+
id-token: write # required for Trusted Publishing
|
|
40
|
+
|
|
41
|
+
steps:
|
|
42
|
+
- name: Download dist artifacts
|
|
43
|
+
uses: actions/download-artifact@v8
|
|
44
|
+
with:
|
|
45
|
+
name: dist
|
|
46
|
+
path: dist/
|
|
47
|
+
|
|
48
|
+
- name: Publish to PyPI
|
|
49
|
+
uses: pypa/gh-action-pypi-publish@release/v1
|
|
50
|
+
|
|
51
|
+
release:
|
|
52
|
+
needs: publish
|
|
53
|
+
runs-on: ubuntu-latest
|
|
54
|
+
permissions:
|
|
55
|
+
contents: write
|
|
56
|
+
steps:
|
|
57
|
+
- uses: actions/checkout@v6
|
|
58
|
+
- name: Create GitHub Release
|
|
59
|
+
run: gh release create "${{ github.ref_name }}" --generate-notes
|
|
60
|
+
env:
|
|
61
|
+
GH_TOKEN: ${{ secrets.GITHUB_TOKEN }}
|
|
@@ -0,0 +1,222 @@
|
|
|
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
|
|
219
|
+
|
|
220
|
+
sandbox/
|
|
221
|
+
|
|
222
|
+
4
|
|
@@ -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-inviscid"
|
|
4
|
+
abstract: "Engineering-level inviscid surface conditions for supersonic and hypersonic bodies. Computes edge Mach, pressure, and temperature along a body contour using classical methods (tangent-cone, Modified Newtonian, shock-expansion, method of characteristics, linearized supersonic) without a full Euler field solve."
|
|
5
|
+
type: software
|
|
6
|
+
authors:
|
|
7
|
+
- family-names: "Hader"
|
|
8
|
+
given-names: "Christoph"
|
|
9
|
+
affiliation: "University of Arizona"
|
|
10
|
+
orcid: "https://orcid.org/0000-0002-0956-000X"
|
|
11
|
+
repository-code: "https://github.com/uahypersonics/flow-inviscid"
|
|
12
|
+
version: "0.1.0"
|
|
13
|
+
date-released: "2026-07-07"
|
|
14
|
+
license: BSD-3-Clause
|
|
15
|
+
keywords:
|
|
16
|
+
- inviscid flow
|
|
17
|
+
- hypersonics
|
|
18
|
+
- supersonic
|
|
@@ -0,0 +1,62 @@
|
|
|
1
|
+
# Contributing to flow-inviscid
|
|
2
|
+
|
|
3
|
+
Contributions are welcome, whether in the form of bug fixes, documentation
|
|
4
|
+
improvements, or new physics implementations.
|
|
5
|
+
|
|
6
|
+
## Setting Up a Development Environment
|
|
7
|
+
|
|
8
|
+
Clone the repository and install in editable mode with all development
|
|
9
|
+
dependencies:
|
|
10
|
+
|
|
11
|
+
```bash
|
|
12
|
+
git clone https://github.com/uahypersonics/flow-inviscid.git
|
|
13
|
+
cd flow-inviscid
|
|
14
|
+
pip install -e ".[dev]"
|
|
15
|
+
```
|
|
16
|
+
|
|
17
|
+
## Running the Tests
|
|
18
|
+
|
|
19
|
+
```bash
|
|
20
|
+
pytest
|
|
21
|
+
```
|
|
22
|
+
|
|
23
|
+
All tests must pass before submitting a pull request.
|
|
24
|
+
|
|
25
|
+
## Code Style
|
|
26
|
+
|
|
27
|
+
This project uses [Ruff](https://docs.astral.sh/ruff/) for linting and
|
|
28
|
+
formatting. Run it before committing:
|
|
29
|
+
|
|
30
|
+
```bash
|
|
31
|
+
ruff check .
|
|
32
|
+
ruff format .
|
|
33
|
+
```
|
|
34
|
+
|
|
35
|
+
The CI pipeline runs both checks automatically. See the code style table in
|
|
36
|
+
[README.md](README.md) for the full conventions (PEP 8, PEP 257, numpydoc).
|
|
37
|
+
|
|
38
|
+
## Contributing Physics or Equations
|
|
39
|
+
|
|
40
|
+
Changes that touch governing equations, transformations, or numerical methods
|
|
41
|
+
should:
|
|
42
|
+
|
|
43
|
+
- Reference the relevant literature in the docstring (author, year, equation
|
|
44
|
+
number)
|
|
45
|
+
- Include a test or validation case that demonstrates correctness against a known
|
|
46
|
+
result
|
|
47
|
+
|
|
48
|
+
If a proposed change may be inconsistent with the formulation, open an issue
|
|
49
|
+
first to discuss before writing code.
|
|
50
|
+
|
|
51
|
+
## Reporting Bugs
|
|
52
|
+
|
|
53
|
+
Open an issue on GitHub with:
|
|
54
|
+
|
|
55
|
+
- A minimal reproducible example
|
|
56
|
+
- The `flow-inviscid` version (`pip show flow-inviscid`)
|
|
57
|
+
- Python version and operating system
|
|
58
|
+
- Expected vs. actual behavior
|
|
59
|
+
|
|
60
|
+
## License
|
|
61
|
+
|
|
62
|
+
All contributions are made under the [BSD-3-Clause License](LICENSE).
|
|
@@ -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,90 @@
|
|
|
1
|
+
Metadata-Version: 2.4
|
|
2
|
+
Name: flow-inviscid
|
|
3
|
+
Version: 0.1.0
|
|
4
|
+
Summary: Inviscid supersonic and hypersonic surface solutions: Taylor-Maccoll, Newtonian, tangent-cone, shock-expansion
|
|
5
|
+
Author-email: Christoph Hader <chader@arizona.edu>
|
|
6
|
+
License: BSD-3-Clause
|
|
7
|
+
Project-URL: Homepage, https://github.com/uahypersonics/flow-inviscid
|
|
8
|
+
Project-URL: Repository, https://github.com/uahypersonics/flow-inviscid
|
|
9
|
+
Keywords: aerodynamics,hypersonics,inviscid,taylor-maccoll,newtonian
|
|
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: Topic :: Scientific/Engineering :: Physics
|
|
15
|
+
Requires-Python: >=3.11
|
|
16
|
+
Description-Content-Type: text/markdown
|
|
17
|
+
License-File: LICENSE
|
|
18
|
+
Requires-Dist: numpy>=1.24.0
|
|
19
|
+
Requires-Dist: scipy>=1.10.0
|
|
20
|
+
Requires-Dist: typer>=0.9.0
|
|
21
|
+
Provides-Extra: dev
|
|
22
|
+
Requires-Dist: pytest>=7.0; extra == "dev"
|
|
23
|
+
Requires-Dist: ruff>=0.1.0; extra == "dev"
|
|
24
|
+
Requires-Dist: zensical; extra == "dev"
|
|
25
|
+
Dynamic: license-file
|
|
26
|
+
|
|
27
|
+
# flow-inviscid
|
|
28
|
+
|
|
29
|
+
Computes inviscid surface Mach number, pressure, and temperature along a body
|
|
30
|
+
contour using classical methods such as tangent-cone, tangent-wedge, Modified
|
|
31
|
+
Newtonian, shock-expansion, method of characteristics, and linearized supersonic.
|
|
32
|
+
|
|
33
|
+
[](https://pypi.org/project/flow-inviscid/)
|
|
34
|
+
[](https://uahypersonics.github.io/flow-inviscid/)
|
|
35
|
+
[](LICENSE)
|
|
36
|
+
[](https://www.python.org/downloads/)
|
|
37
|
+
[](https://github.com/astral-sh/ruff)
|
|
38
|
+
|
|
39
|
+
## Install
|
|
40
|
+
|
|
41
|
+
```bash
|
|
42
|
+
pip install flow-inviscid
|
|
43
|
+
```
|
|
44
|
+
|
|
45
|
+
## Quick Start
|
|
46
|
+
|
|
47
|
+
under construction
|
|
48
|
+
|
|
49
|
+
## Documentation
|
|
50
|
+
|
|
51
|
+
## Validation and Verification
|
|
52
|
+
|
|
53
|
+
under construction
|
|
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 | Python standard docstring conventions |
|
|
64
|
+
| [numpydoc](https://numpydoc.readthedocs.io/en/latest/format.html) | Docstring sections (`Parameters`, `Returns`, `Attributes`) | NumPy/SciPy docstring standard |
|
|
65
|
+
| [Ruff](https://docs.astral.sh/ruff/) | Automated linting and formatting | Enforces PEP 8 compliance automatically |
|
|
66
|
+
|
|
67
|
+
## Releasing
|
|
68
|
+
|
|
69
|
+
This project uses [Semantic Versioning](https://semver.org/) (`vMAJOR.MINOR.PATCH`):
|
|
70
|
+
|
|
71
|
+
- **MAJOR** (`v1.0.0`): Breaking API changes
|
|
72
|
+
- **MINOR** (`v0.3.0`): New features, backward-compatible
|
|
73
|
+
- **PATCH** (`v0.3.1`): Bug fixes
|
|
74
|
+
|
|
75
|
+
To publish a new version:
|
|
76
|
+
|
|
77
|
+
1. Verify locally:
|
|
78
|
+
```bash
|
|
79
|
+
ruff check .
|
|
80
|
+
pytest
|
|
81
|
+
```
|
|
82
|
+
2. Commit and push to `main`
|
|
83
|
+
3. Tag and push:
|
|
84
|
+
```bash
|
|
85
|
+
git tag -a vMAJOR.MINOR.PATCH -m "Release vMAJOR.MINOR.PATCH"
|
|
86
|
+
git push origin vMAJOR.MINOR.PATCH
|
|
87
|
+
```
|
|
88
|
+
|
|
89
|
+
## Citation
|
|
90
|
+
|
|
@@ -0,0 +1,64 @@
|
|
|
1
|
+
# flow-inviscid
|
|
2
|
+
|
|
3
|
+
Computes inviscid surface Mach number, pressure, and temperature along a body
|
|
4
|
+
contour using classical methods such as tangent-cone, tangent-wedge, Modified
|
|
5
|
+
Newtonian, shock-expansion, method of characteristics, and linearized supersonic.
|
|
6
|
+
|
|
7
|
+
[](https://pypi.org/project/flow-inviscid/)
|
|
8
|
+
[](https://uahypersonics.github.io/flow-inviscid/)
|
|
9
|
+
[](LICENSE)
|
|
10
|
+
[](https://www.python.org/downloads/)
|
|
11
|
+
[](https://github.com/astral-sh/ruff)
|
|
12
|
+
|
|
13
|
+
## Install
|
|
14
|
+
|
|
15
|
+
```bash
|
|
16
|
+
pip install flow-inviscid
|
|
17
|
+
```
|
|
18
|
+
|
|
19
|
+
## Quick Start
|
|
20
|
+
|
|
21
|
+
under construction
|
|
22
|
+
|
|
23
|
+
## Documentation
|
|
24
|
+
|
|
25
|
+
## Validation and Verification
|
|
26
|
+
|
|
27
|
+
under construction
|
|
28
|
+
|
|
29
|
+
## Code Style
|
|
30
|
+
|
|
31
|
+
This project follows established Python community conventions so that
|
|
32
|
+
contributors can focus on the physics rather than inventing formatting rules.
|
|
33
|
+
|
|
34
|
+
| Convention | What it covers | Reference |
|
|
35
|
+
|---|---|---|
|
|
36
|
+
| [PEP 8](https://peps.python.org/pep-0008/) | Code formatting, naming, whitespace | Python standard style guide |
|
|
37
|
+
| [PEP 257](https://peps.python.org/pep-0257/) | Docstring structure | Python standard docstring conventions |
|
|
38
|
+
| [numpydoc](https://numpydoc.readthedocs.io/en/latest/format.html) | Docstring sections (`Parameters`, `Returns`, `Attributes`) | NumPy/SciPy docstring standard |
|
|
39
|
+
| [Ruff](https://docs.astral.sh/ruff/) | Automated linting and formatting | Enforces PEP 8 compliance automatically |
|
|
40
|
+
|
|
41
|
+
## Releasing
|
|
42
|
+
|
|
43
|
+
This project uses [Semantic Versioning](https://semver.org/) (`vMAJOR.MINOR.PATCH`):
|
|
44
|
+
|
|
45
|
+
- **MAJOR** (`v1.0.0`): Breaking API changes
|
|
46
|
+
- **MINOR** (`v0.3.0`): New features, backward-compatible
|
|
47
|
+
- **PATCH** (`v0.3.1`): Bug fixes
|
|
48
|
+
|
|
49
|
+
To publish a new version:
|
|
50
|
+
|
|
51
|
+
1. Verify locally:
|
|
52
|
+
```bash
|
|
53
|
+
ruff check .
|
|
54
|
+
pytest
|
|
55
|
+
```
|
|
56
|
+
2. Commit and push to `main`
|
|
57
|
+
3. Tag and push:
|
|
58
|
+
```bash
|
|
59
|
+
git tag -a vMAJOR.MINOR.PATCH -m "Release vMAJOR.MINOR.PATCH"
|
|
60
|
+
git push origin vMAJOR.MINOR.PATCH
|
|
61
|
+
```
|
|
62
|
+
|
|
63
|
+
## Citation
|
|
64
|
+
|
|
@@ -0,0 +1,24 @@
|
|
|
1
|
+
# flow-inviscid
|
|
2
|
+
|
|
3
|
+
`flow-inviscid` computes inviscid surface Mach number, pressure, and temperature
|
|
4
|
+
along a body contour using classical methods.
|
|
5
|
+
|
|
6
|
+
## Quick Start
|
|
7
|
+
|
|
8
|
+
### Install
|
|
9
|
+
|
|
10
|
+
```bash
|
|
11
|
+
pip install flow-inviscid
|
|
12
|
+
```
|
|
13
|
+
|
|
14
|
+
### Run
|
|
15
|
+
|
|
16
|
+
under construction
|
|
17
|
+
|
|
18
|
+
## Feedback & Contributing
|
|
19
|
+
|
|
20
|
+
under construction
|
|
21
|
+
|
|
22
|
+
## License
|
|
23
|
+
|
|
24
|
+
BSD-3-Clause. See [LICENSE](https://github.com/uahypersonics/flow-inviscid/blob/main/LICENSE) for details.
|
|
@@ -0,0 +1,20 @@
|
|
|
1
|
+
window.MathJax = {
|
|
2
|
+
tex: {
|
|
3
|
+
inlineMath: [["\\(", "\\)"]],
|
|
4
|
+
displayMath: [["\\[", "\\]"]],
|
|
5
|
+
processEscapes: true,
|
|
6
|
+
processEnvironments: true,
|
|
7
|
+
packages: {'[+]': ['cancel']}
|
|
8
|
+
},
|
|
9
|
+
loader: {
|
|
10
|
+
load: ['[tex]/cancel']
|
|
11
|
+
},
|
|
12
|
+
options: {
|
|
13
|
+
ignoreHtmlClass: ".*|",
|
|
14
|
+
processHtmlClass: "arithmatex"
|
|
15
|
+
}
|
|
16
|
+
};
|
|
17
|
+
|
|
18
|
+
document$.subscribe(() => {
|
|
19
|
+
MathJax.typesetPromise()
|
|
20
|
+
})
|
|
@@ -0,0 +1,98 @@
|
|
|
1
|
+
# BSD-3-Clause License - see LICENSE file
|
|
2
|
+
|
|
3
|
+
# --------------------------------------------------
|
|
4
|
+
# site metadata
|
|
5
|
+
# --------------------------------------------------
|
|
6
|
+
site_name: flow-inviscid
|
|
7
|
+
site_url: https://uahypersonics.github.io/flow-inviscid
|
|
8
|
+
site_author: Christoph Hader
|
|
9
|
+
site_description: Inviscid supersonic and hypersonic surface solutions
|
|
10
|
+
|
|
11
|
+
# --------------------------------------------------
|
|
12
|
+
# github repository
|
|
13
|
+
# --------------------------------------------------
|
|
14
|
+
repo_name: uahypersonics/flow-inviscid
|
|
15
|
+
repo_url: https://github.com/uahypersonics/flow-inviscid
|
|
16
|
+
edit_uri: edit/main/docs/
|
|
17
|
+
|
|
18
|
+
# --------------------------------------------------
|
|
19
|
+
# theme
|
|
20
|
+
# --------------------------------------------------
|
|
21
|
+
theme:
|
|
22
|
+
name: material
|
|
23
|
+
variant: classic
|
|
24
|
+
palette:
|
|
25
|
+
- media: "(prefers-color-scheme)"
|
|
26
|
+
toggle:
|
|
27
|
+
icon: material/brightness-auto
|
|
28
|
+
name: Switch to light mode
|
|
29
|
+
- media: "(prefers-color-scheme: light)"
|
|
30
|
+
scheme: default
|
|
31
|
+
primary: blue grey
|
|
32
|
+
accent: blue grey
|
|
33
|
+
toggle:
|
|
34
|
+
icon: material/weather-sunny
|
|
35
|
+
name: Switch to dark mode
|
|
36
|
+
- media: "(prefers-color-scheme: dark)"
|
|
37
|
+
scheme: slate
|
|
38
|
+
primary: blue grey
|
|
39
|
+
accent: blue grey
|
|
40
|
+
toggle:
|
|
41
|
+
icon: material/weather-night
|
|
42
|
+
name: Switch to system preference
|
|
43
|
+
features:
|
|
44
|
+
- navigation.tabs
|
|
45
|
+
- navigation.sections
|
|
46
|
+
- navigation.indexes
|
|
47
|
+
- navigation.top
|
|
48
|
+
- content.code.copy
|
|
49
|
+
- content.code.annotate
|
|
50
|
+
- content.action.edit
|
|
51
|
+
- content.action.view
|
|
52
|
+
- content.tabs.link
|
|
53
|
+
|
|
54
|
+
# --------------------------------------------------
|
|
55
|
+
# plugins
|
|
56
|
+
# --------------------------------------------------
|
|
57
|
+
plugins:
|
|
58
|
+
- search
|
|
59
|
+
|
|
60
|
+
# --------------------------------------------------
|
|
61
|
+
# markdown extensions
|
|
62
|
+
# --------------------------------------------------
|
|
63
|
+
markdown_extensions:
|
|
64
|
+
- footnotes
|
|
65
|
+
- pymdownx.highlight:
|
|
66
|
+
anchor_linenums: true
|
|
67
|
+
linenums: true
|
|
68
|
+
- pymdownx.superfences:
|
|
69
|
+
custom_fences:
|
|
70
|
+
- name: mermaid
|
|
71
|
+
class: mermaid
|
|
72
|
+
format: !!python/name:pymdownx.superfences.fence_code_format
|
|
73
|
+
- pymdownx.tabbed:
|
|
74
|
+
alternate_style: true
|
|
75
|
+
- pymdownx.arithmatex:
|
|
76
|
+
generic: true
|
|
77
|
+
- pymdownx.emoji:
|
|
78
|
+
emoji_index: !!python/name:material.extensions.emoji.twemoji
|
|
79
|
+
emoji_generator: !!python/name:material.extensions.emoji.to_svg
|
|
80
|
+
- admonition
|
|
81
|
+
- pymdownx.details
|
|
82
|
+
- tables
|
|
83
|
+
- attr_list
|
|
84
|
+
- md_in_html
|
|
85
|
+
|
|
86
|
+
# --------------------------------------------------
|
|
87
|
+
# MathJax for LaTeX rendering
|
|
88
|
+
# --------------------------------------------------
|
|
89
|
+
extra_javascript:
|
|
90
|
+
- javascripts/mathjax.js
|
|
91
|
+
- https://unpkg.com/mathjax@3/es5/tex-mml-chtml.js
|
|
92
|
+
|
|
93
|
+
# --------------------------------------------------
|
|
94
|
+
# navigation
|
|
95
|
+
# --------------------------------------------------
|
|
96
|
+
nav:
|
|
97
|
+
- Home: index.md
|
|
98
|
+
- Installation: installation.md
|
|
@@ -0,0 +1,56 @@
|
|
|
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-inviscid"
|
|
8
|
+
dynamic = ["version"]
|
|
9
|
+
description = "Inviscid supersonic and hypersonic surface solutions: Taylor-Maccoll, Newtonian, tangent-cone, shock-expansion"
|
|
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 :: 1 - Planning",
|
|
18
|
+
"Intended Audience :: Science/Research",
|
|
19
|
+
"License :: OSI Approved :: BSD License",
|
|
20
|
+
"Programming Language :: Python :: 3",
|
|
21
|
+
"Topic :: Scientific/Engineering :: Physics",
|
|
22
|
+
]
|
|
23
|
+
keywords = ["aerodynamics", "hypersonics", "inviscid", "taylor-maccoll", "newtonian"]
|
|
24
|
+
|
|
25
|
+
dependencies = [
|
|
26
|
+
"numpy>=1.24.0",
|
|
27
|
+
"scipy>=1.10.0",
|
|
28
|
+
"typer>=0.9.0",
|
|
29
|
+
]
|
|
30
|
+
|
|
31
|
+
[project.scripts]
|
|
32
|
+
flow-inviscid = "flow_inviscid.cli:cli"
|
|
33
|
+
|
|
34
|
+
[project.optional-dependencies]
|
|
35
|
+
dev = [
|
|
36
|
+
"pytest>=7.0",
|
|
37
|
+
"ruff>=0.1.0",
|
|
38
|
+
"zensical",
|
|
39
|
+
]
|
|
40
|
+
|
|
41
|
+
[project.urls]
|
|
42
|
+
Homepage = "https://github.com/uahypersonics/flow-inviscid"
|
|
43
|
+
Repository = "https://github.com/uahypersonics/flow-inviscid"
|
|
44
|
+
|
|
45
|
+
[tool.setuptools.packages.find]
|
|
46
|
+
where = ["src"]
|
|
47
|
+
|
|
48
|
+
[tool.setuptools_scm]
|
|
49
|
+
|
|
50
|
+
[tool.ruff]
|
|
51
|
+
line-length = 88
|
|
52
|
+
target-version = "py311"
|
|
53
|
+
|
|
54
|
+
[tool.ruff.lint]
|
|
55
|
+
select = ["E", "F", "W", "I", "UP"]
|
|
56
|
+
ignore = ["E501"]
|
|
@@ -0,0 +1,18 @@
|
|
|
1
|
+
"""flow-inviscid: inviscid supersonic and hypersonic surface solutions.
|
|
2
|
+
|
|
3
|
+
Stub release v0.1.0 -- no modules implemented yet.
|
|
4
|
+
"""
|
|
5
|
+
|
|
6
|
+
# --------------------------------------------------
|
|
7
|
+
# load version
|
|
8
|
+
# --------------------------------------------------
|
|
9
|
+
from __future__ import annotations
|
|
10
|
+
|
|
11
|
+
from importlib.metadata import PackageNotFoundError, version
|
|
12
|
+
|
|
13
|
+
try:
|
|
14
|
+
__version__ = version("flow-inviscid")
|
|
15
|
+
except PackageNotFoundError:
|
|
16
|
+
__version__ = "unknown"
|
|
17
|
+
|
|
18
|
+
__all__ = ["__version__"]
|
|
@@ -0,0 +1,11 @@
|
|
|
1
|
+
"""Command-line interface package for flow-inviscid."""
|
|
2
|
+
|
|
3
|
+
# --------------------------------------------------
|
|
4
|
+
# package imports
|
|
5
|
+
# --------------------------------------------------
|
|
6
|
+
from flow_inviscid.cli.app import cli
|
|
7
|
+
|
|
8
|
+
# --------------------------------------------------
|
|
9
|
+
# public api
|
|
10
|
+
# --------------------------------------------------
|
|
11
|
+
__all__ = ["cli"]
|
|
@@ -0,0 +1,100 @@
|
|
|
1
|
+
"""Typer application for the flow-inviscid command-line interface."""
|
|
2
|
+
|
|
3
|
+
# --------------------------------------------------
|
|
4
|
+
# load necessary modules
|
|
5
|
+
# --------------------------------------------------
|
|
6
|
+
from __future__ import annotations
|
|
7
|
+
|
|
8
|
+
import logging
|
|
9
|
+
import sys
|
|
10
|
+
from typing import Annotated
|
|
11
|
+
|
|
12
|
+
import typer
|
|
13
|
+
|
|
14
|
+
from flow_inviscid.cli.cmd_newtonian import cmd_newtonian
|
|
15
|
+
from flow_inviscid.cli.cmd_shock_expansion import cmd_shock_expansion
|
|
16
|
+
|
|
17
|
+
# --------------------------------------------------
|
|
18
|
+
# package imports
|
|
19
|
+
# --------------------------------------------------
|
|
20
|
+
from flow_inviscid.cli.cmd_tangent_cone import cmd_tangent_cone
|
|
21
|
+
|
|
22
|
+
# --------------------------------------------------
|
|
23
|
+
# set up typer app
|
|
24
|
+
# --------------------------------------------------
|
|
25
|
+
cli = typer.Typer(
|
|
26
|
+
name="flow-inviscid",
|
|
27
|
+
help="flow-inviscid: inviscid surface conditions for supersonic and hypersonic bodies",
|
|
28
|
+
no_args_is_help=True,
|
|
29
|
+
add_completion=False,
|
|
30
|
+
)
|
|
31
|
+
|
|
32
|
+
|
|
33
|
+
# --------------------------------------------------
|
|
34
|
+
# version callback
|
|
35
|
+
# --------------------------------------------------
|
|
36
|
+
def _version_callback(value: bool) -> None:
|
|
37
|
+
"""Print version and exit."""
|
|
38
|
+
if value:
|
|
39
|
+
from flow_inviscid import __version__
|
|
40
|
+
typer.echo(f"flow-inviscid {__version__}")
|
|
41
|
+
raise typer.Exit()
|
|
42
|
+
|
|
43
|
+
|
|
44
|
+
# --------------------------------------------------
|
|
45
|
+
# main callback
|
|
46
|
+
# --------------------------------------------------
|
|
47
|
+
@cli.callback()
|
|
48
|
+
def main(
|
|
49
|
+
ctx: typer.Context,
|
|
50
|
+
version: Annotated[
|
|
51
|
+
bool | None,
|
|
52
|
+
typer.Option(
|
|
53
|
+
"--version",
|
|
54
|
+
"-V",
|
|
55
|
+
help="Show version and exit.",
|
|
56
|
+
callback=_version_callback,
|
|
57
|
+
is_eager=True,
|
|
58
|
+
),
|
|
59
|
+
] = None,
|
|
60
|
+
verbose: Annotated[
|
|
61
|
+
bool,
|
|
62
|
+
typer.Option("--verbose", "-v", help="Enable informational output."),
|
|
63
|
+
] = False,
|
|
64
|
+
) -> None:
|
|
65
|
+
"""flow-inviscid: inviscid surface conditions for supersonic and hypersonic bodies."""
|
|
66
|
+
|
|
67
|
+
# store verbose flag in context for access by subcommands
|
|
68
|
+
ctx.ensure_object(dict)
|
|
69
|
+
ctx.obj["verbose"] = verbose
|
|
70
|
+
|
|
71
|
+
# configure logging if verbose is requested
|
|
72
|
+
if verbose:
|
|
73
|
+
logger = logging.getLogger("flow_inviscid")
|
|
74
|
+
logger.setLevel(logging.INFO)
|
|
75
|
+
|
|
76
|
+
# attach a stderr handler; guard prevents duplicates
|
|
77
|
+
has_stream_handler = any(
|
|
78
|
+
isinstance(h, logging.StreamHandler) and not isinstance(h, logging.FileHandler)
|
|
79
|
+
for h in logger.handlers
|
|
80
|
+
)
|
|
81
|
+
if not has_stream_handler:
|
|
82
|
+
handler = logging.StreamHandler(sys.stderr)
|
|
83
|
+
handler.setLevel(logging.INFO)
|
|
84
|
+
handler.setFormatter(logging.Formatter("[%(levelname)-7s] %(name)s: %(message)s"))
|
|
85
|
+
logger.addHandler(handler)
|
|
86
|
+
|
|
87
|
+
|
|
88
|
+
# --------------------------------------------------
|
|
89
|
+
# command registration
|
|
90
|
+
# --------------------------------------------------
|
|
91
|
+
cli.command("tangent-cone", no_args_is_help=True)(cmd_tangent_cone)
|
|
92
|
+
cli.command("newtonian", no_args_is_help=True)(cmd_newtonian)
|
|
93
|
+
cli.command("shock-expansion", no_args_is_help=True)(cmd_shock_expansion)
|
|
94
|
+
|
|
95
|
+
|
|
96
|
+
# --------------------------------------------------
|
|
97
|
+
# entry point
|
|
98
|
+
# --------------------------------------------------
|
|
99
|
+
if __name__ == "__main__":
|
|
100
|
+
cli()
|
|
@@ -0,0 +1,12 @@
|
|
|
1
|
+
"""CLI handler for ``flow-inviscid newtonian``."""
|
|
2
|
+
|
|
3
|
+
from __future__ import annotations
|
|
4
|
+
|
|
5
|
+
import typer
|
|
6
|
+
|
|
7
|
+
|
|
8
|
+
def cmd_newtonian() -> None:
|
|
9
|
+
"""Modified Newtonian surface conditions (not yet implemented)."""
|
|
10
|
+
typer.echo("Not implemented yet.", err=True)
|
|
11
|
+
raise typer.Exit(1)
|
|
12
|
+
|
|
@@ -0,0 +1,12 @@
|
|
|
1
|
+
"""CLI handler for ``flow-inviscid shock-expansion``."""
|
|
2
|
+
|
|
3
|
+
from __future__ import annotations
|
|
4
|
+
|
|
5
|
+
import typer
|
|
6
|
+
|
|
7
|
+
|
|
8
|
+
def cmd_shock_expansion() -> None:
|
|
9
|
+
"""Shock-expansion surface conditions (not yet implemented)."""
|
|
10
|
+
typer.echo("Not implemented yet.", err=True)
|
|
11
|
+
raise typer.Exit(1)
|
|
12
|
+
|
|
@@ -0,0 +1,12 @@
|
|
|
1
|
+
"""CLI handler for ``flow-inviscid tangent-cone``."""
|
|
2
|
+
|
|
3
|
+
from __future__ import annotations
|
|
4
|
+
|
|
5
|
+
import typer
|
|
6
|
+
|
|
7
|
+
|
|
8
|
+
def cmd_tangent_cone() -> None:
|
|
9
|
+
"""Tangent-cone surface conditions (not yet implemented)."""
|
|
10
|
+
typer.echo("Not implemented yet.", err=True)
|
|
11
|
+
raise typer.Exit(1)
|
|
12
|
+
|
|
@@ -0,0 +1,90 @@
|
|
|
1
|
+
Metadata-Version: 2.4
|
|
2
|
+
Name: flow-inviscid
|
|
3
|
+
Version: 0.1.0
|
|
4
|
+
Summary: Inviscid supersonic and hypersonic surface solutions: Taylor-Maccoll, Newtonian, tangent-cone, shock-expansion
|
|
5
|
+
Author-email: Christoph Hader <chader@arizona.edu>
|
|
6
|
+
License: BSD-3-Clause
|
|
7
|
+
Project-URL: Homepage, https://github.com/uahypersonics/flow-inviscid
|
|
8
|
+
Project-URL: Repository, https://github.com/uahypersonics/flow-inviscid
|
|
9
|
+
Keywords: aerodynamics,hypersonics,inviscid,taylor-maccoll,newtonian
|
|
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: Topic :: Scientific/Engineering :: Physics
|
|
15
|
+
Requires-Python: >=3.11
|
|
16
|
+
Description-Content-Type: text/markdown
|
|
17
|
+
License-File: LICENSE
|
|
18
|
+
Requires-Dist: numpy>=1.24.0
|
|
19
|
+
Requires-Dist: scipy>=1.10.0
|
|
20
|
+
Requires-Dist: typer>=0.9.0
|
|
21
|
+
Provides-Extra: dev
|
|
22
|
+
Requires-Dist: pytest>=7.0; extra == "dev"
|
|
23
|
+
Requires-Dist: ruff>=0.1.0; extra == "dev"
|
|
24
|
+
Requires-Dist: zensical; extra == "dev"
|
|
25
|
+
Dynamic: license-file
|
|
26
|
+
|
|
27
|
+
# flow-inviscid
|
|
28
|
+
|
|
29
|
+
Computes inviscid surface Mach number, pressure, and temperature along a body
|
|
30
|
+
contour using classical methods such as tangent-cone, tangent-wedge, Modified
|
|
31
|
+
Newtonian, shock-expansion, method of characteristics, and linearized supersonic.
|
|
32
|
+
|
|
33
|
+
[](https://pypi.org/project/flow-inviscid/)
|
|
34
|
+
[](https://uahypersonics.github.io/flow-inviscid/)
|
|
35
|
+
[](LICENSE)
|
|
36
|
+
[](https://www.python.org/downloads/)
|
|
37
|
+
[](https://github.com/astral-sh/ruff)
|
|
38
|
+
|
|
39
|
+
## Install
|
|
40
|
+
|
|
41
|
+
```bash
|
|
42
|
+
pip install flow-inviscid
|
|
43
|
+
```
|
|
44
|
+
|
|
45
|
+
## Quick Start
|
|
46
|
+
|
|
47
|
+
under construction
|
|
48
|
+
|
|
49
|
+
## Documentation
|
|
50
|
+
|
|
51
|
+
## Validation and Verification
|
|
52
|
+
|
|
53
|
+
under construction
|
|
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 | Python standard docstring conventions |
|
|
64
|
+
| [numpydoc](https://numpydoc.readthedocs.io/en/latest/format.html) | Docstring sections (`Parameters`, `Returns`, `Attributes`) | NumPy/SciPy docstring standard |
|
|
65
|
+
| [Ruff](https://docs.astral.sh/ruff/) | Automated linting and formatting | Enforces PEP 8 compliance automatically |
|
|
66
|
+
|
|
67
|
+
## Releasing
|
|
68
|
+
|
|
69
|
+
This project uses [Semantic Versioning](https://semver.org/) (`vMAJOR.MINOR.PATCH`):
|
|
70
|
+
|
|
71
|
+
- **MAJOR** (`v1.0.0`): Breaking API changes
|
|
72
|
+
- **MINOR** (`v0.3.0`): New features, backward-compatible
|
|
73
|
+
- **PATCH** (`v0.3.1`): Bug fixes
|
|
74
|
+
|
|
75
|
+
To publish a new version:
|
|
76
|
+
|
|
77
|
+
1. Verify locally:
|
|
78
|
+
```bash
|
|
79
|
+
ruff check .
|
|
80
|
+
pytest
|
|
81
|
+
```
|
|
82
|
+
2. Commit and push to `main`
|
|
83
|
+
3. Tag and push:
|
|
84
|
+
```bash
|
|
85
|
+
git tag -a vMAJOR.MINOR.PATCH -m "Release vMAJOR.MINOR.PATCH"
|
|
86
|
+
git push origin vMAJOR.MINOR.PATCH
|
|
87
|
+
```
|
|
88
|
+
|
|
89
|
+
## Citation
|
|
90
|
+
|
|
@@ -0,0 +1,26 @@
|
|
|
1
|
+
.gitignore
|
|
2
|
+
CITATION.cff
|
|
3
|
+
CONTRIBUTING.md
|
|
4
|
+
LICENSE
|
|
5
|
+
README.md
|
|
6
|
+
mkdocs.yml
|
|
7
|
+
pyproject.toml
|
|
8
|
+
.github/workflows/docs.yml
|
|
9
|
+
.github/workflows/publish.yml
|
|
10
|
+
docs/index.md
|
|
11
|
+
docs/installation.md
|
|
12
|
+
docs/javascripts/mathjax.js
|
|
13
|
+
src/flow_inviscid/__init__.py
|
|
14
|
+
src/flow_inviscid.egg-info/PKG-INFO
|
|
15
|
+
src/flow_inviscid.egg-info/SOURCES.txt
|
|
16
|
+
src/flow_inviscid.egg-info/dependency_links.txt
|
|
17
|
+
src/flow_inviscid.egg-info/entry_points.txt
|
|
18
|
+
src/flow_inviscid.egg-info/requires.txt
|
|
19
|
+
src/flow_inviscid.egg-info/scm_file_list.json
|
|
20
|
+
src/flow_inviscid.egg-info/scm_version.json
|
|
21
|
+
src/flow_inviscid.egg-info/top_level.txt
|
|
22
|
+
src/flow_inviscid/cli/__init__.py
|
|
23
|
+
src/flow_inviscid/cli/app.py
|
|
24
|
+
src/flow_inviscid/cli/cmd_newtonian.py
|
|
25
|
+
src/flow_inviscid/cli/cmd_shock_expansion.py
|
|
26
|
+
src/flow_inviscid/cli/cmd_tangent_cone.py
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
|
|
@@ -0,0 +1,22 @@
|
|
|
1
|
+
{
|
|
2
|
+
"files": [
|
|
3
|
+
"CITATION.cff",
|
|
4
|
+
"README.md",
|
|
5
|
+
"LICENSE",
|
|
6
|
+
"pyproject.toml",
|
|
7
|
+
"mkdocs.yml",
|
|
8
|
+
"CONTRIBUTING.md",
|
|
9
|
+
".gitignore",
|
|
10
|
+
"docs/installation.md",
|
|
11
|
+
"docs/index.md",
|
|
12
|
+
"docs/javascripts/mathjax.js",
|
|
13
|
+
"src/flow_inviscid/__init__.py",
|
|
14
|
+
"src/flow_inviscid/cli/cmd_newtonian.py",
|
|
15
|
+
"src/flow_inviscid/cli/__init__.py",
|
|
16
|
+
"src/flow_inviscid/cli/cmd_shock_expansion.py",
|
|
17
|
+
"src/flow_inviscid/cli/app.py",
|
|
18
|
+
"src/flow_inviscid/cli/cmd_tangent_cone.py",
|
|
19
|
+
".github/workflows/docs.yml",
|
|
20
|
+
".github/workflows/publish.yml"
|
|
21
|
+
]
|
|
22
|
+
}
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
flow_inviscid
|