API(fields): support for generating biased tracer fields

.readthedocs.yml

@@ -1,5 +1,10 @@
 version: 2
 
+build:
+  os: ubuntu-22.04
+  tools:
+    python: "3.11"
+
 python:
   install:
     - method: pip

glass/core/__init__.py

@@ -10,3 +10,9 @@
 GLASS modules.
 
 '''
+
+__all__ = (
+    "update_metadata",
+)
+
+from .array import update_metadata

glass/core/array.py

@@ -70,3 +70,16 @@ def cumtrapz(f, x, dtype=None, out=None):
     np.cumsum((f[..., 1:] + f[..., :-1])/2*np.diff(x), axis=-1, out=out[..., 1:])
     out[..., 0] = 0
     return out
+
+
+def update_metadata(array, **metadata):
+    """update dtype.metadata of an array"""
+    array = np.asanyarray(array)
+    updated = {}
+    if array.dtype.metadata is not None:
+        updated.update(array.dtype.metadata)
+    updated.update(metadata)
+    dtype = np.dtype(array.dtype.fields or array.dtype.str, metadata=updated)
+    if not np.can_cast(dtype, array.dtype, casting="no"):
+        raise ValueError("array does not support updating metadata")
+    array.dtype = dtype