fmu-sumo 2.4.1__py3-none-any.whl → 2.4.2__py3-none-any.whl

fmu/sumo/explorer/_version.py

@@ -17,5 +17,5 @@ __version__: str
 __version_tuple__: VERSION_TUPLE
 version_tuple: VERSION_TUPLE
 
-__version__ = version = '2.4.1'
-__version_tuple__ = version_tuple = (2, 4, 1)
+__version__ = version = '2.4.2'
+__version_tuple__ = version_tuple = (2, 4, 2)

fmu/sumo/explorer/objects/_metrics.py

@@ -11,6 +11,16 @@ class Metrics:
         res = self._search_context._sumo.post("/search", json=qdoc).json()
         return res["aggregations"]["agg"]
 
+    async def _aggregate_async(self, op, **kwargs):
+        aggs = {
+            "agg": {op: {k: v for k, v in kwargs.items() if v is not None}}
+        }
+        qdoc = {"query": self._search_context._query, "aggs": aggs, "size": 0}
+        res = (
+            await self._search_context._sumo.post_async("/search", json=qdoc)
+        ).json()
+        return res["aggregations"]["agg"]
+
     def min(self, field):
         """Find the minimum value for the specified property across the
         current set of objects.
@@ -24,6 +34,19 @@ class Metrics:
         """
         return self._aggregate("min", field=field)["value"]
 
+    async def min_async(self, field):
+        """Find the minimum value for the specified property across the
+        current set of objects.
+
+        Arguments:
+            - field (str): the name of a property in the metadata.
+
+        Returns:
+            The minimum value.
+
+        """
+        return (await self._aggregate_async("min", field=field))["value"]
+
     def max(self, field):
         """Find the maximum value for the specified property across the
         current set of objects.
@@ -37,6 +60,19 @@ class Metrics:
         """
         return self._aggregate("max", field=field)["value"]
 
+    async def max_async(self, field):
+        """Find the maximum value for the specified property across the
+        current set of objects.
+
+        Arguments:
+            - field (str): the name of a property in the metadata.
+
+        Returns:
+            The maximum value.
+
+        """
+        return (await self._aggregate_async("max", field=field))["value"]
+
     def avg(self, field):
         """Find the average value for the specified property across the
         current set of objects.
@@ -50,6 +86,19 @@ class Metrics:
         """
         return self._aggregate("avg", field=field)["value"]
 
+    async def avg_async(self, field):
+        """Find the average value for the specified property across the
+        current set of objects.
+
+        Arguments:
+            - field (str): the name of a property in the metadata.
+
+        Returns:
+            The average value.
+
+        """
+        return (await self._aggregate_async("avg", field=field))["value"]
+
     def sum(self, field):
         """Find the sumo of all values for the specified property across
         the current set of objects.
@@ -63,6 +112,19 @@ class Metrics:
         """
         return self._aggregate("sum", field=field)["value"]
 
+    async def sum_async(self, field):
+        """Find the sumo of all values for the specified property across
+        the current set of objects.
+
+        Arguments:
+            - field (str): the name of a property in the metadata.
+
+        Returns:
+            The sum of all values.
+
+        """
+        return (await self._aggregate_async("sum", field=field))["value"]
+
     def value_count(self, field):
         """Find the count of values for the specified property across the
         current set of objects.
@@ -76,6 +138,21 @@ class Metrics:
         """
         return self._aggregate("value_count", field=field)["value"]
 
+    async def value_count_async(self, field):
+        """Find the count of values for the specified property across the
+        current set of objects.
+
+        Arguments:
+            - field (str): the name of a property in the metadata.
+
+        Returns:
+            The total number of values.
+
+        """
+        return (await self._aggregate_async("value_count", field=field))[
+            "value"
+        ]
+
     def cardinality(self, field):
         """Find the count of distinct values for the specified property
         across the current set of objects.
@@ -91,6 +168,23 @@ class Metrics:
         """
         return self._aggregate("cardinality", field=field)["value"]
 
+    async def cardinality_async(self, field):
+        """Find the count of distinct values for the specified property
+        across the current set of objects.
+
+        Arguments:
+            - field (str): the name of a property in the metadata.
+
+        Returns:
+            The number of distinct values.
+
+        Note: The value returned is approximate.
+
+        """
+        return (await self._aggregate_async("cardinality", field=field))[
+            "value"
+        ]
+
     def stats(self, field):
         """Compute a basic set of statistics of the values for the specified
         property across the current set of objects.
@@ -104,6 +198,19 @@ class Metrics:
         """
         return self._aggregate("stats", field=field)
 
+    async def stats_async(self, field):
+        """Compute a basic set of statistics of the values for the specified
+        property across the current set of objects.
+
+        Arguments:
+            - field (str): the name of a property in the metadata.
+
+        Returns:
+            A dictionary of statistical metrics.
+
+        """
+        return await self._aggregate_async("stats", field=field)
+
     def extended_stats(self, field):
         """Compute an extended set of statistics of the values for the
         specified property across the current set of objects.
@@ -117,6 +224,19 @@ class Metrics:
         """
         return self._aggregate("extended_stats", field=field)
 
