Tutorials#

Tutorials are learning-oriented. Follow them in order to learn the Frame API.

Available tutorials#

Tutorial

Description

Classify ice

Load a mixed ice-water dump, print CHILL+, score cages

dseams

CHILL+, q4/q6 and rings on NumPy arrays through import dseams

Bulk ice

CHILL+ and cages on the mixed TIP4P frame, CLI and Python

Ice and clathrate

CHILL+ stars and signature cages on sI

Primitive rings

Hydrogen-bond and cutoff ring census

Order parameters

Steinhardt qland the Lechner-Dellago average

Confined water

In-plane RDF, monolayer rings, prisms

Paper figures

The 2020 JCIM figure calls on in-tree dumps

What a tutorial covers#

Each tutorial states prerequisites, lists learning objectives, and walks numbered steps with expected output. The flagship path is ds.read to Frame.chill_plus to Frame.cages.

Sibling packages (seams in seams-core, require("dseams") in yodaStruct) share the same engine. These tutorials stay on Python.

Getting help#

How-to guides

solve a specific task

Python surface

live names

Explanation

why the surface is split