Skip to main content

A minimal terminal dashboard for computational chemistry output files.

Project description

cctop

cctop is a minimal terminal dashboard for computational chemistry output folders.

cctop demo terminal output

  • ORCA output parsing.
  • Experimental VASP, Gaussian, Q-Chem, and xTB/CREST parsing.
  • Directory scan.
  • Single-file inspect.
  • CSV/JSON export.
  • Basic terminal UI when run in a real terminal.

Support

Current:

  • ORCA: status, final energy, method/basis, charge/multiplicity, Gibbs energy, frequencies, runtime, and common warning markers.
  • VASP: experimental OUTCAR and OSZICAR detection, status, final energy, runtime, and convergence markers.
  • Gaussian: experimental .log/.out status, route method/basis, charge/multiplicity, final energy, frequencies, runtime, and termination markers.
  • Q-Chem: experimental status, method/basis, charge/multiplicity, final energy, frequencies, runtime, and convergence markers.
  • xTB/CREST: experimental status, method hints, final energy, runtime, and convergence markers.

Not yet supported:

  • vasprun.xml
  • Rich per-step convergence history
  • Program-specific tables beyond the shared summary fields

Usage

cctop .
cctop job_001 job_002 job_003
cctop path/to/orca.out
cctop export .
cctop export batch_a batch_b --format json
cctop export . --format json

Directory scans recurse into subdirectories, so cctop . works for project folders with one job per subfolder.

When stdout is not attached to a terminal, cctop prints a plain text summary instead of opening the TUI.

Try the demo data:

cctop testing/demo_orca_project

Install

From PyPI:

pipx install compchem-cctop

or:

python -m pip install compchem-cctop

For a local checkout:

python -m pip install -e .

For an isolated command-line install:

pipx install .

Development

python -m pip install -e ".[dev]"
python -m cctop .
python -m unittest discover -s tests

The test suite includes small real-output fixtures from cclib and pymatgen, with their licenses included under tests/fixtures/real/.

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

compchem_cctop-0.2.1.tar.gz (19.9 kB view details)

Uploaded Source

Built Distribution

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

compchem_cctop-0.2.1-py3-none-any.whl (22.0 kB view details)

Uploaded Python 3

File details

Details for the file compchem_cctop-0.2.1.tar.gz.

File metadata

  • Download URL: compchem_cctop-0.2.1.tar.gz
  • Upload date:
  • Size: 19.9 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/6.1.0 CPython/3.13.12

File hashes

Hashes for compchem_cctop-0.2.1.tar.gz
Algorithm Hash digest
SHA256 975371460f13124e20671e8e7d7ec5c38a23cde9b60be63c502485a6e9c294e0
MD5 9199ee0edb897775cbf867758fe173f9
BLAKE2b-256 c6c86afc9c299433d1cc057dffc152bfee5aec9b2cff5c0ded1954aac996476c

See more details on using hashes here.

Provenance

The following attestation bundles were made for compchem_cctop-0.2.1.tar.gz:

Publisher: publish.yml on JEFF7712/cctop

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

File details

Details for the file compchem_cctop-0.2.1-py3-none-any.whl.

File metadata

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

File hashes

Hashes for compchem_cctop-0.2.1-py3-none-any.whl
Algorithm Hash digest
SHA256 c9d7b14d9d293ec28ddeaca9739eb6b0bb7c9d10aaacd696567acb78549aa880
MD5 3d2b896670e7a02e68669918699effc8
BLAKE2b-256 b571b9da7d390ab4c281ee108a1a63b3cf4af04217e0ddf42a86a0d25661c05e

See more details on using hashes here.

Provenance

The following attestation bundles were made for compchem_cctop-0.2.1-py3-none-any.whl:

Publisher: publish.yml on JEFF7712/cctop

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