Skip to content

Update sample-datasets page #887

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
dcherian merged 2 commits into from
Apr 3, 2025
Merged

Update sample-datasets page #887

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
161363e
Update sample-datasets page
dcherian Apr 2, 2025
6dc5956
Merge branch 'main' into update-sample-datasets
dcherian Apr 3, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
123 changes: 60 additions & 63 deletions docs/docs/sample-datasets.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -3,69 +3,66 @@ title: Sample Datasets
---
# Sample Datasets

!!! warning
This page is under construction. The listed datasets are outdated and will not work until the icechunk format is more stable.

## Native Datasets

### Weatherbench2 ERA5

=== "AWS"

```python
import icechunk as ic
import xarray as xr
```python
import icechunk as ic
import xarray as xr

storage = ic.s3_storage(
bucket="icechunk-public-data",
prefix="v1/era5_weatherbench2",
region="us-east-1",
anonymous=True,
)
storage = ic.s3_storage(
bucket="icechunk-public-data",
prefix="v1/era5_weatherbench2",
region="us-east-1",
anonymous=True,
)

repo = ic.Repository.open(storage=storage)
session = repo.readonly_session("main")
ds = xr.open_dataset(
session.store, group="1x721x1440", engine="zarr", chunks=None, consolidated=False
)
```
repo = ic.Repository.open(storage=storage)
session = repo.readonly_session("main")
ds = xr.open_dataset(
session.store, group="1x721x1440", engine="zarr", chunks=None, consolidated=False
)
```

=== "Google Cloud"

```python
import icechunk as ic
import xarray as xr
```python
import icechunk as ic
import xarray as xr

storage = ic.gcs_storage(
bucket="icechunk-public-data-gcs",
prefix="v01/era5_weatherbench2",
)
storage = ic.gcs_storage(
bucket="icechunk-public-data-gcs",
prefix="v01/era5_weatherbench2",
)

repo = ic.Repository.open(storage=storage)
session = repo.readonly_session("main")
ds = xr.open_dataset(
session.store, group="1x721x1440", engine="zarr", chunks=None, consolidated=False
)
```
repo = ic.Repository.open(storage=storage)
session = repo.readonly_session("main")
ds = xr.open_dataset(
session.store, group="1x721x1440", engine="zarr", chunks=None, consolidated=False
)
```

=== "Cloudflare R2"

```python
import icechunk as ic
import xarray as xr
```python
import icechunk as ic
import xarray as xr

storage = ic.r2_storage(
prefix="v1/era5_weatherbench2",
endpoint_url="https://data.icechunk.cloud",
anonymous=True,
)
storage = ic.r2_storage(
prefix="v1/era5_weatherbench2",
endpoint_url="https://data.icechunk.cloud",
anonymous=True,
)

repo = ic.Repository.open(storage=storage)
session = repo.readonly_session("main")
ds = xr.open_dataset(
session.store, group="1x721x1440", engine="zarr", chunks=None, consolidated=False
)
```
repo = ic.Repository.open(storage=storage)
session = repo.readonly_session("main")
ds = xr.open_dataset(
session.store, group="1x721x1440", engine="zarr", chunks=None, consolidated=False
)
```


<!-- === "Tigris" -->
Expand All @@ -87,29 +84,29 @@ ds = xr.open_dataset(
<!-- ) -->
<!-- ``` -->

## Virtual Datasets
<!-- ## Virtual Datasets -->

### NOAA [OISST](https://www.ncei.noaa.gov/products/optimum-interpolation-sst) Data
<!-- ### NOAA [OISST](https://www.ncei.noaa.gov/products/optimum-interpolation-sst) Data -->

> The NOAA 1/4° Daily Optimum Interpolation Sea Surface Temperature (OISST) is a long term Climate Data Record that incorporates observations from different platforms (satellites, ships, buoys and Argo floats) into a regular global grid
<!-- > The NOAA 1/4° Daily Optimum Interpolation Sea Surface Temperature (OISST) is a long term Climate Data Record that incorporates observations from different platforms (satellites, ships, buoys and Argo floats) into a regular global grid -->

Check out an example dataset built using all virtual references pointing to daily Sea Surface Temperature data from 2020 to 2024 on NOAA's S3 bucket using python:
<!-- Check out an example dataset built using all virtual references pointing to daily Sea Surface Temperature data from 2020 to 2024 on NOAA's S3 bucket using python: -->

```python
import icechunk as ic
<!-- ```python -->
<!-- import icechunk as ic -->

storage = ic.s3_storage(
bucket='earthmover-sample-data',
prefix='icechunk/oisst.2020-2024/',
region='us-east-1',
anonymous=True,
)
<!-- storage = ic.s3_storage( -->
<!-- bucket='earthmover-sample-data', -->
<!-- prefix='icechunk/oisst.2020-2024/', -->
<!-- region='us-east-1', -->
<!-- anonymous=True, -->
<!-- ) -->

virtual_credentials = ic.containers_credentials({"s3": ic.s3_credentials(anonymous=True)})
<!-- virtual_credentials = ic.containers_credentials({"s3": ic.s3_credentials(anonymous=True)}) -->

repo = ic.Repository.open(
storage=storage,
virtual_chunk_credentials=virtual_credentials)
```
<!-- repo = ic.Repository.open( -->
<!-- storage=storage, -->
<!-- virtual_chunk_credentials=virtual_credentials) -->
<!-- ``` -->

![oisst](./assets/datasets/oisst.png)
<!-- ![oisst](./assets/datasets/oisst.png) -->