Skip to content

Commit 50d49b8

Browse files
authored
Update README to link to zenodo repo with checkpoint (#3)
1 parent 169cce0 commit 50d49b8

File tree

2 files changed

+17
-12
lines changed

2 files changed

+17
-12
lines changed

README.md

+16-11
Original file line numberDiff line numberDiff line change
@@ -6,9 +6,10 @@ This is rapidly changing research software. We make no guarantees of maintaining
66

77
## Quickstart
88

9-
### 1. Clone this repository and install dependencies
9+
### 1. Install
1010

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

1920
### 2. Download data and checkpoint
2021

21-
These are available via a public
22+
The checkpoint and a 1-year subsample of the validation data are available at
23+
[this Zenodo repository](https://zenodo.org/doi/10.5281/zenodo.10791086).
24+
Download these to your local filesystem.
25+
26+
Alternatively, if interested in the complete dataset, this is available via a public
2227
[requester pays](https://cloud.google.com/storage/docs/requester-pays)
23-
Google Cloud Storage bucket. The checkpoint can be downloaded with:
24-
```
25-
gsutil -u YOUR_GCP_PROJECT cp gs://ai2cm-public-requester-pays/2023-11-29-ai2-climate-emulator-v1/checkpoints/ace_ckpt.tar .
26-
```
27-
Download the 10-year validation data (approx. 190GB; can also download a portion only,
28-
but it is required to download enough data to span the desired prediction period):
28+
Google Cloud Storage bucket. For example, the 10-year validation data (approx. 190GB)
29+
can be downloaded with:
2930
```
3031
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 .
3132
```
33+
It is possible to download a portion of the dataset only, but it is necessary to have
34+
enough data to span the desired prediction period. The checkpoint is also available on GCS at
35+
`gs://ai2cm-public-requester-pays/2023-11-29-ai2-climate-emulator-v1/checkpoints/ace_ckpt.tar`.
3236

33-
### 3. Update the paths in the [example config](examples/config-inference.yaml).
34-
Then in the `fme` conda environment, run inference with:
37+
### 3. Update configuration and run
38+
Update the paths in the [example config](examples/config-inference.yaml). Then in the
39+
`fme` conda environment, run inference with:
3540
```
3641
python -m fme.fcn_training.inference.inference examples/config-inference.yaml
3742
```

examples/config-inference.yaml

+1-1
Original file line numberDiff line numberDiff line change
@@ -11,7 +11,7 @@ logging:
1111
entity: your_wandb_entity
1212
validation_data:
1313
batch_size: 1
14-
data_path: /path/to/validation/ic_0011
14+
data_path: /path/to/data/directory # time-ordered netCDFs ending in .nc
1515
data_type: xarray
1616
num_data_workers: 4
1717
n_samples: 1

0 commit comments

Comments
 (0)