add example

Author: malmans2

.pre-commit-config.yaml

@@ -9,7 +9,7 @@ repos:
       - id: check-json
         exclude: ^.devcontainer/devcontainer.json
       - id: pretty-format-json
-        exclude: ^.devcontainer/devcontainer.json
+        exclude: (^.devcontainer/devcontainer.json|\.ipynb$)
         args: [--autofix, --no-sort-keys]
       - id: end-of-file-fixer
       - id: trailing-whitespace
@@ -20,3 +20,8 @@ repos:
       - id: ruff-check
         args: [ --exit-non-zero-on-fix ]
       - id: ruff-format
+
+  - repo: https://github.com/kynan/nbstripout
+    rev: 0.8.1
+    hooks:
+      - id: nbstripout

README.md

@@ -1,69 +1,26 @@
 # xarray-esgf
 
-[![Release](https://img.shields.io/github/v/release/bopen/xarray-esgf)](https://img.shields.io/github/v/release/bopen/xarray-esgf)
-[![Build status](https://img.shields.io/github/actions/workflow/status/bopen/xarray-esgf/main.yml?branch=main)](https://github.com/bopen/xarray-esgf/actions/workflows/main.yml?query=branch%3Amain)
-[![codecov](https://codecov.io/gh/bopen/xarray-esgf/branch/main/graph/badge.svg)](https://codecov.io/gh/bopen/xarray-esgf)
-[![Commit activity](https://img.shields.io/github/commit-activity/m/bopen/xarray-esgf)](https://img.shields.io/github/commit-activity/m/bopen/xarray-esgf)
-[![License](https://img.shields.io/github/license/bopen/xarray-esgf)](https://img.shields.io/github/license/bopen/xarray-esgf)
-
 Xarray backend for ESGF data
 
-- **Github repository**: <https://github.com/bopen/xarray-esgf/>
-- **Documentation** <https://bopen.github.io/xarray-esgf/>
-
-## Getting started with your project
-
-### 1. Create a New Repository
-
-First, create a repository on GitHub with the same name as this project, and then run the following commands:
-
-```bash
-git init -b main
-git add .
-git commit -m "init commit"
-git remote add origin git@github.com:bopen/xarray-esgf.git
-git push -u origin main
+## Quick start
+
+```python
+import xarray as xr
+
+ESGPULL_PATH =  # Set path to download data
+
+ds = xr.open_dataset(
+    {
+        "project": "CMIP6",
+        "experiment_id": "ssp*",
+        "source_id": "EC-Earth3-CC",
+        "frequency": "mon",
+        "variable_id": ["tas", "pr"],
+        "variant_label": "r1i1p1f1",
+    },
+    concat_dims="experiment_id",
+    esgpull_path=ESGPULL_PATH,
+    index_node="esgf.ceda.ac.uk",
+    engine="esgf",
+)
 ```
-
-### 2. Set Up Your Development Environment
-
-Then, install the environment and the pre-commit hooks with
-
-```bash
-make install
-```
-
-This will also generate your `uv.lock` file
-
-### 3. Run the pre-commit hooks
-
-Initially, the CI/CD pipeline might be failing due to formatting issues. To resolve those run:
-
-```bash
-uv run pre-commit run -a
-```
-
-### 4. Commit the changes
-
-Lastly, commit the changes made by the two steps above to your repository.
-
-```bash
-git add .
-git commit -m 'Fix formatting issues'
-git push origin main
-```
-
-You are now ready to start development on your project!
-The CI/CD pipeline will be triggered when you open a pull request, merge to main, or when you create a new release.
-
-To finalize the set-up for publishing to PyPI, see [here](https://fpgmaas.github.io/cookiecutter-uv/features/publishing/#set-up-for-pypi).
-For activating the automatic documentation with MkDocs, see [here](https://fpgmaas.github.io/cookiecutter-uv/features/mkdocs/#enabling-the-documentation-on-github).
-To enable the code coverage reports, see [here](https://fpgmaas.github.io/cookiecutter-uv/features/codecov/).
-
-## Releasing a new version
-
-
-
----
-
-Repository initiated with [fpgmaas/cookiecutter-uv](https://github.com/fpgmaas/cookiecutter-uv).

notebooks/quick_start.ipynb

@@ -0,0 +1,55 @@
+{
+ "cells": [
+  {
+   "cell_type": "code",
+   "execution_count": null,
+   "id": "0",
+   "metadata": {},
+   "outputs": [],
+   "source": [
+    "import xarray as xr\n",
+    "\n",
+    "ESGPULL_PATH = None  # Set path to download data\n",
+    "if ESGPULL_PATH is None:\n",
+    "    msg = \"Please set path to download data, otherwise it will use ~/.esgpull\"\n",
+    "    raise ValueError(msg)\n",
+    "\n",
+    "ds = xr.open_dataset(\n",
+    "    {\n",
+    "        \"project\": \"CMIP6\",\n",
+    "        \"experiment_id\": \"ssp*\",\n",
+    "        \"source_id\": \"EC-Earth3-CC\",\n",
+    "        \"frequency\": \"mon\",\n",
+    "        \"variable_id\": [\"tas\", \"pr\"],\n",
+    "        \"variant_label\": \"r1i1p1f1\",\n",
+    "    },\n",
+    "    concat_dims=\"experiment_id\",\n",
+    "    esgpull_path=ESGPULL_PATH,\n",
+    "    index_node=\"esgf.ceda.ac.uk\",\n",
+    "    engine=\"esgf\",\n",
+    ")"
+   ]
+  }
+ ],
+ "metadata": {
+  "kernelspec": {
+   "display_name": "Python 3 (ipykernel)",
+   "language": "python",
+   "name": "python3"
+  },
+  "language_info": {
+   "codemirror_mode": {
+    "name": "ipython",
+    "version": 3
+   },
+   "file_extension": ".py",
+   "mimetype": "text/x-python",
+   "name": "python",
+   "nbconvert_exporter": "python",
+   "pygments_lexer": "ipython3",
+   "version": "3.12.11"
+  }
+ },
+ "nbformat": 4,
+ "nbformat_minor": 5
+}

xarray_esgf/client.py

@@ -81,7 +81,8 @@ def download(self) -> None:
             if isinstance(err, Exception):
                 exceptions.append(err)
         if exceptions:
-            raise ExceptionGroup("Errors", exceptions)
+            msg = "Download errors"
+            raise ExceptionGroup(msg, exceptions)
 
     @use_new_combine_kwarg_defaults
     def open_dataset(