Metadata-Version: 2.4
Name: admesh3D
Version: 0.0.1
Summary: Placeholder for a possible future 3D-element extension of admesh2D (https://github.com/domattioli/ADMESH). No functionality yet.
Author: Dominik Mattioli
Maintainer: Dominik Mattioli
License-Expression: Apache-2.0
Project-URL: Source, https://github.com/domattioli/ADMESH
Project-URL: Sibling, https://pypi.org/project/admesh2D/
Keywords: mesh,adcirc,hydrodynamics,placeholder
Classifier: Development Status :: 1 - Planning
Classifier: Intended Audience :: Science/Research
Classifier: Programming Language :: Python :: 3
Classifier: Topic :: Scientific/Engineering
Requires-Python: >=3.10
Description-Content-Type: text/markdown
License-File: LICENSE
Dynamic: license-file

# admesh3D — placeholder

This is a **name-reservation placeholder** on PyPI. There is no
functionality yet.

## What this is for

The 2D mesh generator [ADMESH](https://github.com/domattioli/ADMESH)
ships on PyPI as [`admesh2D`](https://pypi.org/project/admesh2D/)
(the bare `admesh` name is taken by an unrelated STL-bindings
package). A future 3D-element extension of ADMESH is a possibility
the project wants to leave room for. This package reserves the
`admesh3D` name against that case.

## What this is not

- Not a working library — `import admesh3d` returns a module with
  only a `__version__` and a docstring.
- Not a fork of, or substitute for,
  [`admesh2D`](https://pypi.org/project/admesh2D/).

## What to install instead

If you want the ADMESH mesh generator:

```bash
pip install admesh2D
```

## Status

If real 3D-element work begins, this package will be replaced with
a functioning release. Until then, the version stays at `0.0.x`.

## License

Apache-2.0. See [LICENSE](LICENSE).
