Metadata-Version: 2.4
Name: yt_idv
Version: 0.5.2
Summary: Interactive Volume Rendering for yt
Home-page: https://github.com/yt-project/yt_idv
Author: Matthew Turk
Author-email: matthewturk@gmail.com
License: BSD-3-Clause
Keywords: yt_idv
Classifier: Development Status :: 2 - Pre-Alpha
Classifier: Intended Audience :: Developers
Classifier: Natural Language :: English
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3 :: Only
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 :: Implementation :: CPython
Requires-Python: >=3.9
Description-Content-Type: text/markdown
License-File: LICENSE
Requires-Dist: Click>=7.0
Requires-Dist: cmyt
Requires-Dist: imgui>=1.2.0
Requires-Dist: matplotlib>=3.0
Requires-Dist: numpy>=1.18.0
Requires-Dist: pyOpenGL>=3.1.5
Requires-Dist: pyglet>=2.0.dev0
Requires-Dist: pyyaml>=5.3.1
Requires-Dist: traitlets>=5.0.5
Requires-Dist: traittypes>=0.2.1
Requires-Dist: yt>=4.1.0
Provides-Extra: dev
Requires-Dist: twine==1.14.0; extra == "dev"
Requires-Dist: wheel==0.33.6; extra == "dev"
Provides-Extra: minimal
Requires-Dist: numpy<2.0; extra == "minimal"
Provides-Extra: test
Requires-Dist: pytest>=6.2.4; extra == "test"
Requires-Dist: pytest-html; extra == "test"
Dynamic: license-file

# interactive volume rendering for yt

[![](https://img.shields.io/pypi/v/yt_idv.svg)](https://pypi.python.org/pypi/yt_idv)

[![Doc Status](https://readthedocs.org/projects/yt-idv/badge/?version=latest)](https://yt-idv.readthedocs.io/en/latest/?badge=latest)
[![pre-commit.ci status](https://results.pre-commit.ci/badge/github/yt-project/yt_idv/main.svg)](https://results.pre-commit.ci/latest/github/yt-project/yt_idv/main)
[![Run tests](https://github.com/yt-project/yt_idv/actions/workflows/build-test.yaml/badge.svg)](https://github.com/yt-project/yt_idv/actions/workflows/build-test.yaml)

This package provides interactive visualization using OpenGL for datasets
loaded in yt.  It is written to provide both scripting and interactive access.

* Free software: BSD license
* Documentation: https://yt-idv.readthedocs.io.
* Source code: https://github.com/yt-project/yt_idv

![example of using yt_idv](https://i.imgur.com/Q4XPNZw.gif)

## Features

* Rendering of multi-resolution (AMR) volume data
* Rendering of unstructured mesh data
* Fully-traitlets-ized interface for controlling the rendering properties
* DearImGUI-based interactive controls
* On-screen rendering powered by [pyglet](http://pyglet.org/) and off-screen
  [EGL](https://en.wikipedia.org/wiki/EGL_(API)) through [PyOpenGL](https://pypi.org/project/PyOpenGL/)
* Multiple annotations:
    * Text
    * Boxes
    * Block and grid outlines
* Support for sub-selections of data via the yt data selection interface
* Integration with the [ipywidgets](https://ipywidgets.readthedocs.org/) ``Image`` widget.
* Direct volume rendering of block-AMR data in spherical coordinates.

## Examples

For examples, check out the scripts in the [examples directory](https://github.com/yt-project/yt_idv/tree/main/examples).

## Credits

This package was initially created as part of [yt](https://yt-project.org), with the first iteration written by
Chuck Rozhon.  The conversion to use traitlets, pyglet and a more flexible shader interface was done by Matthew Turk,
with contributions from Kacper Kowalik and Chris Havlin.

This package was created with [Cookiecutter](https://github.com/audreyr/cookiecutter) and the
[`audreyr/cookiecutter-pypackage`](https://github.com/audreyr/cookiecutter-pypackage) project template.