+    async def extended_stats_async(self, field):
+        """Compute an extended set of statistics of the values for the
+        specified property across the current set of objects.
+
+        Arguments:
+            - field (str): the name of a property in the metadata.
+
+        Returns:
+            A dictionary of statistical metrics.
+
+        """
+        return await self._aggregate_async("extended_stats", field=field)
+
     def percentiles(self, field, percents=None):
         """Find the values at specific percentiles for the specified
         property across the current set of objects.
@@ -133,3 +253,22 @@ class Metrics:
         return self._aggregate("percentiles", field=field, percents=percents)[
             "values"
         ]
+
+    async def percentiles_async(self, field, percents=None):
+        """Find the values at specific percentiles for the specified
+        property across the current set of objects.
+
+        Arguments:
+            - field (str): the name of a property in the metadata.
+            - percents ([number]): list of percent values. If omitted, uses
+              a default set of values.
+
+        Returns:
+            A dictionary of percentiles.
+
+        """
+        return (
+            await self._aggregate_async(
+                "percentiles", field=field, percents=percents
+            )
+        )["values"]

fmu/sumo/explorer/objects/_search_context.py

@@ -64,6 +64,28 @@ def _gen_filter_gen(attr):
     return _fn
 
 
+def _gen_filter_stage(attr):
+    """Match property against either single value or list of values.
+    If the value given is a boolean, tests for existence or not of the property.
+    In addition, if the value is or includes either "iteration" or "ensemble",
+    expand to include both values.
+    """
+
+    _inner = _gen_filter_gen(attr)
+
+    def _fn(value):
+        if value == "iteration" or value == "ensemble":
+            return _inner(["iteration", "ensemble"])
+        elif isinstance(value, list) and set(value).intersection(
+            {"iteration", "ensemble"}
+        ):
+            return _inner(list(set(value).union({"iteration", "ensemble"})))
+        else:
+            return _inner(value)
+
+    return _fn
+
+
 def _gen_filter_name():
     """Match against \"data.name\", or \"case.name\" for case objects."""
 
@@ -144,7 +166,7 @@ _filterspec = {
     "ensemble": [_gen_filter_gen, "fmu.ensemble.name.keyword"],
     "realization": [_gen_filter_gen, "fmu.realization.id"],
     "aggregation": [_gen_filter_gen, "fmu.aggregation.operation.keyword"],
-    "stage": [_gen_filter_gen, "fmu.context.stage.keyword"],
+    "stage": [_gen_filter_stage, "fmu.context.stage.keyword"],
     "column": [_gen_filter_gen, "data.spec.columns.keyword"],
     "vertical_domain": [_gen_filter_gen, "data.vertical_domain.keyword"],
     "content": [_gen_filter_gen, "data.content.keyword"],
@@ -156,6 +178,7 @@ _filterspec = {
     "is_observation": [_gen_filter_bool, "data.is_observation"],
     "is_prediction": [_gen_filter_bool, "data.is_prediction"],
     "standard_result": [_gen_filter_gen, "data.standard_result.name.keyword"],
+    "entity": [_gen_filter_gen, "fmu.entity.uuid.keyword"],
     "complex": [_gen_filter_complex, None],
     "has": [_gen_filter_none, None],
 }
@@ -1931,6 +1954,16 @@ class SearchContext:
             "data.standard_result.name.keyword"
         )
 
