Update README.md

meggart · Aug 21, 2024 · 8cd0c1a · 8cd0c1a
1 parent fad5b97
commit 8cd0c1a
Showing 1 changed file with 17 additions and 0 deletions.
diff --git a/README.md b/README.md
@@ -1,3 +1,20 @@
 # PyYAXArrays
 
 [![Build Status](https://github.com/meggart/PyYAXArrays.jl/actions/workflows/CI.yml/badge.svg?branch=main)](https://github.com/meggart/PyYAXArrays.jl/actions/workflows/CI.yml?query=branch%3Amain)
+
+
+### Example
+
+````julia
+using PyYAXArrays, YAXArrays
+
+xr = PyYAXArrays.xr[]
+python_dataset = xr.open_zarr("https://mur-sst.s3.us-west-2.amazonaws.com/zarr-v1", decode_times=false)
+
+yax_dataset = YAXArrays.open_dataset(python_dataset)
+
+smallsampledata = yax_dataset.analysed_sst[Ti=Near(DateTime(2010,1,1,0)),lon=0..35,lat=40..65]
+
+#Read some data
+smallsampledata[:,:].data
+````