Skip to main content

Truncated Wigner on GPUs based on JAX.

Project description

jTWA

Documentation Status codecov

jTWA implements the semiclassical Truncated Wigner Approximation (TWA) in python, relying on Google's jax library. This allows to write easily understandable python code without compromising on speed, as all calculations are compiled and executed on GPUs, if available.

jTWA is designed to work with bosonic systems with potentially different numbers of internal degrees of freedom. However, basic functionalities for spin-1 systems are already available in jTWA.spin1.

Documentation & Installation

All code is documented on readthedocs. Working with jTWA is designed to be straightforward. For the installation procedure, have a look at the corresponding section in the documentation.

Getting Started: A Minimal Example

A minimal working example of the codebase can be found in the main.py located in the root of the directory. To execute, run python main.py config.json as described in the quickstart section of the documentation. To demonstrate the elementary features, here are the contents of the main.py:

import jax
import sys
import json
import matplotlib.pyplot as plt

jax.config.update("jax_enable_x64", True)

import jTWA


if __name__ == "__main__":
    configuration_file = sys.argv[1]

    with open(configuration_file) as f:
        cfg = json.load(f)

    spin_operators = jTWA.spin1.observables.get_spin_operators(cfg)
    samples = jTWA.spin1.initState.getPolarState(cfg)

    cfg = jTWA.spin1.hamiltonian.update_cfg(cfg)
    hamiltonian = jTWA.spin1.hamiltonian.hamiltonian

    obs = jTWA.integrate.obtain_evolution(samples, hamiltonian, spin_operators, cfg)
    jTWA.util.write_data(obs, cfg)

    obs = jTWA.util.read_data(cfg)
    jTWA.visualization.create_visuals(obs, cfg)
    plt.show()

Issues & Requests

If you encounter any issues, please open an issue or submit a pull request.

License

Apache License 2.0

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

jtwa-0.0.4.tar.gz (1.2 MB view details)

Uploaded Source

Built Distribution

jtwa-0.0.4-py2.py3-none-any.whl (15.9 kB view details)

Uploaded Python 2 Python 3

File details

Details for the file jtwa-0.0.4.tar.gz.

File metadata

  • Download URL: jtwa-0.0.4.tar.gz
  • Upload date:
  • Size: 1.2 MB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/5.0.0 CPython/3.12.2

File hashes

Hashes for jtwa-0.0.4.tar.gz
Algorithm Hash digest
SHA256 7f663a716082ebd5a494a03b3563b417f888672ff9ee24aee25c0fec57ea31f6
MD5 47107ece31fabcdd59d84ba1df3b679f
BLAKE2b-256 b765af7694d26e63bd778e7d90c60bacfaa08b6fd8ab2891eb3a8971655251ea

See more details on using hashes here.

File details

Details for the file jtwa-0.0.4-py2.py3-none-any.whl.

File metadata

  • Download URL: jtwa-0.0.4-py2.py3-none-any.whl
  • Upload date:
  • Size: 15.9 kB
  • Tags: Python 2, Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/5.0.0 CPython/3.12.2

File hashes

Hashes for jtwa-0.0.4-py2.py3-none-any.whl
Algorithm Hash digest
SHA256 5ff427e8be0d8bfffaa211eb23783365577712651d85bdc49e710524aa6bbe7b
MD5 bab8edb7f87111c7feba3b2ac1da3983
BLAKE2b-256 36bd8e9887eb7ae61cacf17c8cddabd7ed48cf7a06745f4329035860be36467b

See more details on using hashes here.

Supported by

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