Add Google Cloud Storage example

dstansby · dstansby · commit ad3206fedc4c · 2024-03-21T08:46:52.000Z
diff --git a/docs/examples.rst b/docs/examples.rst
@@ -0,0 +1,7 @@
+Examples
+========
+
+.. toctree::
+    :glob:
+
+    examples/*
diff --git a/docs/examples/google_cloud.rst b/docs/examples/google_cloud.rst
@@ -0,0 +1,18 @@
+Opening from Google Cloud Storage
+=================================
+This example shows how to open a read-only bucket in Google Cloud Storage.
+This requires the ``gcsfs`` package in addition to ``zarr``.
+
+
+.. code:: python
+
+    import zarr
+    import gcsfs
+
+    project = "my_project"
+    bucket = "my_bucket"
+    path_to_array = "a/b/c"
+
+    fs = gcsfs.GCSFileSystem(project=bucket, token='anon', access='read_only')
+    store = zarr.FSStore(url=bucket, fs=fs)
+    array = zarr.open_array(store=store, path=path_to_array)
diff --git a/docs/index.rst b/docs/index.rst
@@ -11,8 +11,9 @@ Zarr-Python
     getting_started
     tutorial
     api
-    spec
+    examples
     release
+    spec
     license
     acknowledgments
     contributing
