Metadata-Version: 2.4
Name: yuhe
Version: 0.0.1
Summary: Interactive 3D bounding box selector that generates point inclusion functions.
Author: Chaofan Luo
Project-URL: Homepage, https://luocfprime.github.io/yuhe/
Project-URL: Repository, https://github.com/luocfprime/yuhe
Project-URL: Documentation, https://luocfprime.github.io/yuhe/
Keywords: python
Classifier: Intended Audience :: Developers
Classifier: Programming Language :: Python
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3.9
Classifier: Programming Language :: Python :: 3.10
Classifier: Programming Language :: Python :: 3.11
Classifier: Programming Language :: Python :: 3.12
Classifier: Programming Language :: Python :: 3.13
Classifier: Topic :: Software Development :: Libraries :: Python Modules
Requires-Python: <4.0,>=3.10
Description-Content-Type: text/markdown
License-File: LICENSE
Requires-Dist: numpy>=2.2.6
Requires-Dist: polyscope>=2.5.0
Requires-Dist: rich>=14.1.0
Requires-Dist: scipy>=1.15.3
Requires-Dist: trimesh>=4.8.2
Requires-Dist: typer>=0.17.4
Provides-Extra: dev
Requires-Dist: pytest>=7.2.0; extra == "dev"
Requires-Dist: pytest-cov>=4.0.0; extra == "dev"
Requires-Dist: pre-commit>=2.20.0; extra == "dev"
Requires-Dist: tox-uv>=1.11.3; extra == "dev"
Requires-Dist: mypy>=0.991; extra == "dev"
Requires-Dist: ruff>=0.9.2; extra == "dev"
Requires-Dist: mkdocs>=1.4.2; extra == "dev"
Requires-Dist: mkdocs-material>=8.5.10; extra == "dev"
Requires-Dist: mkdocstrings[python]>=0.26.1; extra == "dev"
Requires-Dist: mkdocs-static-i18n[material]>=1.3.0; extra == "dev"
Requires-Dist: mkdocs-macros-plugin>=1.3.9; extra == "dev"
Requires-Dist: tomlkit>=0.13.3; extra == "dev"
Requires-Dist: matplotlib>=3.10.6; extra == "dev"
Requires-Dist: rtree>=1.4.1; extra == "dev"
Dynamic: license-file

# yuhe

[![Python Versions](https://img.shields.io/pypi/pyversions/yuhe)](https://pypi.org/project/yuhe/)
[![PyPI Version](https://img.shields.io/pypi/v/yuhe)](https://pypi.org/project/yuhe/)

Interactive 3D bounding box selector that generates point inclusion functions.

- **Git repository**: <https://github.com/luocfprime/yuhe/>


- **Documentation** <https://luocfprime.github.io/yuhe/>


## Install

Prerequisites: You must have at least one Python package manager installed (e.g. [uv](https://docs.astral.sh/uv/getting-started/installation/)).

Install it from PyPI:

```bash
uv tool install yuhe
```

Or, if you want to run it once without installing it, you can use the `uv run` command:

```bash
uv run --with yuhe yuhe xxx  # xxx being the subcommand you want to run
```


## Usage

```text
$ yuhe -h

 Usage: yuhe [OPTIONS] MESH_PATH

 Interactive 3D bounding box selector that generates point inclusion functions.

╭─ Arguments ─────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────╮
│ *    mesh_path      FILE  Path to mesh file (e.g. .stl file) [required]                                                                         │
╰─────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────╯
╭─ Options ───────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────╮
│ --log-level           -l      TEXT  Set the logging level (DEBUG, INFO, WARNING, ERROR, CRITICAL) [default: INFO]                               │
│ --install-completion                Install completion for the current shell.                                                                   │
│ --show-completion                   Show completion for the current shell, to copy it or customize the installation.                            │
│ --help                -h            Show this message and exit.                                                                                 │
╰─────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────╯
```

## Contributing

See [CONTRIBUTING.md](CONTRIBUTING.md) for details.

## License

MIT.
