octarine banner

Octarine is the eighth color of the Discworld's spectrum, which is described as the color of magic itself. Only wizards and cats can see it.

docs

Octarine

A minimalist, easy-to-use, high-performance 3D viewer. Octarine is build on top of the excellent pygfx WGPU rendering engine which does most of the heavy lifting - we're simply abstracting away some of the boiler plate code for you.

Rationale :thought_balloon:

Why another 3D viewer? There are plenty options out there: vedo, ipygany, polyscope, napari, fury, plotly or pyvista to name but a few. All of these are great in their own right but I wanted something (a) without heavy dependencies (i.e. no VTK), (b) that lets me interactively explore my data in both REPL and Jupyter and (c) is very performant. None of the existing solutions ticked all those boxes for me.

Octarine tries to fill that gap:

  1. Lightweight with very few direct or indirect dependencies.
  2. Works in both Jupyter and REPL.
  3. High performance: a mesh with 15M faces renders with 80 fps at 1080p on a 2023 MacBook Pro.

Installation :rocket:

pip install "octarine3d[all]"

This will install the minimal requirements plus PySide6 and jupyter_rfb as window managers for IPython/shell and Jupyter, respectively. Check out the Install Instructions for details.

Quickstart :fire:

# Create a Viewer instance
from octarine import Viewer
v = Viewer()

# Add random points as scatter
import numpy as np
points = np.random.rand(10, 3)  # 10 random points
v.add(points)

# Clear scene
v.clear()

# Add a mesh (see also `Viewer.add_mesh`)
import pygfx as gfx
m = gfx.geometries.mobius_strip_geometry()
v.add(m, color='b')

# Close the viewer
v.close()

[!NOTE] The above example will work in interactive environments such as IPython and Jupyter. When using from the standard REPL or when running as a script you will have to additionally start the event loop. Please see corresponding the section in the Introduction.

demo gif

Want to learn more?

Head over to the Documentation!

Want to contribute?

We welcome all kinds of contributions. For example:

  • reports of bugs, broken examples, etc.
  • feature requests
  • pull requests with bug fixes or new features

If you already know what needs doing, feel free to open a pull request right away. When in doubt please open an issue so we can discuss the best way to address the issue.

Development :dash:

Tests

We're currently running only a very limited test suite. What's there can be run with:

pytest -v

Docs

To generate the documentation:

pip install -e .[docs]
mkdocs build

Project links

Data verified by PyPI on Aug 3, 2026
Data provided by the project maintainers, verified at the time the release was uploaded to PyPI.

Key dates

PyPI data
Data sourced directly from PyPI's database.
  • Released:
Latest release

1 maintainer

PyPI data
Data sourced directly from PyPI's database.
Avatar for observing from gravatar.com observing

Credits

Author: Philipp Schlegel

GitHub Statistics

Data verified by PyPI on Aug 3, 2026
The GitHub source repository was provided by the project maintainers and verified by PyPI at the time of upload. Stars, forks, and open issues/PRs are derived from that repository and have not been independently verified.

License

BSD-2-Clause

Requires

Python >=3.10

Provides Extra

all docs dev

Tags

3D viewer WGPU pygfx

Classifiers

Report project as malware

Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

octarine3d-0.8.0.tar.gz (112.0 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

octarine3d-0.8.0-py3-none-any.whl (109.6 kB view details)

Uploaded Python 3

File details

Details for the file octarine3d-0.8.0.tar.gz.

File metadata

  • Download URL: octarine3d-0.8.0.tar.gz
  • Upload date:
  • Size: 112.0 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/7.0.0 CPython/3.13.14

File hashes

Hashes for octarine3d-0.8.0.tar.gz
Algorithm Hash digest
SHA256 4a8f62dd76685783b46ed1a97cce35ee11a3c3d3f75c6ff8bd243607047a1ea3
MD5 50af5d60e5aa936f55b414b93b7920d8
BLAKE2b-256 4accadb5c83af50909be28cd2c3558bd1538be872eb6bdc75c9529a9f492044e

See more details on using hashes here.

Provenance

The following attestation bundles were made for octarine3d-0.8.0.tar.gz:

Publisher: publish-to-pypi.yml on schlegelp/octarine

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

File details

Details for the file octarine3d-0.8.0-py3-none-any.whl.

File metadata

  • Download URL: octarine3d-0.8.0-py3-none-any.whl
  • Upload date:
  • Size: 109.6 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/7.0.0 CPython/3.13.14

File hashes

Hashes for octarine3d-0.8.0-py3-none-any.whl
Algorithm Hash digest
SHA256 651eb0bfbb666f9d1a74c7466023efdbd7710605ca388b674e28433d0997ea09
MD5 a0aa6748688923f417a8892b8634cc1d
BLAKE2b-256 28d41756c9608fde1cf6b6bc0ca672fb3242b36b7d04fc44c69f6f67ffe88209

See more details on using hashes here.

Provenance

The following attestation bundles were made for octarine3d-0.8.0-py3-none-any.whl:

Publisher: publish-to-pypi.yml on schlegelp/octarine

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page