Metadata-Version: 2.1
Name: rheedium
Version: 2024.11.15
Summary: Differentiable RHEED simulations in JAX
Author-email: Debangshu Mukherjee <mukherjeed@ornl.gov>
Maintainer-email: Debangshu Mukherjee <mukherjeed@ornl.gov>
Project-URL: Homepage, https://code.ornl.gov/intersect-em/rheedium
Keywords: RHEED,Ewald,JAX,MBE
Classifier: Programming Language :: Python :: 3
Classifier: License :: OSI Approved :: MIT License
Classifier: Operating System :: POSIX :: Linux
Classifier: Environment :: GPU :: NVIDIA CUDA
Classifier: Typing :: Typed
Requires-Python: >=3.10
Description-Content-Type: text/markdown
Requires-Dist: numpy
Requires-Dist: scipy
Requires-Dist: matplotlib
Requires-Dist: matplotlib-scalebar>=0.5.0
Requires-Dist: tqdm>=4.66.0
Requires-Dist: jax[cuda12]>=0.4.17
Requires-Dist: jaxtyping>=0.2.21
Requires-Dist: chex>=0.1.85
Requires-Dist: optax>=0.1.8
Requires-Dist: pytest>=8.0.0
Requires-Dist: beartype
Requires-Dist: pymatgen
Provides-Extra: test
Requires-Dist: pytest>=7.0; extra == "test"
Requires-Dist: pytest-cov; extra == "test"
Requires-Dist: absl-py; extra == "test"

![Coverage](.badges/coverage.svg)
# Differentiable RHEED simulations in JAX

The aim of this project is to write RHEED simulations in [JAX](https://github.com/google/jax) so that it's end to end differentiable.

This will install the package as `rheedium`, which is the package that all the codes are.

The codes themselves are in the _src_ directory, following the modern toml convention as the _rheedium_ folder.
