Skip to main content

API Reference

megane provides APIs for both Python and TypeScript/JavaScript.

Python​

The Python API is used for:

  • Jupyter notebooks — Interactive widget for molecular visualization
  • CLI server — Serve structures via WebSocket
  • Data loading — Parse PDB files and read XTC trajectories
import megane

# Quick start
viewer = megane.view("protein.pdb")

# With trajectory
viewer = megane.view_traj("protein.pdb", xtc="trajectory.xtc")

Python API Reference →

TypeScript / JavaScript​

The TypeScript API is used for:

  • React components — Embed the viewer in web applications
  • Core renderer — Framework-agnostic Three.js rendering
  • Protocol decoding — Parse binary WebSocket messages
import { MeganeViewer, MoleculeRenderer } from "megane-viewer/lib";

TypeScript API Reference →