An open API service indexing awesome lists of open source software.

https://github.com/luocfprime/yumo

Scalar field visualization using Polyscope.
https://github.com/luocfprime/yumo

polyscope visualization

Last synced: 13 days ago
JSON representation

Scalar field visualization using Polyscope.

Awesome Lists containing this project

README

          

# yumo

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

Scalar field visualization using Polyscope.

- **Git repository**:

- **Documentation**

## 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.