Skip to content

Commit

Permalink
Update README to link to zenodo repo with checkpoint (ai2cm#3)
Browse files Browse the repository at this point in the history
  • Loading branch information
oliverwm1 authored Mar 8, 2024
1 parent 169cce0 commit 50d49b8
Show file tree
Hide file tree
Showing 2 changed files with 17 additions and 12 deletions.
27 changes: 16 additions & 11 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,9 +6,10 @@ This is rapidly changing research software. We make no guarantees of maintaining

## Quickstart

### 1. Clone this repository and install dependencies
### 1. Install

Assuming [conda](https://docs.conda.io/en/latest/) is available, run
Clone this repository. Then assuming [conda](https://docs.conda.io/en/latest/)
is available, run
```
make create_environment
```
Expand All @@ -18,20 +19,24 @@ You may verify installation by running `pytest fme/`.

### 2. Download data and checkpoint

These are available via a public
The checkpoint and a 1-year subsample of the validation data are available at
[this Zenodo repository](https://zenodo.org/doi/10.5281/zenodo.10791086).
Download these to your local filesystem.

Alternatively, if interested in the complete dataset, this is available via a public
[requester pays](https://cloud.google.com/storage/docs/requester-pays)
Google Cloud Storage bucket. The checkpoint can be downloaded with:
```
gsutil -u YOUR_GCP_PROJECT cp gs://ai2cm-public-requester-pays/2023-11-29-ai2-climate-emulator-v1/checkpoints/ace_ckpt.tar .
```
Download the 10-year validation data (approx. 190GB; can also download a portion only,
but it is required to download enough data to span the desired prediction period):
Google Cloud Storage bucket. For example, the 10-year validation data (approx. 190GB)
can be downloaded with:
```
gsutil -m -u YOUR_GCP_PROJECT cp -r gs://ai2cm-public-requester-pays/2023-11-29-ai2-climate-emulator-v1/data/repeating-climSST-1deg-netCDFs/validation .
```
It is possible to download a portion of the dataset only, but it is necessary to have
enough data to span the desired prediction period. The checkpoint is also available on GCS at
`gs://ai2cm-public-requester-pays/2023-11-29-ai2-climate-emulator-v1/checkpoints/ace_ckpt.tar`.

### 3. Update the paths in the [example config](examples/config-inference.yaml).
Then in the `fme` conda environment, run inference with:
### 3. Update configuration and run
Update the paths in the [example config](examples/config-inference.yaml). Then in the
`fme` conda environment, run inference with:
```
python -m fme.fcn_training.inference.inference examples/config-inference.yaml
```
Expand Down
2 changes: 1 addition & 1 deletion examples/config-inference.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -11,7 +11,7 @@ logging:
entity: your_wandb_entity
validation_data:
batch_size: 1
data_path: /path/to/validation/ic_0011
data_path: /path/to/data/directory # time-ordered netCDFs ending in .nc
data_type: xarray
num_data_workers: 4
n_samples: 1

0 comments on commit 50d49b8

Please sign in to comment.