FAQ#

If you do have a question, head over to Discussion and ask away!

In the meantime, here are a couple things that may help you troubleshoot:

When trying to open the GUI controls, I get an error message like this:

ImportError:
    Importing PySide6 disabled by IPython, which has
    already imported an Incompatible QT Binding: pyqt6

This message indicates that IPython has started a main event loop that's incompatible with PySide6, the library we use to build the controls GUI. There are two explanations: either you didn't run the right %magic command (or used the equivalent start-up option or config) to initialize the main event loop for PySide6, or you have also have PyQt5 or (more likely) PyQt6 installed in which case IPython latches on to those instead of PySide6. Bottom line: make sure you only have PySide6 installed as window manager and then run this %magic command at start-up:

%gui qt6

My Octarine-based app/script uses a lot of CPU.

By default, octarine will re-render the scene at every frame even if nothing has changed - i.e. the camera hasn't moved and objects haven't changed. You can change the render trigger to something a bit more resource-friendly:

continuous is the default, greedy mode
active_window pauses the rendering when the window is not active
reactive tries to only re-render the scene if something has changed

import octarine as oc

v = oc.Viewer()

# Set to render reactively
v.render_trigger = "reactive"

# Set to render only when window is active
v.render_trigger = "active_window"