grid-generator 0.1.1__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.
@@ -0,0 +1,20 @@
1
+ """Public package interface for grid_generator."""
2
+
3
+ # --------------------------------------------------
4
+ # load necessary modules
5
+ # --------------------------------------------------
6
+ from importlib.metadata import (
7
+ PackageNotFoundError,
8
+ version,
9
+ )
10
+
11
+ # --------------------------------------------------
12
+ # resolve package version
13
+ # --------------------------------------------------
14
+ try:
15
+ __version__ = version("grid-generator")
16
+ except PackageNotFoundError:
17
+ __version__ = "0+unknown"
18
+
19
+
20
+ __all__ = ["__version__"]
@@ -0,0 +1,86 @@
1
+ Metadata-Version: 2.4
2
+ Name: grid-generator
3
+ Version: 0.1.1
4
+ Summary: Structured grid generation utilities for Python
5
+ Author-email: Christoph Hader <chader@arizona.edu>
6
+ License: BSD-3-Clause
7
+ Project-URL: Homepage, https://github.com/uahypersonics/grid-generator
8
+ Project-URL: Repository, https://github.com/uahypersonics/grid-generator
9
+ Project-URL: Documentation, https://uahypersonics.github.io/grid-generator
10
+ Keywords: grid,structured-grid,mesh,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: Programming Language :: Python :: 3.13
18
+ Classifier: Topic :: Scientific/Engineering
19
+ Requires-Python: >=3.11
20
+ Description-Content-Type: text/markdown
21
+ License-File: LICENSE
22
+ Provides-Extra: dev
23
+ Requires-Dist: pytest>=7.0; extra == "dev"
24
+ Requires-Dist: pytest-cov>=4.0; extra == "dev"
25
+ Requires-Dist: ruff>=0.1.0; extra == "dev"
26
+ Provides-Extra: docs
27
+ Requires-Dist: mkdocs<2,>=1.5; extra == "docs"
28
+ Requires-Dist: mkdocs-material>=9.0; extra == "docs"
29
+ Requires-Dist: mkdocstrings[python]>=0.24; extra == "docs"
30
+ Dynamic: license-file
31
+
32
+ # grid-generator
33
+
34
+ Structured grid generation utilities for Python.
35
+
36
+ [![PyPI](https://img.shields.io/pypi/v/grid-generator)](https://pypi.org/project/grid-generator/)
37
+ [![Docs](https://img.shields.io/badge/docs-mkdocs-blue)](https://uahypersonics.github.io/grid-generator/)
38
+ [![License](https://img.shields.io/badge/License-BSD_3--Clause-blue.svg)](LICENSE)
39
+ [![Python](https://img.shields.io/badge/python-%E2%89%A53.11-blue.svg)](https://www.python.org/downloads/)
40
+
41
+ `grid-generator` is a lightweight Python package for building simple structured
42
+ grids. This repository currently contains the initial public scaffold: package
43
+ layout, documentation, and release automation.
44
+
45
+ ## Install
46
+
47
+ ```bash
48
+ pip install grid-generator
49
+ ```
50
+
51
+ ## Quick Start
52
+
53
+ ```python
54
+ from grid_generator import __version__
55
+
56
+ print(__version__)
57
+ ```
58
+
59
+ ## Features
60
+
61
+ - Minimal Python package scaffold based on the structure used in `flow-state`
62
+ - and `cfd-io`
63
+ - Minimal public package with only `src/grid_generator/__init__.py`
64
+ - MkDocs documentation scaffold with API reference pages
65
+ - GitHub Actions workflows for documentation deployment and tag-based PyPI
66
+ publishing via Trusted Publishing
67
+
68
+ ## Documentation
69
+
70
+ Documentation site: https://uahypersonics.github.io/grid-generator/
71
+
72
+ ## Releasing
73
+
74
+ This project publishes to PyPI from Git tags that match `v*`.
75
+
76
+ ```bash
77
+ git tag -a v0.1.0 -m "Release v0.1.0"
78
+ git push origin v0.1.0
79
+ ```
80
+
81
+ The GitHub Actions publish workflow will build the package, run tests, and then
82
+ publish to PyPI using Trusted Publishing.
83
+
84
+ ## License
85
+
86
+ BSD-3-Clause. See [LICENSE](LICENSE) for details.
@@ -0,0 +1,6 @@
1
+ grid_generator/__init__.py,sha256=mq7BA7UPyT5nBmq7fp5WlX8Lfxeijj-0_7yDct0r5yg,526
2
+ grid_generator-0.1.1.dist-info/licenses/LICENSE,sha256=3UbyOgPeUUDwRiy_Xw1601ZvsOp6tRb38obYvKl4xuw,1500
3
+ grid_generator-0.1.1.dist-info/METADATA,sha256=L3HYAQy9DtqS5defIl9HSe0wGsukyhv7twl17ZkTsa8,2856
4
+ grid_generator-0.1.1.dist-info/WHEEL,sha256=aeYiig01lYGDzBgS8HxWXOg3uV61G9ijOsup-k9o1sk,91
5
+ grid_generator-0.1.1.dist-info/top_level.txt,sha256=Y1xwhyQXsTS4YYbinxJnzBIjk6nK-con446TIvEo1ro,15
6
+ grid_generator-0.1.1.dist-info/RECORD,,
@@ -0,0 +1,5 @@
1
+ Wheel-Version: 1.0
2
+ Generator: setuptools (82.0.1)
3
+ Root-Is-Purelib: true
4
+ Tag: py3-none-any
5
+
@@ -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
+ grid_generator