Table of Contents
About
A pure-python project to generate input files for various common computational chemistry workflows. This means:
- Generating input structures for
jobflow/ Fireworks- From unified
tomlinputs
- From unified
This is a spin-off from wailord (here) which is meant to handle aggregated
runs in a specific workflow, while pychum is meant to generate single runs.
It is also a companion to chemparseplot (here) which is meant to provide
uniform visualizations for the outputs of various computational chemistry
programs.
Features
- Jobflow support
- Along with Fireworks
- Unit aware conversions
- Via
pint
- Via
Supported Engines
- NEB calculations
- ORCA
- EON
- Single point calculations
- ORCA
- EON
Rationale
I needed to run a bunch of systems. jobflow / Fireworks / AiiDA were ideal,
until I realized only VASP is really well supported by them.
Usage
The simplest usage is via the CLI:
python -m pychum.cli
Development
Before writing tests and incorporating the functions into the CLI it is helpful to often visualize the intermediate steps. For this we can setup a complete development environment including the notebook server.
pixi shell
pdm sync
pdm run $SHELL
jupyter lab --ServerApp.allow_remote_access=1 \
--ServerApp.open_browser=False --port=8889
Then go through the nb folder notebooks.
Adding ORCA blocks
Changes are to be made in the following files under the pychum/engine/orca/ folder:
- The relevant
.jinjafile in the_blocksdirectory - The configuration loading mechanism in
config_loader.py - The
dataclassesfolder - A sample test
.tomlfile undertests/test_orca
While working on this, it may be instructive to use the nb folder notebooks.
Also all PRs must include a full test suite for the new blocks.
Documentation
Readme
The readme can be constructed via:
./scripts/org_to_md.sh readme_src.org readme.md
License
MIT. However, this is an academic resource, so please cite as much as possible via:
- The Zenodo DOI for general use.
- The
wailordpaper for ORCA usage
Metadata
Release files for pychumpchem 0.0.1
For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.
Source distribution (sdist)
| File | Size | Uploaded | Provenance | Actions |
|---|---|---|---|---|
| pychumpchem-0.0.1.tar.gz | 15.4 kB | Without provenance | Details for pychumpchem-0.0.1.tar.gz |
Built distribution (wheel)
| File | Interpreter | ABI | Platform | Actions Reset |
|---|---|---|---|---|
| pychumpchem-0.0.1-py3-none-any.whl | Python 3 | none | any | Details for pychumpchem-0.0.1-py3-none-any.whl |
Total release size: 34.9 kB
Release files / pychumpchem-0.0.1.tar.gz
| Download URL | pychumpchem-0.0.1.tar.gz |
|---|---|
| Size | 15.4 kB |
| Tags | Source |
|
SHA-256 checksum How to use checksums |
33aad5c8123bd7908dcbfd8e99512db969603c3f2b2d14e6e65ec887767754a2
|
|
BLAKE2b-256 checksum How to use checksums |
d03e4daa1b4325151cf7148d064ff933bb29c553ba3620260975126fd1a5f2fe
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
twine/5.1.1 CPython/3.12.7
|
Release files / pychumpchem-0.0.1-py3-none-any.whl
| Download URL | pychumpchem-0.0.1-py3-none-any.whl |
|---|---|
| Size | 19.6 kB |
| Tags | Python 3 |
|
SHA-256 checksum How to use checksums |
3a9798fac19a6ea2fbd93bb6ef5de04e8e72162d4ddf897ca7a06b0c987f05d5
|
|
BLAKE2b-256 checksum How to use checksums |
460e8edb81cb5fbf0385e62d360dc064e4cb1b6bf158cfde7d4f7698a752e986
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
twine/5.1.1 CPython/3.12.7
|
Security for pychumpchem 0.0.1
Provenance
Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.
No provenance found
None of the files in this release were uploaded with provenance metadata.
A note on package security
PyPI is a repository for distributing packages, not a service for auditing them. While third-party security researchers and our staff do their best to detect and remove malicious packages, PyPI cannot guarantee the quality, security or suitability of any given package.
To learn more about protecting yourself from malicious actors, visit our package security documentation.