Skip to main content

openWFN: lightweight wavefunction geometry analysis toolkit

Project description

openWFN

PyPI version Python versions License Tests

  ___   ____   _____  _   _ __        __ _____  _   _
 / _ \ |  _ \ | ____|| \ | |\ \      / /|  ___|| \ | |
| | | || |_) ||  _|  |  \| | \ \ /\ / / | |_   |  \| |
| |_| ||  __/ | |___ | |\  |  \ V  V /  |  _|  | |\  |
 \___/ |_|    |_____||_| \_|   \_/\_/   |_|    |_| \_|

openWFN is a lightweight command-line toolkit for molecular geometry analysis from Gaussian checkpoint data. It is designed for fast, script-friendly workflows around .fchk files.

Installation

pip install openwfn

Start

Run openWFN on a formatted checkpoint file:

openwfn molecule.fchk summary
openwfn molecule.fchk dist 1 2
openwfn molecule.fchk graph
openwfn molecule.fchk xyz molecule.xyz
openwfn molecule.fchk view

If no subcommand is provided:

  • in a TTY terminal, openwfn starts interactive mode
  • in non-interactive contexts, openwfn runs summary

Stable commands:

  • summary
  • info
  • dist i j
  • angle i j k
  • dihedral i j k l
  • bonds
  • graph
  • xyz output.xyz
  • view

view exports a fully local HTML molecule viewer powered by bundled 3Dmol.js. It supports atom labels, style toggles, and built-in downloads for XYZ, PDB, SDF, PNG, JPEG, and SVG.

Example Sessions

openwfn examples/water/water.fchk summary
openwfn examples/water/water.fchk dist 2 1
openwfn examples/water/water.fchk angle 2 1 3
openwfn examples/methane/methane.fchk graph
openwfn examples/water/water.fchk view
openwfn examples/water/water.fchk

To save a standalone viewer file:

openwfn examples/water/water.fchk view --save viewer.html --no-open

Release

Build and validate:

python -m build --no-isolation
python -m twine check dist/*

Upload to PyPI:

python -m twine upload dist/*

License

MIT License. See LICENSE.

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

openwfn-0.5.0.tar.gz (182.7 kB view details)

Uploaded Source

Built Distribution

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

openwfn-0.5.0-py3-none-any.whl (182.0 kB view details)

Uploaded Python 3

File details

Details for the file openwfn-0.5.0.tar.gz.

File metadata

  • Download URL: openwfn-0.5.0.tar.gz
  • Upload date:
  • Size: 182.7 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.2.0 CPython/3.11.14

File hashes

Hashes for openwfn-0.5.0.tar.gz
Algorithm Hash digest
SHA256 5eb68a6393149bce982496e5d844cfe53d3cd16dbf30fa84fb1658395a9fd122
MD5 ee95c2c1003da5583985aaf1d7a9287c
BLAKE2b-256 e8c4c83e6268b3cd721a2f4631095e6c0aeb8370fb2f5be4d22e8a876722f1a2

See more details on using hashes here.

File details

Details for the file openwfn-0.5.0-py3-none-any.whl.

File metadata

  • Download URL: openwfn-0.5.0-py3-none-any.whl
  • Upload date:
  • Size: 182.0 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.2.0 CPython/3.11.14

File hashes

Hashes for openwfn-0.5.0-py3-none-any.whl
Algorithm Hash digest
SHA256 092dca415e6a58d3b7b674ba8ab8e91bf70b823213355d24f84077cdfb003620
MD5 ef2546c2f99148bce3efe036c07d8a86
BLAKE2b-256 0f942e72395c54305452daf7401b30656e5e16bcfa615493025922427d3e13c9

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