Skip to main content

Wailord is a python library to interact with ORCA

Project description

Logo of sorts from wallhaven https://img.shields.io/pypi/v/wailord.svg Zenodo Status Build Status Documentation Status Updates

Wailord is a python library to interact with ORCA

Being written up. Till then feel free to use the ZenodoDOI.

Features

  • Part of the rgpkgs suite: depends on rgpycrumbs (config/pins/ensure_import) and chemparseplot (unit helpers). Suite config is shared (~/.config/rgpkgs/config.toml, project rgpkgs.toml) — wailord does not invent its own pin file. See wailord.suite.

  • Integrates with SLURM in a manner of speaking

  • Generic helpers for building arbitrary input files

  • Generates data-frames for all supported runs

Limitations

  • By choice, the split-job syntax has not been included

Credits

Install (rgpkgs suite)

Recommended one-shot for the full suite peers (chemparseplot grammar track + pychum inputs):

pip install 'wailord[suite]'

That expands to wailord[grammar,pychum]: grammar-backed XYZ/ORCA text parsing and modern ORCA input generation. Hard deps already pull rgpycrumbs and chemparseplot; the suite extra adds the optional grammar stack and pychum.

Manual peer list (secondary; prefer the suite extra above):

pip install 'chemparseplot[grammar]' pychum rgpycrumbs

Migration (rgpkgs suite)

Wailord is a batch / experiment shell for ORCA workflows. Parsing and plotting belong in chemparseplot; new ORCA inputs belong in pychum.

  • wailord.io.xyz.xyzIOchemparseplot.api.parse_xyz / chemparseplot.parse.grammar

  • wailord.io.orca.parseOutchemparseplot.api.parse_orca_final_energy / parse_orca_text_summary

  • wailord.io.orca.orcaVis → chemparseplot plot/parse modules for surfaces

  • wailord.io.inp.inpGeneratorpychum.render_orca (deprecated wrapper)

What stays in wailord (batch shell):

* Cookiecutter experiment scaffolding (``wailord.exp.cookies``, ``_templates/``)
* HTST rate helper (``wailord.io.orca.calc_htst``) over frequency-job outputs
* SLURM-oriented out-file filters in multi-job table loaders

eOn CON/outcome I/O never lives in wailord — use chemparseplot and readcon-core (PyPI: readcon). siuba experiment APIs are not part of the suite and are not ported.

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

wailord-0.1.5.tar.gz (96.9 kB view details)

Uploaded Source

Built Distribution

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

wailord-0.1.5-py3-none-any.whl (36.9 kB view details)

Uploaded Python 3

File details

Details for the file wailord-0.1.5.tar.gz.

File metadata

  • Download URL: wailord-0.1.5.tar.gz
  • Upload date:
  • Size: 96.9 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.1.0 CPython/3.13.14

File hashes

Hashes for wailord-0.1.5.tar.gz
Algorithm Hash digest
SHA256 9d78205ca97fcab1ede646a74083b2e4bb817dc8e37e9b02c686c1f25fb57b0d
MD5 ee4fcba0524ac1c3301a3095231d46dc
BLAKE2b-256 a9dae07819adedd75d927a65833a33d9716e4c586c44068b47ead6a704962c77

See more details on using hashes here.

File details

Details for the file wailord-0.1.5-py3-none-any.whl.

File metadata

  • Download URL: wailord-0.1.5-py3-none-any.whl
  • Upload date:
  • Size: 36.9 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.1.0 CPython/3.13.14

File hashes

Hashes for wailord-0.1.5-py3-none-any.whl
Algorithm Hash digest
SHA256 9aa523177794042aba1c2cec0d3a30dabf6f5da48847a6ab5afc6a5355e6ee30
MD5 8ef9a8913e86d7f93db1da6d5d7c40e3
BLAKE2b-256 24135972452cdc5e5b8ad4c8a21d1b9befaac9d0b75206844210ac66faef352d

See more details on using hashes here.

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