fmu-sumo 2.4.1__tar.gz → 2.4.2__tar.gz

{fmu_sumo-2.4.1 → fmu_sumo-2.4.2}/PKG-INFO

@@ -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 → fmu_sumo-2.4.2}/examples/metrics.ipynb

@@ -17,7 +17,7 @@
    "metadata": {},
    "outputs": [],
    "source": [
-    "exp = Explorer(env=\"preview\")"
+    "exp = Explorer(env=\"dev\")"
    ]
   },
   {
@@ -27,7 +27,7 @@
    "metadata": {},
    "outputs": [],
    "source": [
-    "case = exp.get_case_by_uuid(\"359e7c72-a4ca-43ee-9203-f09cd0f149a9\")"
+    "case = exp.get_case_by_uuid(\"8ffeb5f8-ca60-42ee-998e-53d34e47d3e2\")"
    ]
   },
   {
@@ -135,7 +135,7 @@
    "metadata": {},
    "outputs": [],
    "source": [
-    "summaries.metrics.sum(field=\"_sumo.blob_size\")[\"value\"] / (1024 * 1024 * 1024)"
+    "summaries.metrics.sum(field=\"_sumo.blob_size\") / (1024 * 1024 * 1024)"
    ]
   },
   {
@@ -144,6 +144,90 @@
    "id": "cb3be689-6db2-483e-8195-2fcc3e1cdc69",
    "metadata": {},
    "outputs": [],
+   "source": [
+    "await summaries.metrics.min_async(field=\"_sumo.blob_size\")"
+   ]
+  },
+  {
+   "cell_type": "code",
+   "execution_count": null,
+   "id": "532cfd01-af75-4267-849f-f6852459af0a",
+   "metadata": {},
+   "outputs": [],
+   "source": [
+    "await summaries.metrics.max_async(field=\"_sumo.blob_size\")"
+   ]
+  },
+  {
+   "cell_type": "code",
+   "execution_count": null,
+   "id": "4f9f19a3-2564-46c4-b483-aae8e190eac6",
+   "metadata": {},
+   "outputs": [],
+   "source": [
+    "await summaries.metrics.avg_async(field=\"_sumo.blob_size\")"
+   ]
+  },
+  {
+   "cell_type": "code",
+   "execution_count": null,
+   "id": "0b344ee2-11e0-4a9d-b670-9e966b81b7a2",
+   "metadata": {},
+   "outputs": [],
+   "source": [
+    "await summaries.metrics.stats_async(field=\"_sumo.blob_size\")"
+   ]
+  },
+  {
+   "cell_type": "code",
+   "execution_count": null,
+   "id": "bba953f2-1bf0-49c9-a5b6-e5e4620b1e4d",
+   "metadata": {},
+   "outputs": [],
+   "source": [
+    "await summaries.metrics.extended_stats_async(field=\"_sumo.blob_size\")"
+   ]
+  },
+  {
+   "cell_type": "code",
+   "execution_count": null,
+   "id": "81aa0f72-647c-4336-8db1-572c44a5e94b",
+   "metadata": {},
+   "outputs": [],
+   "source": [
+    "await summaries.metrics.percentiles_async(field=\"_sumo.blob_size\")"
+   ]
+  },
+  {
+   "cell_type": "code",
+   "execution_count": null,
+   "id": "1f9427df-33e7-460a-a62c-2e7cae150b69",
+   "metadata": {},
+   "outputs": [],
+   "source": [
+    "await summaries.metrics.percentiles_async(\n",
+    "    field=\"_sumo.blob_size\", percents=[95, 99, 99.9]\n",
+    ")"
+   ]
+  },
+  {
+   "cell_type": "code",
+   "execution_count": null,
+   "id": "4488928b-175f-4a03-a4bf-ca1c9dec0401",
+   "metadata": {},
+   "outputs": [],
+   "source": [
+    "(await summaries.metrics.sum_async(field=\"_sumo.blob_size\")) / (\n",
+    "    1024 * 1024 * 1024\n",
+    ")"
+   ]
+  },
+  {
+   "cell_type": "code",
+   "execution_count": null,
+   "id": "924c829f-0193-4f82-9c41-3f48d52af2c6",
+   "metadata": {},
+   "outputs": [],
    "source": []
   }
  ],
@@ -163,7 +247,7 @@
    "name": "python",
    "nbconvert_exporter": "python",
    "pygments_lexer": "ipython3",
-   "version": "3.9.6"
+   "version": "3.11.12"
   }
  },
  "nbformat": 4,

{fmu_sumo-2.4.1 → fmu_sumo-2.4.2}/src/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-2.4.2/src/fmu/sumo/explorer/objects/_metrics.py

@@ -0,0 +1,274 @@
+class Metrics:
+    def __init__(self, search_context):
+        self._search_context = search_context
+        return
+
+    def _aggregate(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 = 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.
+
+        Arguments:
+            - field (str): the name of a property in the metadata.
+
+        Returns:
+            The minimum value.
+
+        """
+        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.
+
+        Arguments:
+            - field (str): the name of a property in the metadata.
+
+        Returns:
+            The maximum value.
+
+        """
+        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.
+
+        Arguments:
+            - field (str): the name of a property in the metadata.
+
+        Returns:
+            The average value.
+
+        """
+        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.
+
+        Arguments:
+            - field (str): the name of a property in the metadata.
+
+        Returns:
+            The sum of all values.
+
+        """
+        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.
+
+        Arguments:
+            - field (str): the name of a property in the metadata.
+
+        Returns:
+            The total number of values.
+
+        """
+        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.
+
+        Arguments:
+            - field (str): the name of a property in the metadata.
+
+        Returns:
+            The number of distinct values.
+
+        Note: The value returned is approximate.
+
+        """
+        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.
+
+        Arguments:
+            - field (str): the name of a property in the metadata.
+
+        Returns:
+            A dictionary of statistical 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.
+
+        Arguments:
+            - field (str): the name of a property in the metadata.
+
+        Returns:
+            A dictionary of statistical 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.
+
+        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 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-2.4.1 → fmu_sumo-2.4.2}/src/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 → fmu_sumo-2.4.2}/src/fmu_sumo.egg-info/PKG-INFO

@@ -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/src/fmu/sumo/explorer/objects/_metrics.py

@@ -1,135 +0,0 @@
-class Metrics:
-    def __init__(self, search_context):
-        self._search_context = search_context
-        return
-
-    def _aggregate(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 = self._search_context._sumo.post("/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.
-
-        Arguments:
-            - field (str): the name of a property in the metadata.
-
-        Returns:
-            The minimum value.
-
-        """
-        return self._aggregate("min", field=field)["value"]
-
-    def max(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 self._aggregate("max", field=field)["value"]
-
-    def avg(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 self._aggregate("avg", field=field)["value"]
-
-    def sum(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 self._aggregate("sum", field=field)["value"]
-
-    def value_count(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 self._aggregate("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.
-
-        Arguments:
-            - field (str): the name of a property in the metadata.
-
-        Returns:
-            The number of distinct values.
-
-        Note: The value returned is approximate.
-
-        """
-        return self._aggregate("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.
-
-        Arguments:
-            - field (str): the name of a property in the metadata.
-
-        Returns:
-            A dictionary of statistical metrics.
-
-        """
-        return self._aggregate("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.
-
-        Arguments:
-            - field (str): the name of a property in the metadata.
-
-        Returns:
-            A dictionary of statistical metrics.
-
-        """
-        return self._aggregate("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.
-
-        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 self._aggregate("percentiles", field=field, percents=percents)[
-            "values"
-        ]