Skip to main content

Numerical quantum mechanics of chain-like systems based on tensor trains

Project description

WaveTrain

by Jerome Riedel, Patrick Gelß, and Burkhard Schmidt

Freie Universität Berlin, Germany

WaveTrain-Logo

Short description

WaveTrain is an open-source software for numerical simulations of chain-like quantum systems with nearest-neighbor (NN) interactions only (with or without periodic boundary conditions). This Python package is centered around tensor train (TT, or matrix product) representations of quantum-mechanical Hamiltonian operators and (stationary or time-evolving) state vectors. WaveTrain builds on the Python tensor train toolbox scikit_tt, which provides efficient construction methods, storage schemes, as well as solvers for eigenvalue problems and linear differential equations in the TT format.

WaveTrain comprises solvers for time-independent and time-dependent Schrödinger equations employing TT decompositions to construct low-rank representations. Often, the TT ranks of state vectors are found to depend only marginally on the chain length N, which results in the computational effort growing only slightly more than linearly in N, thus mitigating the curse of dimensionality. Thus, WaveTrain complements the existing WavePacket project at SourceForge which does not offer these advantages but which can be used for general Hamiltonians, i.e., without restriction to chain-like systems.

As a complement to the Python classes for full quantum mechanics, WaveTrain also contains classes for fully classical and mixed quantum-classical (Ehrenfest or mean field) dynamics of bipartite ("slow-fast" and/or "heavy-light") systems. Moreover, the graphical capabilities allow visualization of quantum dynamics ‘on the fly’, with a choice of several different graphical representations based on reduced density matrices.

Full description

For a detailed description of the WaveTrain software, see our article that appeared in April 2023 in J. Chem. Phys.[^1].

Installation

After downloading and installing the Python tensor train toolbox scikit_tt, installation of the WaveTrain software package is straightforward

pip install git+https://github.com/PGelss/scikit_tt
pip install wave_train 

where pip belongs to a Python installation with minimum version requirement 3.7.0. For a developer installation you can download the latest version of WaveTrain to your local computer by using the 'git clone' command.

git clone https://github.com/PGelss/wave_train.git 
cd wave_train
python setup.py install --user

Applications

see our work on solving the TISE[^2] and TDSE[^3] for coupled excitons and phonons

[^1]: J. Riedel, P. Gelß, R. Klein, and B. Schmidt, "WaveTrain: A Python Package for Numerical Quantum Mechanics of Chain-Like Systems Based on Tensor Trains", J. Chem. Phys. 158 (16), 164801 (2023)

[^2]: P. Gelß, R. Klein, S. Matera, B. Schmidt, "Solving the Time-Independent Schrödinger Equation for Chains of Coupled Excitons and Phonons using Tensor Trains", J. Chem. Phys. 156 (2), 024109 (2022)

[^3]: P. Gelß, R. Klein, S. Matera, and B. Schmidt, "Quantum Dynamics of Coupled Excitons and Phonons in Chain-Like Systems: Tensor Train Approaches and Higher-Order Propagators", arXiv:2302.03725

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

wave_train-1.0.11.tar.gz (67.9 kB view details)

Uploaded Source

Built Distribution

wave_train-1.0.11-py3-none-any.whl (84.7 kB view details)

Uploaded Python 3

File details

Details for the file wave_train-1.0.11.tar.gz.

File metadata

  • Download URL: wave_train-1.0.11.tar.gz
  • Upload date:
  • Size: 67.9 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/4.0.2 CPython/3.9.18

File hashes

Hashes for wave_train-1.0.11.tar.gz
Algorithm Hash digest
SHA256 d478b8319f4dd46a0ed1b75dd9154eb5d5207c9ace72af43007ffa46d26fe9d9
MD5 2128215f33c8b61ea9cd75c45f76e0c1
BLAKE2b-256 1052fdab83d0cbb154c9c091e1d7032e167f123a261900e3fa73cf9e343f48a6

See more details on using hashes here.

File details

Details for the file wave_train-1.0.11-py3-none-any.whl.

File metadata

  • Download URL: wave_train-1.0.11-py3-none-any.whl
  • Upload date:
  • Size: 84.7 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/4.0.2 CPython/3.9.18

File hashes

Hashes for wave_train-1.0.11-py3-none-any.whl
Algorithm Hash digest
SHA256 80434fd3a15c6be6be998d862656ba7a010511d8b8ff3f59f49337383aeb8a26
MD5 c8fe8f0886b4d936bace2c447458a182
BLAKE2b-256 4128a872621c3e2a9da36522e55c859bf54eb38026a9272f0404cc180a6058f5

See more details on using hashes here.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page