flow-props 0.1.0__py3-none-any.whl
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/__init__.py
ADDED
|
@@ -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,6 @@
|
|
|
1
|
+
flow_props/__init__.py,sha256=11hyL7stRTTYmeawLusBV1ZCwfUX1y8RsRzhq0i3EnA,135
|
|
2
|
+
flow_props-0.1.0.dist-info/licenses/LICENSE,sha256=3UbyOgPeUUDwRiy_Xw1601ZvsOp6tRb38obYvKl4xuw,1500
|
|
3
|
+
flow_props-0.1.0.dist-info/METADATA,sha256=fdHFQ4nbU7LrOnO7MbgsvXNNwvWyaMYixqFtd_MkIrs,3674
|
|
4
|
+
flow_props-0.1.0.dist-info/WHEEL,sha256=aeYiig01lYGDzBgS8HxWXOg3uV61G9ijOsup-k9o1sk,91
|
|
5
|
+
flow_props-0.1.0.dist-info/top_level.txt,sha256=rvRJzFJbSy7OX-p2qV-jCGMK5lpD95Da19AFfG6--xQ,11
|
|
6
|
+
flow_props-0.1.0.dist-info/RECORD,,
|
|
@@ -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 @@
|
|
|
1
|
+
flow_props
|