Metadata-Version: 2.4
Name: grid-generator
Version: 0.1.1
Summary: Structured grid generation utilities for Python
Author-email: Christoph Hader <chader@arizona.edu>
License: BSD-3-Clause
Project-URL: Homepage, https://github.com/uahypersonics/grid-generator
Project-URL: Repository, https://github.com/uahypersonics/grid-generator
Project-URL: Documentation, https://uahypersonics.github.io/grid-generator
Keywords: grid,structured-grid,mesh,cfd
Classifier: Development Status :: 3 - Alpha
Classifier: Intended Audience :: Science/Research
Classifier: License :: OSI Approved :: BSD License
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3.11
Classifier: Programming Language :: Python :: 3.12
Classifier: Programming Language :: Python :: 3.13
Classifier: Topic :: Scientific/Engineering
Requires-Python: >=3.11
Description-Content-Type: text/markdown
License-File: LICENSE
Provides-Extra: dev
Requires-Dist: pytest>=7.0; extra == "dev"
Requires-Dist: pytest-cov>=4.0; extra == "dev"
Requires-Dist: ruff>=0.1.0; extra == "dev"
Provides-Extra: docs
Requires-Dist: mkdocs<2,>=1.5; extra == "docs"
Requires-Dist: mkdocs-material>=9.0; extra == "docs"
Requires-Dist: mkdocstrings[python]>=0.24; extra == "docs"
Dynamic: license-file

# grid-generator

Structured grid generation utilities for Python.

[![PyPI](https://img.shields.io/pypi/v/grid-generator)](https://pypi.org/project/grid-generator/)
[![Docs](https://img.shields.io/badge/docs-mkdocs-blue)](https://uahypersonics.github.io/grid-generator/)
[![License](https://img.shields.io/badge/License-BSD_3--Clause-blue.svg)](LICENSE)
[![Python](https://img.shields.io/badge/python-%E2%89%A53.11-blue.svg)](https://www.python.org/downloads/)

`grid-generator` is a lightweight Python package for building simple structured
grids. This repository currently contains the initial public scaffold: package
layout, documentation, and release automation.

## Install

```bash
pip install grid-generator
```

## Quick Start

```python
from grid_generator import __version__

print(__version__)
```

## Features

- Minimal Python package scaffold based on the structure used in `flow-state`
- and `cfd-io`
- Minimal public package with only `src/grid_generator/__init__.py`
- MkDocs documentation scaffold with API reference pages
- GitHub Actions workflows for documentation deployment and tag-based PyPI
	publishing via Trusted Publishing

## Documentation

Documentation site: https://uahypersonics.github.io/grid-generator/

## Releasing

This project publishes to PyPI from Git tags that match `v*`.

```bash
git tag -a v0.1.0 -m "Release v0.1.0"
git push origin v0.1.0
```

The GitHub Actions publish workflow will build the package, run tests, and then
publish to PyPI using Trusted Publishing.

## License

BSD-3-Clause. See [LICENSE](LICENSE) for details.
