grid-generator 0.1.1__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.
@@ -0,0 +1,52 @@
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 -e ".[docs]"
33
+
34
+ - name: Build documentation
35
+ run: mkdocs build --strict
36
+
37
+ - name: Upload artifact
38
+ uses: actions/upload-pages-artifact@v3
39
+ with:
40
+ path: site
41
+
42
+ deploy:
43
+ if: github.ref == 'refs/heads/main'
44
+ needs: build
45
+ runs-on: ubuntu-latest
46
+ environment:
47
+ name: github-pages
48
+ url: ${{ steps.deployment.outputs.page_url }}
49
+ steps:
50
+ - name: Deploy to GitHub Pages
51
+ id: deployment
52
+ 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 tests
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
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,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,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,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,55 @@
1
+ # grid-generator
2
+
3
+ Structured grid generation utilities for Python.
4
+
5
+ [![PyPI](https://img.shields.io/pypi/v/grid-generator)](https://pypi.org/project/grid-generator/)
6
+ [![Docs](https://img.shields.io/badge/docs-mkdocs-blue)](https://uahypersonics.github.io/grid-generator/)
7
+ [![License](https://img.shields.io/badge/License-BSD_3--Clause-blue.svg)](LICENSE)
8
+ [![Python](https://img.shields.io/badge/python-%E2%89%A53.11-blue.svg)](https://www.python.org/downloads/)
9
+
10
+ `grid-generator` is a lightweight Python package for building simple structured
11
+ grids. This repository currently contains the initial public scaffold: package
12
+ layout, documentation, and release automation.
13
+
14
+ ## Install
15
+
16
+ ```bash
17
+ pip install grid-generator
18
+ ```
19
+
20
+ ## Quick Start
21
+
22
+ ```python
23
+ from grid_generator import __version__
24
+
25
+ print(__version__)
26
+ ```
27
+
28
+ ## Features
29
+
30
+ - Minimal Python package scaffold based on the structure used in `flow-state`
31
+ - and `cfd-io`
32
+ - Minimal public package with only `src/grid_generator/__init__.py`
33
+ - MkDocs documentation scaffold with API reference pages
34
+ - GitHub Actions workflows for documentation deployment and tag-based PyPI
35
+ publishing via Trusted Publishing
36
+
37
+ ## Documentation
38
+
39
+ Documentation site: https://uahypersonics.github.io/grid-generator/
40
+
41
+ ## Releasing
42
+
43
+ This project publishes to PyPI from Git tags that match `v*`.
44
+
45
+ ```bash
46
+ git tag -a v0.1.0 -m "Release v0.1.0"
47
+ git push origin v0.1.0
48
+ ```
49
+
50
+ The GitHub Actions publish workflow will build the package, run tests, and then
51
+ publish to PyPI using Trusted Publishing.
52
+
53
+ ## License
54
+
55
+ BSD-3-Clause. See [LICENSE](LICENSE) for details.
@@ -0,0 +1,5 @@
1
+ # API Reference
2
+
3
+ The API reference is generated from the package docstrings.
4
+
5
+ - [Package](package.md)
@@ -0,0 +1,3 @@
1
+ # Package API
2
+
3
+ ::: grid_generator
@@ -0,0 +1,4 @@
1
+ # grid-generator
2
+
3
+ `grid-generator` is a lightweight Python package repository for future
4
+ structured grid generation utilities.
@@ -0,0 +1,8 @@
1
+ # Installation
2
+
3
+ ## PyPI
4
+
5
+ ```bash
6
+ pip install grid-generator
7
+ ```
8
+
@@ -0,0 +1,11 @@
1
+ # User Guide
2
+
3
+ This guide covers the current minimal public interface for `grid-generator`.
4
+
5
+ The initial scaffold is deliberately small. Right now it supports:
6
+
7
+ - importing the package from Python
8
+ - accessing package version metadata
9
+
10
+ Additional functionality can be added later without changing the release,
11
+ documentation, and packaging structure established here.
@@ -0,0 +1,98 @@
1
+ # BSD-3-Clause License - see LICENSE file
2
+
3
+ # --------------------------------------------------
4
+ # site metadata
5
+ # --------------------------------------------------
6
+ site_name: grid-generator
7
+ site_url: https://uahypersonics.github.io/grid-generator
8
+ site_author: Christoph Hader
9
+ site_description: Structured grid generation utilities for Python.
10
+
11
+ # --------------------------------------------------
12
+ # github repository
13
+ # --------------------------------------------------
14
+ repo_name: uahypersonics/grid-generator
15
+ repo_url: https://github.com/uahypersonics/grid-generator
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.action.edit
49
+ - content.action.view
50
+
51
+ # --------------------------------------------------
52
+ # plugins
53
+ # --------------------------------------------------
54
+ plugins:
55
+ - search
56
+ - mkdocstrings:
57
+ handlers:
58
+ python:
59
+ paths: [src]
60
+ options:
61
+ show_source: false
62
+ show_root_heading: true
63
+ show_root_full_path: false
64
+ heading_level: 2
65
+ docstring_style: google
66
+ members_order: source
67
+
68
+ # --------------------------------------------------
69
+ # markdown extensions
70
+ # --------------------------------------------------
71
+ markdown_extensions:
72
+ - pymdownx.highlight:
73
+ anchor_linenums: true
74
+ linenums: true
75
+ - pymdownx.superfences:
76
+ custom_fences:
77
+ - name: mermaid
78
+ class: mermaid
79
+ format: !!python/name:pymdownx.superfences.fence_code_format
80
+ - pymdownx.tabbed:
81
+ alternate_style: true
82
+ - admonition
83
+ - pymdownx.details
84
+ - tables
85
+ - attr_list
86
+ - md_in_html
87
+
88
+ # --------------------------------------------------
89
+ # navigation
90
+ # --------------------------------------------------
91
+ nav:
92
+ - Home: index.md
93
+ - Installation: installation.md
94
+ - User Guide:
95
+ - user-guide/index.md
96
+ - API Reference:
97
+ - api/index.md
98
+ - Package: api/package.md
@@ -0,0 +1,60 @@
1
+ [build-system]
2
+ requires = ["setuptools>=61.0", "setuptools-scm>=8", "wheel"]
3
+ build-backend = "setuptools.build_meta"
4
+
5
+ [project]
6
+ name = "grid-generator"
7
+ dynamic = ["version"]
8
+ description = "Structured grid generation utilities for Python"
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 :: 3 - Alpha",
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",
24
+ ]
25
+ keywords = ["grid", "structured-grid", "mesh", "cfd"]
26
+ dependencies = []
27
+
28
+ [project.optional-dependencies]
29
+ dev = [
30
+ "pytest>=7.0",
31
+ "pytest-cov>=4.0",
32
+ "ruff>=0.1.0",
33
+ ]
34
+ docs = [
35
+ "mkdocs>=1.5,<2",
36
+ "mkdocs-material>=9.0",
37
+ "mkdocstrings[python]>=0.24",
38
+ ]
39
+
40
+ [project.urls]
41
+ Homepage = "https://github.com/uahypersonics/grid-generator"
42
+ Repository = "https://github.com/uahypersonics/grid-generator"
43
+ Documentation = "https://uahypersonics.github.io/grid-generator"
44
+
45
+ [tool.setuptools.packages.find]
46
+ where = ["src"]
47
+
48
+ [tool.setuptools_scm]
49
+
50
+ [tool.pytest.ini_options]
51
+ testpaths = ["tests"]
52
+ pythonpath = ["src"]
53
+
54
+ [tool.ruff]
55
+ line-length = 100
56
+ target-version = "py311"
57
+
58
+ [tool.ruff.lint]
59
+ select = ["E", "F", "W", "I", "UP"]
60
+ ignore = ["E501"]
@@ -0,0 +1,4 @@
1
+ [egg_info]
2
+ tag_build =
3
+ tag_date = 0
4
+
@@ -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,19 @@
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/index.md
9
+ docs/installation.md
10
+ docs/api/index.md
11
+ docs/api/package.md
12
+ docs/user-guide/index.md
13
+ src/grid_generator/__init__.py
14
+ src/grid_generator.egg-info/PKG-INFO
15
+ src/grid_generator.egg-info/SOURCES.txt
16
+ src/grid_generator.egg-info/dependency_links.txt
17
+ src/grid_generator.egg-info/requires.txt
18
+ src/grid_generator.egg-info/top_level.txt
19
+ tests/test_package.py
@@ -0,0 +1,10 @@
1
+
2
+ [dev]
3
+ pytest>=7.0
4
+ pytest-cov>=4.0
5
+ ruff>=0.1.0
6
+
7
+ [docs]
8
+ mkdocs<2,>=1.5
9
+ mkdocs-material>=9.0
10
+ mkdocstrings[python]>=0.24
@@ -0,0 +1 @@
1
+ grid_generator
@@ -0,0 +1,16 @@
1
+ """Tests for the minimal public package scaffold."""
2
+
3
+ # --------------------------------------------------
4
+ # load necessary modules
5
+ # --------------------------------------------------
6
+ from __future__ import annotations
7
+
8
+ import grid_generator
9
+
10
+
11
+ def test_package_exposes_version() -> None:
12
+ """Expose package version metadata from the top-level package."""
13
+
14
+ # validate version attribute
15
+ assert isinstance(grid_generator.__version__, str)
16
+ assert grid_generator.__version__