Skip to content

Installation#

Octarine is published as a Python package and can be installed with pip, ideally by using a virtual environment. Open up a terminal and install Octarine with:

The full install should set you up for using Octarine in both shell (IPython) and Jupyter:

pip install "octarine3d[all]"

It includes PySide6, jupyter_rfb and sidecar as additional dependencies.

If you opt for the minimal install, you will still have to install at least one Window Manager:

pip install octarine3d

To install the latest version from Github:

pip install git+https://github.com/schlegelp/octarine.git

Tip

If you don't have prior experience with Python, check out Using Python's pip to Manage Your Projects' Dependencies, which is a really good introduction on the mechanics of Python package management and helps you troubleshoot if you run into errors.

Window Managers#

pygfx (and hence Octarine) requires a Window manager to work. If you have opted for the [all] install option, you should already have PySide6 and jupyter-rbf and you don't need to worry about this.

If instead you decided to pick your a window manager on your own, here are the ones supported by wgpu-py:

  • qt: PySide6, PyQt6, PySide2, PyQt5 all work but I recommend PySide6 (see below)
  • glfw: a lightweight GUI for the desktop
  • jupyter-rfb: only needed if you plan on using Octarine in Jupyter
pip install PySide6

pip install PyQt6

pip install PyQt5

pip install glfw

pip install jupyter-rfb

Please note that at this point, Octarine's controls panel requires PySide6. So if you want GUI controls you have to use PySide6.

What next?#

  • Viewer Basics

    Learn about using Octarine in different environments.

    The Basics

  • Objects

    Check out the guide on different object types.

    Adding Objects

  • Animations

    Add movement to the viewer.

    Animations

  • Control

    Learn how to control the viewer, adjust colors, etc.

    Controls