Metadata-Version: 2.4
Name: yumo
Version: 0.1.0
Summary: Scalar field visualization using Polyscope.
Author: Chaofan Luo
Project-URL: Homepage, https://luocfprime.github.io/yumo/
Project-URL: Repository, https://github.com/luocfprime/yumo
Project-URL: Documentation, https://luocfprime.github.io/yumo/
Keywords: python
Classifier: Intended Audience :: Developers
Classifier: Programming Language :: Python
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3.10
Classifier: Programming Language :: Python :: 3.11
Classifier: Programming Language :: Python :: 3.12
Classifier: Topic :: Software Development :: Libraries :: Python Modules
Requires-Python: <4.0,>=3.10
Description-Content-Type: text/markdown
License-File: LICENSE
Requires-Dist: einx>=0.3.0
Requires-Dist: matplotlib>=3.9.4
Requires-Dist: numpy<2
Requires-Dist: opencv-python>=4.11.0.86
Requires-Dist: polyscope>=2.5.0
Requires-Dist: rtree>=1.4.1
Requires-Dist: scipy>=1.15.3
Requires-Dist: tqdm>=4.67.1
Requires-Dist: trimesh>=4.8.1
Requires-Dist: typer>=0.17.4
Requires-Dist: xatlas>=0.0.11
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"
Dynamic: license-file

# yumo

Scalar field visualization using Polyscope.

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


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

## 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 yumo
```

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

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

## Usage

```text
$ yumo -h

 Usage: yumo [OPTIONS] COMMAND [ARGS]...

╭─ Options ───────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────╮
│ --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.                                                                                     │
╰─────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────╯
╭─ Commands ──────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────╮
│ prune   Prune data points that are inside the mesh.                                                                                             │
│ viz     Visualize the scalar field.                                                                                                             │
╰─────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────╯
```

## Contributing

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

## License

MIT.
