Welcome to PolyPhys’s Documentation!#
PolyPhys is a Python library for managing and analyzing data from large-scale coarse-grained molecular dynamics simulations of polymers under macromolecular crowding, focusing on computational modeling of bacterial chromosome organization.
It decodes physics-encoding simulation filenames into typed attributes, organizes
artifacts along a five-level lineage — segment, whole, ensemble_long,
ensemble, space — and reduces replicate ensembles into averaged measurements.
Start with Installation, then the quickstart,
which runs a small synthetic sweep from its segments to its space table; the
usage page says where each task is explained.
Where PolyPhys comes from#
PolyPhys was migrated from the maintainer’s private research repository, SciOps. These pages, the docstrings, and the tests call it the research code, and its probe functions the research probe. It is not public, and nothing in PolyPhys needs it: where a page says how PolyPhys differs from the research code, the difference is written out on that page. Some tests take their expected values from it, written into the test files; the tests that compare results with its output files need the maintainer’s data and are skipped without it, as the Testing page explains. The parsers and specs of the unpublished studies stay in the research code.
Note
This project is under active development.
Contents:
- Installation
- Usage
- Quickstart: a synthetic sweep from segments to a space
- Lineage, phases, and stages
- Workflow: from trajectories to a space
- Studies: adding a study
- Statistics: error bars for time averages
- Clusters: contacts, cluster sizes, and binding
- Correlations: autocorrelation, decay fits, and bond cosines
- Density: local number density and volume fraction
- Pipeline: reducing a space down the lineage
- Probe: per-frame observables from LAMMPS trajectories
- Simulate: LAMMPS logs, dumps, data files, and start configurations
- Viz: color lists and matplotlib helpers for figures
- Testing
- Simulation design: the values the names do not carry
- Design decisions
- API stability
- API