API reference

Generated from the source. For task-oriented guides with live examples, see the guides.

The package exports three classes:

You never construct the other documented classes yourself. You get them from a viewer:

  • Model is vis.model, the displayed structure with all its periodic images.
  • ModelView is the result of model.find(query), and the type of vis.displayed and vis.selected.
  • AtomImage and BondImage are the entries of view.atoms and atom.bonds.