Python documentationView source ↗
On this page

Installation

Install the Package

Install the released Python package from PyPI:

python -m pip install cosmol-viewer

The wheel contains the native Python extension and the WebAssembly assets used by interactive Jupyter and Google Colab viewers. A separate JavaScript install is not required for Python use.

Verify the Installation

Create a scene to check that the package can be imported:

from cosmol_viewer import Scene

scene = Scene()
print("COSMol Viewer is ready")

Continue with Quick Start to load a molecule and create an image.

Platform Notes

Interactive native windows require a graphical desktop. Static rendering uses an offscreen OpenGL path and can run on headless Linux. Google Colab is detected automatically and uses an isolated software-rendering process; notebook code does not need to set rendering environment variables.