API#

Spec#

The records that describe one study as data; no MDAnalysis needed.

polyphys.spec

polyphys.spec

Manage#

polyphys.manage.parser

polyphys.manage.parser

polyphys.manage.organizer

polyphys.manage.organizer The polyphys.manage.organizer module provides tools for organizing and aggregating simulation data based on filename patterns, file structures, and processing stages. It facilitates handling segmented data, grouping experiments into ensembles, and consolidating ensembles into spaces.

polyphys.manage.utils

Miscellaneous utility codes --- polyphys.manage.utils

polyphys.manage.types

polyphys.manage.types

Simulate#

polyphys.simulate.core

Shared LAMMPS pieces --- polyphys.simulate.core

polyphys.simulate.log

LAMMPS log files --- polyphys.simulate.log

polyphys.simulate.dump

LAMMPS dump files --- polyphys.simulate.dump

polyphys.simulate.data

LAMMPS data files --- polyphys.simulate.data

polyphys.simulate.build

Start configurations --- polyphys.simulate.build

Analyze#

polyphys.analyze.measurer

polyphys.analyze.measurer

polyphys.analyze.stats

polyphys.analyze.stats

polyphys.analyze.clusters

polyphys.analyze.clusters

polyphys.analyze.correlations

polyphys.analyze.correlations

polyphys.analyze.sumrule

polyphys.analyze.sumrule

polyphys.analyze.density

polyphys.analyze.density

polyphys.analyze.pipeline

polyphys.analyze.pipeline

Probe#

Needs MDAnalysis, which the mda extra installs.

polyphys.probe.core

polyphys.probe.core

polyphys.probe.chain_size

polyphys.probe.chain_size

polyphys.probe.binders

polyphys.probe.binders

polyphys.probe.histograms

polyphys.probe.histograms

polyphys.probe.pairs

polyphys.probe.pairs

Viz#

Needs matplotlib, which the viz extra installs; the color lists in colors do not.

polyphys.viz.colors

polyphys.viz.colors

polyphys.viz.helpers

polyphys.viz.helpers

Packages#

The simulate and probe packages re-export the public names of their modules; viz imports neither of its modules on its own. A re-export is the name documented in its module above.

The simulate subpackage works with the files of the simulation engine, LAMMPS: it reads logs and dumps, reads and writes data files, and builds the start configurations a run begins from, sharing the box and the error types of polyphys.simulate.core.

The probe layer: per-frame observables read from LAMMPS trajectories with MDAnalysis, which the mda extra installs (python -m pip install 'polyphys[mda]'). The rest of PolyPhys does not need it, so this package is imported on demand and raises ImportError with that hint when MDAnalysis is missing.

Added in version 0.7.0.

The viz layer: color lists and small matplotlib helpers for the studies’ figures, which the viz extra makes usable (python -m pip install 'polyphys[viz]').

polyphys.viz.colors holds the color lists, which need no plotting library, and truncate_colormap(), which imports matplotlib when called. polyphys.viz.helpers needs matplotlib at import and raises ImportError with that hint when it is missing. This package imports neither module on its own; import the one you need.

Added in version 0.8.0.