diff --git a/README.md b/README.md index 5aa2398..b597139 100644 --- a/README.md +++ b/README.md @@ -1,16 +1,43 @@ -# PDEquinox -A collection of neural operator architecture for the image-to-image application, +

+ +
+ PDEquinox +
+

+ +

PDE Emulator Architectures in Equinox.

+ + +

+ Installation • + Quickstart +

+ +

+ +

+ +## Installation + +Clone the repository, navigate to the folder and install the package with pip: +```bash +pip install . +``` + +Requires Python 3.10+ and JAX 0.4.13+. 👉 [JAX install guide](https://jax.readthedocs.io/en/latest/installation.html). + + -### Quickstart +## Quickstart -Training a UNet to become an emulator for the 1D Poisson equation. +Train a UNet to become an emulator for the 1D Poisson equation. ```python import jax diff --git a/img/pdequinox_logo.png b/img/pdequinox_logo.png new file mode 100644 index 0000000..4e83345 Binary files /dev/null and b/img/pdequinox_logo.png differ diff --git a/img/pdequinox_teaser.png b/img/pdequinox_teaser.png new file mode 100644 index 0000000..bd9d4af Binary files /dev/null and b/img/pdequinox_teaser.png differ