+    @property
+    def entities(self) -> List[str]:
+        """List of entity uuids."""
+        return self.get_field_values("fmu.entity.uuid.keyword")
+
+    @property
+    async def entities_async(self) -> List[str]:
+        """List of entity uuids."""
+        return await self.get_field_values_async("fmu.entity.uuid.keyword")
+
 
 def _gen_filter_doc(spec):
     fmap = {

{fmu_sumo-2.4.1.dist-info → fmu_sumo-2.4.2.dist-info}/METADATA

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: fmu-sumo
-Version: 2.4.1
+Version: 2.4.2
 Summary: Python package for interacting with Sumo in an FMU setting
 Author: Equinor
 License:                                  Apache License

{fmu_sumo-2.4.1.dist-info → fmu_sumo-2.4.2.dist-info}/RECORD

@@ -1,7 +1,7 @@
 fmu/__init__.py,sha256=ftS-xRPSH-vU7fIHlnZQaCTWbNvs4owJivNW65kzsIM,85
 fmu/sumo/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
 fmu/sumo/explorer/__init__.py,sha256=Bc1wd1lQO3HP3tsVyPbqaesf2boZwGdtookWp8lmG-k,317
-fmu/sumo/explorer/_version.py,sha256=H3hbvip-BJTNbNG0ITRXctaII3Vc2949yckZEGuAGg8,511
+fmu/sumo/explorer/_version.py,sha256=RUYmq8GFeP2I_XyABp0HnMjSBqGntVVhgCtP72xF2Nk,511
 fmu/sumo/explorer/cache.py,sha256=uvz8TciwBnDEwJIHa9wneC0WVWuzhUqyF3dzk4kvGNk,1037
 fmu/sumo/explorer/explorer.py,sha256=_3nUTO1E_nf6jqpivjgjKcX6rX1fx_mIG76YOM8xb-8,2931
 fmu/sumo/explorer/filters.py,sha256=_t2PmHeTY9XiBvQeEGM-BpudWUaxIfyUSdNyG70xfRU,875
@@ -9,8 +9,8 @@ fmu/sumo/explorer/timefilter.py,sha256=AQHa18vkCz2BzH7X9GR1ypmNxfvI4gExh_jxAVYrD
 fmu/sumo/explorer/objects/__init__.py,sha256=72G0yfWWMTXA-oZw5GMRkrWvQqAYfadjerEwsyndCzc,637
 fmu/sumo/explorer/objects/_child.py,sha256=Cq2jmjRjJDjh0hwy_lKWhPdvkuoMqx6UoHFIcmAJ7OA,5905
 fmu/sumo/explorer/objects/_document.py,sha256=uPAkNzcOk8U4LCtXthWkm7kfU9W4HYHrrqV9HERDhe8,1835
-fmu/sumo/explorer/objects/_metrics.py,sha256=q6CSeCjiN1SjNx4G32Lod7Slnflsu3aoJIpwm_VMIhQ,3954
-fmu/sumo/explorer/objects/_search_context.py,sha256=V5O3q3sM9QnFjRuwzWaJrvdGtDwUh3xGYlswYKzc6A4,62726
+fmu/sumo/explorer/objects/_metrics.py,sha256=WITAFAV-3VRd-AqTg0tUwWpOChW4YFfF8ffT2fvOrAo,8144
+fmu/sumo/explorer/objects/_search_context.py,sha256=a8RTE9mlNvHVdXbMMCsv6RF9PzYn4d4JnJZQONkuFKE,63840
 fmu/sumo/explorer/objects/case.py,sha256=fKp7X43ETLE1RaH3rMYxZiIuduRmf0JSnJ5gRoUgNPE,3813
 fmu/sumo/explorer/objects/cases.py,sha256=i2bnvk7NWIkzbdWMs3BXU7TCqD5tH2r7pg1m1QXUj3o,561
 fmu/sumo/explorer/objects/cpgrid.py,sha256=nuRgZ6FVEOPZT1ibd-rJhlbYYZ6BuUxXZPzovcH0kVc,2548
@@ -26,8 +26,8 @@ fmu/sumo/explorer/objects/realization.py,sha256=Th3zr_nT2I1HYHkBojOAKnf_RSIPc-Ti
 fmu/sumo/explorer/objects/realizations.py,sha256=4agtQFJ5pxLyWMeIzdJbkBMc8__Md-tZOj8Un4ol22c,1562
 fmu/sumo/explorer/objects/surface.py,sha256=zHBtjLCIfkRHBv39OeJjA9lq3puLTfTII6TndZTtxVI,1627
 fmu/sumo/explorer/objects/table.py,sha256=vLor3YTddHkDWZSMyWPQsddFNQ2_VXE_O-stmPIWIaQ,4900
-fmu_sumo-2.4.1.dist-info/licenses/LICENSE,sha256=xx0jnfkXJvxRnG63LTGOxlggYnIysveWIZ6H3PNdCrQ,11357
-fmu_sumo-2.4.1.dist-info/METADATA,sha256=M8zKipDl1zfpmcJYulUNpQAGssQzKxtsURnpwxYFFkg,14780
-fmu_sumo-2.4.1.dist-info/WHEEL,sha256=zaaOINJESkSfm_4HQVc5ssNzHCPXhJm0kEUakpsEHaU,91
-fmu_sumo-2.4.1.dist-info/top_level.txt,sha256=Z-FIY3pxn0UK2Wxi9IJ7fKoLSraaxuNGi1eokiE0ShM,4
-fmu_sumo-2.4.1.dist-info/RECORD,,
+fmu_sumo-2.4.2.dist-info/licenses/LICENSE,sha256=xx0jnfkXJvxRnG63LTGOxlggYnIysveWIZ6H3PNdCrQ,11357
+fmu_sumo-2.4.2.dist-info/METADATA,sha256=z6Zm-yb_u2nBsS8WxunvbyaNEglVsNhKU155I2VHGIc,14780
+fmu_sumo-2.4.2.dist-info/WHEEL,sha256=_zCd3N1l69ArxyTb8rzEoP9TpbYXkqRFSNOD5OuxnTs,91
+fmu_sumo-2.4.2.dist-info/top_level.txt,sha256=Z-FIY3pxn0UK2Wxi9IJ7fKoLSraaxuNGi1eokiE0ShM,4
+fmu_sumo-2.4.2.dist-info/RECORD,,

{fmu_sumo-2.4.1.dist-info → fmu_sumo-2.4.2.dist-info}/WHEEL

@@ -1,5 +1,5 @@
 Wheel-Version: 1.0
-Generator: setuptools (80.8.0)
+Generator: setuptools (80.9.0)
 Root-Is-Purelib: true
 Tag: py3-none-any