Skip to main content

Plot and monitor PQ simulation output.

Project description

PQEnalyzer logo

CI codecov License: MIT

PQEnalyzer

Plot and monitor PQ energy, box, and optimizer output in a desktop or terminal interface.

Install

pip install PQEnalyzer

Quick Start

The GUI is the default:

pqenalyzer /path/to/simulation.en

Use the terminal interface with the tui subcommand:

pqenalyzer tui /path/to/simulation.en

PQEnalyzer detects the input format automatically. Use a format flag only when detection is ambiguous:

pqenalyzer --pq pq-output.en
pqenalyzer --qmcfc qmcfc-output.en
pqenalyzer --box box-output.data
pqenalyzer --opt optimization.data

pqenalyzer gui FILE is equivalent to pqenalyzer FILE.

Input

Output Conventional file Detection
PQ energy .en with matching .info .info layout
QMCFC energy .en with matching .info .info layout
PQ box .box suffix or file contents
PQ optimizer .opt suffix

Energy, box, and optimizer parsing is provided by PQAnalysis.

Energy files need a matching .info file in the same directory. PQ .info rows containing a single parameter column are supported.

Box files contain step x y z alpha beta gamma. PQEnalyzer plots BOX-X, BOX-Y, BOX-Z, ALPHA, BETA, GAMMA, and BOX-VOLUME.

Optimizer plots use the optimization step as the x-axis. They include energy changes, forces, convergence states, and limits. A convergence state of -1 means not converged, 0 means disabled, and 1 means converged. The first row is PQ's initialization snapshot. Final completion status remains in the PQ log.

GUI

Control Result
Plot Open a time-series plot for the selected parameter
Histogram Open its distribution
Live Monitor Open one time-series panel per parameter
Auto-Refresh Watch loaded files and update open plots

Double-click a Live Monitor panel to open its focused plot. Plot settings belong to that focused window, so each window can use different overlays.

Auto-refresh starts with the GUI. If native file watching is unavailable, PQEnalyzer uses polling and shows (polling) in the status line.

Plot windows refit when resized. The Live Monitor also redistributes its grid; press f to fit it to the current screen. Use Plot Size in the sidebar, + and - in a plot window, or Ctrl+0 / Command+0 to restore 100%.

PQEnalyzer remembers the theme, plot size, window dimensions, selected parameter, auto-refresh state, and plot settings. Set PQENALYZER_CONFIG_DIR to override the platform settings directory.

TUI

pqenalyzer tui FILE [FILE ...]
Key Action
Up / k, Down / j Select a parameter
Enter Open the selected chart
Esc Return to the dashboard
r Refresh
w Pause or resume file watching
q Quit

Plot Features

The GUI and TUI use the same plot features:

Feature Time series Histogram TUI key
Mean yes yes m
Median yes yes n
Cumulative Average yes no c
Self-Correlation Mean yes no s
Difference (1 - 2) yes no x
Running Average yes no a

Self-Correlation Mean stays on the data's original scale; it is not normalized.

Multiple Files

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

Common parameters are plotted together. A parameter found in only some files is plotted from those files. Shared parameters must use the same unit.

Difference plotting requires exactly two files and calculates file 1 - file 2. Points are matched by simulation time, simulation step, or optimization step. PQEnalyzer does not interpolate, extrapolate, or concatenate difference data. Raw series are hidden when Difference is enabled.

Development

pip install -e ".[test]"
python -m pytest -m "not benchmark and not e2e"

Run the end-to-end suite separately:

python -m pytest -m e2e

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.6.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.6-py3-none-any.whl (72.5 kB view details)

Uploaded Python 3

File details

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

File metadata

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

File hashes

Hashes for pqenalyzer-0.8.6.tar.gz
Algorithm Hash digest
SHA256 2fb86daef1e44abbade27055b434da1d0140f0f94ac5f0b9bb8bbcecf7594ccc
MD5 cf8c9d322afb4b4c4e7d6598771921cb
BLAKE2b-256 4bb466218ba1b99b46515c6d71b4262af64ad72a474e2d2a5766d7575026c335

See more details on using hashes here.

Provenance

The following attestation bundles were made for pqenalyzer-0.8.6.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.6-py3-none-any.whl.

File metadata

  • Download URL: pqenalyzer-0.8.6-py3-none-any.whl
  • Upload date:
  • Size: 72.5 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/7.0.0 CPython/3.13.14

File hashes

Hashes for pqenalyzer-0.8.6-py3-none-any.whl
Algorithm Hash digest
SHA256 ec127c02ffaf9bb399b360d44620562ea68acb33e54217edae3b8a67cf387fa8
MD5 6f8522e029a5275e314cbbefd2966b30
BLAKE2b-256 0f34dca163d2b01705e78a7f13adc6c374cf80ce026517fe46ddb14b42cb8b07

See more details on using hashes here.

Provenance

The following attestation bundles were made for pqenalyzer-0.8.6-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