xarray-selafin 0.2.5__tar.gz → 0.2.6__tar.gz

{xarray_selafin-0.2.5 → xarray_selafin-0.2.6}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.3
 Name: xarray-selafin
-Version: 0.2.5
+Version: 0.2.6
 Summary: 
 Author: tomsail
 Author-email: saillour.thomas@gmail.com
@@ -18,6 +18,8 @@ Description-Content-Type: text/markdown
 [![Available on pypi](https://img.shields.io/pypi/v/xarray-selafin.svg)](https://pypi.python.org/pypi/xarray-selafin/)
 [![CI](https://github.com/oceanmodeling/xarray-selafin/actions/workflows/run_tests.yml/badge.svg)](https://github.com/oceanmodeling/xarray-selafin/actions/workflows/run_tests.yml)
 
+[![Open In Colab](https://colab.research.google.com/assets/colab-badge.svg)](https://colab.research.google.com/github/oceanmodeling/xarray-selafin/blob/main/workshop/01_getting_started.ipynb)
+
 # xarray backend for Selafin formats
 
 Supports lazy loading by default.
@@ -139,3 +141,9 @@ All attributes are optional except `ikle2`:
 | variables  | Dictionary with variable names and units (key is variable abbreviation) | -                              |
 | date_start | Starting date with integers (year to seconds)                           | (from first time serie)        |
 
+## Cite this project
+
+```
+Saillour, Thomas; Salamon, Peter; Voukouvalas, Evangelos; Bourban, Sébastien E.; Cuomo, Giovanni (2024): Support for global models and integration of TELEMAC in a Python-based ecosystem. In: Proceedings of the XXXth TELEMAC User Conference, Chambéry, 8–9 October 2024.
+```
+

{xarray_selafin-0.2.5 → xarray_selafin-0.2.6}/README.md

@@ -1,6 +1,8 @@
 [![Available on pypi](https://img.shields.io/pypi/v/xarray-selafin.svg)](https://pypi.python.org/pypi/xarray-selafin/)
 [![CI](https://github.com/oceanmodeling/xarray-selafin/actions/workflows/run_tests.yml/badge.svg)](https://github.com/oceanmodeling/xarray-selafin/actions/workflows/run_tests.yml)
 
+[![Open In Colab](https://colab.research.google.com/assets/colab-badge.svg)](https://colab.research.google.com/github/oceanmodeling/xarray-selafin/blob/main/workshop/01_getting_started.ipynb)
+
 # xarray backend for Selafin formats
 
 Supports lazy loading by default.
@@ -121,3 +123,9 @@ All attributes are optional except `ikle2`:
 | ikle3      | Connectivity table in 3D (1-indexed, only in 3D, optional)              | (can be rebuilt from 2D)       |
 | variables  | Dictionary with variable names and units (key is variable abbreviation) | -                              |
 | date_start | Starting date with integers (year to seconds)                           | (from first time serie)        |
+
+## Cite this project
+
+```
+Saillour, Thomas; Salamon, Peter; Voukouvalas, Evangelos; Bourban, Sébastien E.; Cuomo, Giovanni (2024): Support for global models and integration of TELEMAC in a Python-based ecosystem. In: Proceedings of the XXXth TELEMAC User Conference, Chambéry, 8–9 October 2024.
+```

{xarray_selafin-0.2.5 → xarray_selafin-0.2.6}/pyproject.toml

@@ -1,6 +1,6 @@
 [tool.poetry]
 name = "xarray-selafin"
-version = "0.2.5"
+version = "0.2.6"
 description = ""
 authors = ["tomsail <saillour.thomas@gmail.com>", "lucduron <l.duron@cnr.tm.fr>"]
 readme = "README.md"

{xarray_selafin-0.2.5 → xarray_selafin-0.2.6}/xarray_selafin/xarray_backend.py

@@ -262,7 +262,9 @@ class SelafinAccessor:
         # Check input DataSet
         if "plan" not in self._ds.dims:
             raise RuntimeError("get_dataset_as_2d requires a 3D DataSet")
-        assert 0 <= plan <= self._ds.sizes.get("plan") - 1
+        nb_planes = self._ds.sizes["plan"]
+        if not -nb_planes <= plan < nb_planes:
+            raise IndexError(f"plan {plan} is out of range [-{nb_planes}, {nb_planes - 1}]")
 
         # Generate a shallow copy
         ds_out = self._ds.copy(deep=False).isel(plan=plan)