PhaseSpaceChem
Electron Transfer, Diabatic Couplings, and Vibronic Energy Gaps in a Phase Space Framework
PhaseSpaceChem is a Python library designed to calculate electronic states and vibronic energy gaps using a novel Phase Space (PS) framework. By treating the electronic system as dependent on both the position ($R$) and momentum ($P$) of the nuclei, this method achieves significantly higher accuracy than standard Born-Oppenheimer or Born-Huang approximations, while naturally conserving momentum.
Features
- Shin-Metiu Model Generator: Flexible 1D 1-electron, 3-ion Hamiltonian matrix generation.
- Phase Space Hamiltonian: Construction of $\hat{H}_{W,el}^{PS}(R, P)$ directly in phase space.
- Diabatization Engine: Generalized Mulliken-Hush (GMH) diabatization optimized for phase space adiabatic states ($U(R, P)$).
- Inverse Weyl Transform: Re-quantization of phase space operators back into Hilbert space.
- Momentum Conservation: Inherently respects conservation laws often violated by truncated ad-hoc corrections.
Installation
You can install phase_space_chem directly from source:
git clone https://github.com/username/phase_space_chem.git
cd phase_space_chem
pip install .
For development (editable install):
pip install -e .[dev]
Usage
Here is a basic example of how to initialize the grids and compute a Shin-Metiu potential:
import numpy as np
import matplotlib.pyplot as plt
from phase_space_chem import grids, potentials
# 1. Define Grid Parameters
n_r = 151 # Electronic points
n_R = 151 # Nuclear points
n_P = 151 # Momentum points
# 2. Generate Grids
R_grid, r_grid = grids.generate_position_grids(
num_nuclear_points=n_R,
num_electronic_points=n_r
)
P_grid = grids.generate_momentum_grid(R_grid, n_P)
# 3. Compute Potential
# Parameters: Fixed Separation=20.0, Mobile Screening=5.0, Fixed Screening=4.0
V_rR = potentials.compute_shin_metiu_potential(
electronic_position_grid=r_grid,
nuclear_position_grid=R_grid,
fixed_ion_separation=20.0,
mobile_ion_screening=5.0,
fixed_ion_screening=4.0
)
print(f"Potential Shape: {V_rR.shape}")
References
This project incorporates research from the following paper:
- Electron Transfer, Diabatic Couplings and Vibronic Energy Gaps in a Phase Space Framework Zain Zaidi, Xuezhi Bian, Joseph E. Subotnik arXiv:2601.16209
Metadata
Release files for phase-space-chem 0.1.0
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 | |
|---|---|---|---|---|
| phase_space_chem-0.1.0.tar.gz | 14.5 kB | With provenance | Details |
Built distribution (wheel)
| File | Interpreter | ABI | Platform | Reset |
|---|---|---|---|---|
| phase_space_chem-0.1.0-py3-none-any.whl | Python 3 | none | any | Details |
Total release size: 25.1 kB
Release files / phase_space_chem-0.1.0.tar.gz
| Download URL | phase_space_chem-0.1.0.tar.gz |
|---|---|
| Size | 14.5 kB |
| Tags | Source |
|
SHA-256 checksum How to use checksums |
c76b94baff4672e8e4436ea826981fc0c61fe1293bfd9b8e04f32471dfdbe717
|
|
BLAKE2b-256 checksum How to use checksums |
ba193fc8e326e9f256962c6a578183225c512a2ac9b14f6a029aa707323117ed
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
Yes |
| Uploaded via |
twine/6.1.0 CPython/3.13.7
|
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.
PyPI Publish Attestation
PyPI verified that this artifact, at this checksum, originated from the publisher listed below.
Signed by GitHub Actions, verified by PyPI on Jan 31, 2026.
Transparency logRelease files / phase_space_chem-0.1.0-py3-none-any.whl
| Download URL | phase_space_chem-0.1.0-py3-none-any.whl |
|---|---|
| Size | 10.6 kB |
| Tags | Python 3 |
|
SHA-256 checksum How to use checksums |
402855ea9cd8dbc05e30e10ffb154885de4f0372bcb5d1e31993a3991f1dd2db
|
|
BLAKE2b-256 checksum How to use checksums |
a13c632c5daed532c09c558fd4e69310156ccffc2bb31d0cfa74fd688798f44d
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
Yes |
| Uploaded via |
twine/6.1.0 CPython/3.13.7
|
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.
PyPI Publish Attestation
PyPI verified that this artifact, at this checksum, originated from the publisher listed below.
Signed by GitHub Actions, verified by PyPI on Jan 31, 2026.
Transparency logSecurity for phase-space-chem 0.1.0
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.
Full provenance
All 2 files in this release have been uploaded with provenance metadata.
Attestation for phase_space_chem-0.1.0.tar.gz
PyPI Publish Attestation
PyPI verified that this artifact, at this checksum, originated from the publisher listed below.
Signed by GitHub Actions, verified by PyPI on Jan 31, 2026.
Transparency logA 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.