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.
  • ORCA optimization energy and bond-distance text 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.
  • ORCA optimization history: electronic energy from orca.out and one zero-based atom-pair distance from orca_trj.xyz.

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
cctop orca-history path/to/job 0 12

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

For an ORCA optimization job whose output is orca.out and trajectory is orca_trj.xyz, export gnuplot-friendly histories with:

cctop orca-history path/to/job 0 12 --energy-output energy.txt --distance-output bond.txt

The atom indices are zero-based. Each text file contains two columns: optimization step and value.

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.2.tar.gz (22.0 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.2-py3-none-any.whl (23.6 kB view details)

Uploaded Python 3

File details

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

File metadata

  • Download URL: compchem_cctop-0.2.2.tar.gz
  • Upload date:
  • Size: 22.0 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.2.tar.gz
Algorithm Hash digest
SHA256 b503c40377c5eab5df87eba39cf84db23c2f76dba3afc76e0de6d0ac6e90707f
MD5 12ce83b674765a9b604f7605a23d0889
BLAKE2b-256 4dd3ec4472638a0e92a15b80ae09c69b5d260b3382c70692564b88d8d0911a8b

See more details on using hashes here.

Provenance

The following attestation bundles were made for compchem_cctop-0.2.2.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.2-py3-none-any.whl.

File metadata

  • Download URL: compchem_cctop-0.2.2-py3-none-any.whl
  • Upload date:
  • Size: 23.6 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.2-py3-none-any.whl
Algorithm Hash digest
SHA256 28ed64c61bccf51d753e4cf288b98946e8a8f71a4618093b9fbef18744c35965
MD5 0686ad87500b679e6c3004ab0dceb3b9
BLAKE2b-256 5ecacf0b7049d07f76efd1412770d9e6ae2c3b29e91319b876baec9fdae1a058

See more details on using hashes here.

Provenance

The following attestation bundles were made for compchem_cctop-0.2.2-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