Skip to content

Commit

Permalink
Add simple installation instructions
Browse files Browse the repository at this point in the history
  • Loading branch information
Ceyron committed Jun 7, 2024
1 parent e033f03 commit 6534e3c
Showing 1 changed file with 24 additions and 0 deletions.
24 changes: 24 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,6 +7,30 @@

<h4 align="center">A benchmark for Autoregressive PDE Emulators in <a href="https://github.com/google/jax" target="_blank">JAX</a>.</h4>

## Installation

0. (Optional) Create a fresh conda environment
```bash
conda create -n apebench python=3.12 -y
conda activate apebench
```
1. Install JAX (here the CUDA version, more versions [here](https://jax.readthedocs.io/en/latest/installation.html))
```bash
pip install -U "jax[cuda12]"
```
2. Clone repository
```bash
git clone --recurse-submodule [email protected]:Ceyron/apebench.git
```
3. Change into the repository
```bash
cd apebench
```
4. Install the requirements
```bash
pip install -r requirements.txt
```

### Quickstart

Train a ConvNet to emulate 1D advection, display train loss, test error metric
Expand Down

0 comments on commit 6534e3c

Please sign in to comment.