Skip to main content

A package that help analyze PQ energy and parameter output.

Project description

CI codecov License: MIT

PQEnalyzer

Energy and parameter analyzer for PQ molecular dynamics trajectories.

Installation

Install with pip:

pip install PQEnalyzer

Usage

Open the GUI by passing one or more supported input files to the gui mode. PQEnalyzer detects PQ energy, QMCFC energy, and box files automatically:

pqenalyzer gui pq_output.en

Open the terminal interface for simulation monitoring:

pqenalyzer tui pq_output.en

Read QMCFC output:

pqenalyzer gui --qmcfc pq_output.en

Force PQ energy parsing:

pqenalyzer gui --pq pq_output.en

Plot PQ box parameters from a .box file:

pqenalyzer gui examples/box-01.box

Use --box when a box file does not use the conventional .box suffix.

Multiple input files can be plotted together when they expose the same parameters and units:

pqenalyzer gui md-01.en md-02.en md-03.en

The tui mode opens a full-screen terminal dashboard with file status, per-parameter latest/mean/min/max values, compact trends, file-change watching, and focused terminal charts. Use up/j and down/k to select a parameter, enter to open its chart, esc to return to the dashboard, q to quit, r to refresh manually, and w to pause or resume watching. Focused charts include statistics overlays: m toggles mean, n toggles median, c toggles cumulative average, s toggles self-correlation mean, x toggles difference, and a toggles running average.

In GUI mode, Live Monitor opens a raw overview with one panel per parameter. Auto-Refresh watches the loaded file for changes and redraws open plots when new simulation output is written. Disable Auto-Refresh to pause file watching. Double-click a monitor panel to open a focused plot for that parameter. Statistics and time-series overlay controls apply to the selected focused plot, while the monitor stays raw for simulation monitoring.

Input Files

PQEnalyzer reads energy output through PQAnalysis. Each .en file is expected to have its matching .info sidecar file next to it.

PQEnalyzer also reads PQ box files through PQAnalysis. Box files are expected to contain step x y z alpha beta gamma columns. The plotted parameters are BOX-X, BOX-Y, BOX-Z, ALPHA, BETA, GAMMA, and BOX-VOLUME.

When multiple files are supplied, their parsed parameter mappings and units must match. Files with different columns or incompatible units are rejected before plotting.

Difference plots additionally require both files to have the same simulation-time axis.

Development

Install the package with test dependencies:

pip install -e ".[test]"

Run the default test suite:

python -m pytest -q

Benchmark tests require pytest-benchmark. If it is not installed, benchmark tests are skipped by default.

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

pqenalyzer-0.8.0.tar.gz (2.6 MB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

pqenalyzer-0.8.0-py3-none-any.whl (61.2 kB view details)

Uploaded Python 3

File details

Details for the file pqenalyzer-0.8.0.tar.gz.

File metadata

  • Download URL: pqenalyzer-0.8.0.tar.gz
  • Upload date:
  • Size: 2.6 MB
  • Tags: Source
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/6.1.0 CPython/3.13.12

File hashes

Hashes for pqenalyzer-0.8.0.tar.gz
Algorithm Hash digest
SHA256 d451f456c9f2e9957a35267d3081509e97367d0f0d098f8927f299f2e08012d4
MD5 6e35e11b341cc506d0d4e2d211d3afc5
BLAKE2b-256 97f5476107ca14a403267862d8157ec1ca59d047bad684ced42af9e009d9606f

See more details on using hashes here.

Provenance

The following attestation bundles were made for pqenalyzer-0.8.0.tar.gz:

Publisher: release.yml on MolarVerse/PQEnalyzer

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

File details

Details for the file pqenalyzer-0.8.0-py3-none-any.whl.

File metadata

  • Download URL: pqenalyzer-0.8.0-py3-none-any.whl
  • Upload date:
  • Size: 61.2 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/6.1.0 CPython/3.13.12

File hashes

Hashes for pqenalyzer-0.8.0-py3-none-any.whl
Algorithm Hash digest
SHA256 3775feaa43d9b0bdf6a573ab0a2e02b739a44f4a2f98f2a7b45cbe04b8e8a3d6
MD5 fcdba883ba0de1c43184db194f880bca
BLAKE2b-256 f8826f79a32fd402aba6214f6463bc795583cd1f65dfe6cf9c83bd1899e48f1a

See more details on using hashes here.

Provenance

The following attestation bundles were made for pqenalyzer-0.8.0-py3-none-any.whl:

Publisher: release.yml on MolarVerse/PQEnalyzer

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page