Metadata-Version: 2.4
Name: greenWTE
Version: 1.0.0
Summary: Solve the Wigner Transport Equation with a source term!
Project-URL: Homepage, https://github.com/kremeyer/greenWTE
Project-URL: Documentation, https://greenwte.readthedocs.io
Project-URL: Repository, https://github.com/kremeyer/greenWTE
Project-URL: Changelog, https://github.com/kremeyer/greenWTE/blob/main/CHANGELOG.md
Project-URL: Author, https://scholar.google.com/citations?user=gKsq_08AAAAJ
Author-email: Laurenz Kremeyer <laurenz.kremeyer@mail.mcgill.ca>
License-Expression: BSD-3-Clause
License-File: LICENSE
Classifier: Development Status :: 5 - Production/Stable
Classifier: Environment :: GPU
Classifier: Intended Audience :: Science/Research
Classifier: License :: OSI Approved :: BSD License
Classifier: Topic :: Scientific/Engineering :: Physics
Requires-Python: >=3.10
Requires-Dist: h5py
Requires-Dist: hdf5plugin
Requires-Dist: numpy>=2
Requires-Dist: scipy~=1.15
Provides-Extra: cuda12x
Requires-Dist: cupy-cuda12x>=12.0; extra == 'cuda12x'
Provides-Extra: cuda13x
Requires-Dist: cupy-cuda13x>=13.0; extra == 'cuda13x'
Description-Content-Type: text/x-rst

.. BEGIN-INTRO

greenWTE - Solve the Wigner Transport Equation with a source term!
==================================================================

greenWTE is a Python package to solve the Wigner Transport Equation (WTE) in spatial and temporal Fourier space
for arbitrary source terms. This allows to compute thermal conductivities from bulk to nanoscale, from static to
high frequency regimes. Beyond that it can be used to study the response of materials to arbitrary heat sources.

Derived from the Wigner formulation of quantum mechanics, the WTE describes heat transport in terms of particlelike
and wavelike conduction mechanisms. The full and very detailed derivation can be found in the work by Simoncelli,
Marzari and Mauri in their paper `"Wigner Formulation of Thermal Transport in Solids" [Phys. Rev. X 12 (2022)]
<WTE_paper_>`_.

.. _WTE_paper: https://journals.aps.org/prx/abstract/10.1103/PhysRevX.12.041011

.. END-INTRO

----

.. image:: https://github.com/kremeyer/greenWTE/actions/workflows/ci.yml/badge.svg?branch=main
    :target: https://github.com/kremeyer/greenWTE/actions/workflows/ci.yml?query=branch%3Amain
    :alt: CI status

.. image:: https://codecov.io/github/kremeyer/greenWTE/branch/main/graph/badge.svg?token=3W1D1HOSW2
    :target: https://codecov.io/github/kremeyer/greenWTE
    :alt: Codecov status

.. image:: https://img.shields.io/pypi/pyversions/greenWTE
   :alt: PyPI - Python Version


- The full documentation including installation instructions, tutorials and API reference is hosted on `Read the Docs`_.
- Releases are available on `PyPI`_ and can be installed via ``pip install greenWTE[cuda12x,cuda13x]``.
- The source code is available on `GitHub`_.

.. _Read the Docs: https://greenwte.readthedocs.io/
.. _PyPI: https://pypi.org/project/greenWTE/
.. _GitHub: https://github.com/kremeyer/greenWTE
