freva-client 2502.0.0__tar.gz → 2505.0.0__tar.gz

{freva_client-2502.0.0 → freva_client-2505.0.0}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: freva-client
-Version: 2502.0.0
+Version: 2505.0.0
 Summary: Search for climate data based on key-value pairs
 Author-email: "DKRZ, Clint" <freva@dkrz.de>
 Requires-Python: >=3.8

{freva_client-2502.0.0 → freva_client-2505.0.0}/src/freva_client/__init__.py

@@ -17,5 +17,5 @@ need to apply data analysis plugins, please visit the
 from .auth import authenticate
 from .query import databrowser
 
-__version__ = "2502.0.0"
+__version__ = "2505.0.0"
 __all__ = ["authenticate", "databrowser", "__version__"]

{freva_client-2502.0.0 → freva_client-2505.0.0}/src/freva_client/cli/cli_parser.py

@@ -69,6 +69,8 @@ class Completer:
             time=None,
             host=None,
             time_select="flexible",
+            bbox=None,
+            bbox_select="flexible",
             multiversion=False,
             extended_search=True,
             fail_on_error=False,

{freva_client-2502.0.0 → freva_client-2505.0.0}/src/freva_client/cli/databrowser_cli.py

@@ -7,7 +7,7 @@ import json
 from enum import Enum
 from pathlib import Path
 from tempfile import NamedTemporaryFile
-from typing import Dict, List, Literal, Optional, Union, cast
+from typing import Dict, List, Literal, Optional, Tuple, Union, cast
 
 import typer
 import xarray as xr
@@ -47,7 +47,7 @@ class Flavours(str, Enum):
     user = "user"
 
 
-class TimeSelect(str, Enum):
+class SelectMethod(str, Enum):
     """Literal implementation for the cli."""
 
     strict = "strict"
@@ -55,18 +55,44 @@ class TimeSelect(str, Enum):
     file = "file"
 
     @staticmethod
-    def get_help() -> str:
-        """Generate the help string."""
+    def get_help(context: str) -> str:
+        """Generate the help string for time or bbox selection methods.
+
+        Parameters
+        ----------
+        context: str, default: "time"
+            Either "time" or "bbox" to generate appropriate help text.
+        """
+        examples = {
+            "time": ("2000 to 2012", "2010 to 2020"),
+            "bbox": ("-10 10 -10 10", "0 5 0 5")
+        }
+        descriptions = {
+            "time": {
+                "unit": "time period",
+                "start_end": "start or end period",
+                "subset": "time period"
+            },
+            "bbox": {
+                "unit": "spatial extent",
+                "start_end": "any part of the extent",
+                "subset": "spatial extent"
+            }
+        }
+
+        context_info = descriptions.get(context, descriptions["time"])
+        example = examples.get(context, examples["time"])
+
         return (
-            "Operator that specifies how the time period is selected. "
+            f"Operator that specifies how the {context_info['unit']} is selected. "
             "Choose from flexible (default), strict or file. "
             "``strict`` returns only those files that have the *entire* "
-            "time period covered. The time search ``2000 to 2012`` will "
-            "not select files containing data from 2010 to 2020 with "
-            "the ``strict`` method. ``flexible`` will select those files "
-            "as  ``flexible`` returns those files that have either start "
-            "or end period covered. ``file`` will only return files where "
-            "the entire time period is contained within *one single* file."
+            f"{context_info['unit']} covered. The {context} search ``{example[0]}`` "
+            f"will not select files containing data from {example[1]} with "
+            "the ``strict`` method. ``flexible`` will select those files as "
+            f"``flexible`` returns those files that have {context_info['start_end']} "
+            f"covered. ``file`` will only return files where the entire "
+            f"{context_info['subset']} is contained within *one single* file."
         )
 
 
@@ -124,11 +150,11 @@ def metadata_search(
             "of climate datasets to query."
         ),
     ),
-    time_select: TimeSelect = typer.Option(
+    time_select: SelectMethod = typer.Option(
         "flexible",
         "-ts",
         "--time-select",
-        help=TimeSelect.get_help(),
+        help=SelectMethod.get_help("time"),
     ),
     time: Optional[str] = typer.Option(
         None,
@@ -144,6 +170,24 @@ def metadata_search(
             " valid."
         ),
     ),
+    bbox: Optional[Tuple[float, float, float, float]] = typer.Option(
+        None,
+        "-b",
+        "--bbox",
+        help=(
+            "Special search facet to refine/subset search results by spatial "
+            "extent. This can be a string representation of a bounding box. "
+            "The bounding box has to follow the format ``min_lon max_lon "
+            "min_lat,max_lat``. Valid strings are ``-10 10 -10 10`` to "
+            "``0 5 0 5``."
+        ),
+    ),
+    bbox_select: SelectMethod = typer.Option(
+        "flexible",
+        "-bs",
+        "--bbox-select",
+        help=SelectMethod.get_help("bbox"),
+    ),
     extended_search: bool = typer.Option(
         False,
         "-e",
@@ -188,9 +232,9 @@ def metadata_search(
     result = databrowser.metadata_search(
         *(facets or []),
         time=time or "",
-        time_select=cast(
-            Literal["file", "flexible", "strict"], time_select.value
-        ),
+        time_select=cast(Literal["file", "flexible", "strict"], time_select.value),
+        bbox=bbox or None,
+        bbox_select=cast(Literal["file", "flexible", "strict"], bbox_select.value),
         flavour=cast(
             Literal["freva", "cmip6", "cmip5", "cordex", "nextgems", "user"],
             flavour.value,
@@ -248,11 +292,11 @@ def data_search(
             "of climate datasets to query."
         ),
     ),
-    time_select: TimeSelect = typer.Option(
+    time_select: SelectMethod = typer.Option(
         "flexible",
         "-ts",
         "--time-select",
-        help=TimeSelect.get_help(),
+        help=SelectMethod.get_help("time"),
     ),
     zarr: bool = typer.Option(False, "--zarr", help="Create zarr stream files."),
     access_token: Optional[str] = typer.Option(
@@ -277,6 +321,24 @@ def data_search(
             " valid."
         ),
     ),
+    bbox: Optional[Tuple[float, float, float, float]] = typer.Option(
+        None,
+        "-b",
+        "--bbox",
+        help=(
+            "Special search facet to refine/subset search results by spatial "
+            "extent. This can be a string representation of a bounding box. "
+            "The bounding box has to follow the format ``min_lon max_lon "
+            "min_lat max_lat``. Valid strings are ``-10 10 -10 10`` to "
+            "``0 5 0 5``."
+        ),
+    ),
+    bbox_select: SelectMethod = typer.Option(
+        "flexible",
+        "-bs",
+        "--bbox-select",
+        help=SelectMethod.get_help("bbox"),
+    ),
     parse_json: bool = typer.Option(
         False, "-j", "--json", help="Parse output in json format."
     ),
@@ -314,6 +376,8 @@ def data_search(
         *(facets or []),
         time=time or "",
         time_select=cast(Literal["file", "flexible", "strict"], time_select),
+        bbox=bbox or None,
+        bbox_select=cast(Literal["file", "flexible", "strict"], bbox_select),
         flavour=cast(
             Literal["freva", "cmip6", "cmip5", "cordex", "nextgems", "user"],
             flavour.value,
@@ -374,11 +438,11 @@ def intake_catalogue(
             "of climate datasets to query."
         ),
     ),
-    time_select: TimeSelect = typer.Option(
+    time_select: SelectMethod = typer.Option(
         "flexible",
         "-ts",
         "--time-select",
-        help=TimeSelect.get_help(),
+        help=SelectMethod.get_help("time"),
     ),
     time: Optional[str] = typer.Option(
         None,
@@ -394,6 +458,24 @@ def intake_catalogue(
             " valid."
         ),
     ),
+    bbox: Optional[Tuple[float, float, float, float]] = typer.Option(
+        None,
+        "-b",
+        "--bbox",
+        help=(
+            "Special search facet to refine/subset search results by spatial "
+            "extent. This can be a string representation of a bounding box. "
+            "The bounding box has to follow the format ``min_lon max_lon "
+            "min_lat max_lat``. Valid strings are ``-10 10 -10 10`` to "
+            "``0 5 0 5``."
+        ),
+    ),
+    bbox_select: SelectMethod = typer.Option(
+        "flexible",
+        "-bs",
+        "--bbox-select",
+        help=SelectMethod.get_help("bbox"),
+    ),
     zarr: bool = typer.Option(
         False, "--zarr", help="Create zarr stream files, as catalogue targets."
     ),
@@ -445,6 +527,8 @@ def intake_catalogue(
         *(facets or []),
         time=time or "",
         time_select=cast(Literal["file", "flexible", "strict"], time_select),
+        bbox=bbox or None,
+        bbox_select=cast(Literal["file", "flexible", "strict"], bbox_select),
         flavour=cast(
             Literal["freva", "cmip6", "cmip5", "cordex", "nextgems", "user"],
             flavour.value,
@@ -464,6 +548,142 @@ def intake_catalogue(
             print(Path(temp_f.name).read_text())
 
 
+@databrowser_app.command(
+    name="stac-catalogue",
+    help="Create a static STAC catalogue from the search."
+)
+@exception_handler
+def stac_catalogue(
+    search_keys: Optional[List[str]] = typer.Argument(
+        default=None,
+        help="Refine your data search with this `key=value` pair search "
+        "parameters. The parameters could be, depending on the DRS standard, "
+        "flavour product, project model etc.",
+    ),
+    facets: Optional[List[str]] = typer.Option(
+        None,
+        "--facet",
+        help=(
+            "If you are not sure about the correct search key's you can use"
+            " the ``--facet`` flag to search of any matching entries. For "
+            "example --facet 'era5' would allow you to search for any entries"
+            " containing era5, regardless of project, product etc."
+        ),
+    ),
+    uniq_key: UniqKeys = typer.Option(
+        "file",
+        "--uniq-key",
+        "-u",
+        help=(
+            "The type of search result, which can be either “file” "
+            "or “uri”. This parameter determines whether the search will be "
+            "based on file paths or Uniform Resource Identifiers"
+        ),
+    ),
+    flavour: Flavours = typer.Option(
+        "freva",
+        "--flavour",
+        "-f",
+        help=(
+            "The Data Reference Syntax (DRS) standard specifying the type "
+            "of climate datasets to query."
+        ),
+    ),
+    time_select: SelectMethod = typer.Option(
+        "flexible",
+        "-ts",
+        "--time-select",
+        help=SelectMethod.get_help("time"),
+    ),
+    time: Optional[str] = typer.Option(
+        None,
+        "-t",
+        "--time",
+        help=(
+            "Special search facet to refine/subset search results by time. "
+            "This can be a string representation of a time range or a single "
+            "time step. The time steps have to follow ISO-8601. Valid strings "
+            "are ``%Y-%m-%dT%H:%M`` to ``%Y-%m-%dT%H:%M`` for time ranges and "
+            "``%Y-%m-%dT%H:%M``. **Note**: You don't have to give the full "
+            "string format to subset time steps ``%Y``, ``%Y-%m`` etc are also"
+            " valid."
+        ),
+    ),
+    bbox: Optional[Tuple[float, float, float, float]] = typer.Option(
+        None,
+        "-b",
+        "--bbox",
+        help=(
+            "Special search facet to refine/subset search results by spatial "
+            "extent. This can be a string representation of a bounding box. "
+            "The bounding box has to follow the format ``min_lon max_lon "
+            "min_lat max_lat``. Valid strings are ``-10 10 -10 10`` to "
+            "``0 5 0 5``."
+        ),
+    ),
+    bbox_select: SelectMethod = typer.Option(
+        "flexible",
+        "-bs",
+        "--bbox-select",
+        help=SelectMethod.get_help("bbox"),
+    ),
+    host: Optional[str] = typer.Option(
+        None,
+        "--host",
+        help=(
+            "Set the hostname of the databrowser, if not set (default) "
+            "the hostname is read from a config file"
+        ),
+    ),
+    verbose: int = typer.Option(0, "-v", help="Increase verbosity", count=True),
+    multiversion: bool = typer.Option(
+        False,
+        "--multi-version",
+        help="Select all versions and not just the latest version (default).",
+    ),
+    version: Optional[bool] = typer.Option(
+        False,
+        "-V",
+        "--version",
+        help="Show version an exit",
+        callback=version_callback,
+    ),
+    filename: Optional[Path] = typer.Option(
+        None,
+        "-o",
+        "--filename",
+        help=(
+            "Path to the file where the static STAC catalogue, "
+            "should be written to. If you don't specify or the path "
+            "does not exist, the file will be created in the current "
+            "working directory. "
+        ),
+    ),
+) -> None:
+    """Create a STAC catalogue for climate datasets based on the specified
+    Data Reference Syntax (DRS) standard (flavour) and the type of search
+    result (uniq_key), which can be either "file" or "uri"."""
+    logger.set_verbosity(verbose)
+    result = databrowser(
+        *(facets or []),
+        time=time or "",
+        time_select=cast(Literal["file", "flexible", "strict"], time_select),
+        bbox=bbox or None,
+        bbox_select=cast(Literal["file", "flexible", "strict"], bbox_select),
+        flavour=cast(
+            Literal["freva", "cmip6", "cmip5", "cordex", "nextgems", "user"],
+            flavour.value,
+        ),
+        uniq_key=cast(Literal["uri", "file"], uniq_key.value),
+        host=host,
+        fail_on_error=False,
+        multiversion=multiversion,
+        stream_zarr=False,
+        **(parse_cli_args(search_keys or [])),
+    )
+    print(result.stac_catalogue(filename=filename))
+
+
 @databrowser_app.command(
     name="data-count", help="Count the databrowser search results"
 )
@@ -500,11 +720,11 @@ def count_values(
             "of climate datasets to query."
         ),
     ),
-    time_select: TimeSelect = typer.Option(
+    time_select: SelectMethod = typer.Option(
         "flexible",
         "-ts",
         "--time-select",
-        help=TimeSelect.get_help(),
+        help=SelectMethod.get_help("time"),
     ),
     time: Optional[str] = typer.Option(
         None,
@@ -520,6 +740,24 @@ def count_values(
             " valid."
         ),
     ),
+    bbox: Optional[Tuple[float, float, float, float]] = typer.Option(
+        None,
+        "-b",
+        "--bbox",
+        help=(
+            "Special search facet to refine/subset search results by spatial "
+            "extent. This can be a string representation of a bounding box. "
+            "The bounding box has to follow the format ``min_lon max_lon "
+            "min_lat max_lat``. Valid strings are ``-10 10 -10 10`` to "
+            "``0 5 0 5``."
+        ),
+    ),
+    bbox_select: SelectMethod = typer.Option(
+        "flexible",
+        "-bs",
+        "--bbox-select",
+        help=SelectMethod.get_help("bbox"),
+    ),
     extended_search: bool = typer.Option(
         False,
         "-e",
@@ -564,12 +802,16 @@ def count_values(
     result: Union[int, Dict[str, Dict[str, int]]] = 0
     search_kws = parse_cli_args(search_keys or [])
     time = cast(str, time or search_kws.pop("time", ""))
+    bbox = cast(Optional[Tuple[float, float, float, float]],
+                bbox or search_kws.pop("bbox", None))
     facets = facets or []
     if detail:
         result = databrowser.count_values(
             *facets,
             time=time or "",
             time_select=cast(Literal["file", "flexible", "strict"], time_select),
+            bbox=bbox or None,
+            bbox_select=cast(Literal["file", "flexible", "strict"], bbox_select),
             flavour=cast(
                 Literal["freva", "cmip6", "cmip5", "cordex", "nextgems", "user"],
                 flavour.value,
@@ -585,9 +827,9 @@ def count_values(
             databrowser(
                 *facets,
                 time=time or "",
-                time_select=cast(
-                    Literal["file", "flexible", "strict"], time_select
-                ),
+                time_select=cast(Literal["file", "flexible", "strict"], time_select),
+                bbox=bbox or None,
+                bbox_select=cast(Literal["file", "flexible", "strict"], bbox_select),
                 flavour=cast(
                     Literal[
                         "freva", "cmip6", "cmip5", "cordex", "nextgems", "user"

{freva_client-2502.0.0 → freva_client-2505.0.0}/src/freva_client/query.py

@@ -63,8 +63,10 @@ class databrowser:
         timestamp. The timestamps has to follow ISO-8601. Valid strings are
         ``%Y-%m-%dT%H:%M to %Y-%m-%dT%H:%M`` for time ranges or
         ``%Y-%m-%dT%H:%M`` for single time stamps.
-        **Note**: You don't have to give the full string format to subset
-        time steps: `%Y`, `%Y-%m` etc are also valid.
+
+        .. note:: You don't have to give the full string format to subset time
+                steps ``%Y``, ``%Y-%m`` etc are also valid.
+
     time_select: str, default: flexible
         Operator that specifies how the time period is selected. Choose from
         flexible (default), strict or file. ``strict`` returns only those files
@@ -74,11 +76,25 @@ class databrowser:
         ``flexible`` returns those files that have either start or end period
         covered. ``file`` will only return files where the entire time
         period is contained within `one single` file.
+    bbox: str, default: ""
+        Special search facet to refine/subset search results by spatial extent.
+        This can be a list representation of a bounding box or a WKT polygon.
+        Valid lists are ``min_lon max_lon min_lat max_lat`` for bounding
+        boxes and Well-Known Text (WKT) format for polygons.
+
+    bbox_select: str, default: flexible
+        Operator that specifies how the spatial extent is selected. Choose from
+        flexible (default), strict or file. ``strict`` returns only those files
+        that fully contain the query extent. The bbox search ``-10 10 -10 10``
+        will not select files covering only ``0 5 0 5`` with the ``strict``
+        method. ``flexible`` will select those files as it returns files that
+        have any overlap with the query extent. ``file`` will only return files
+        where the entire spatial extent is contained by the query geometry.
     uniq_key: str, default: file
         Chose if the solr search query should return paths to files or
         uris, uris will have the file path along with protocol of the storage
-        system. Uris can be useful if the search query result should be
-        used libraries like fsspec.
+        system. URIs are useful when working with libraries like fsspec, which
+        require protocol information.
     host: str, default: None
         Override the host name of the databrowser server. This is usually the
         url where the freva web site can be found. Such as www.freva.dkrz.de.
@@ -214,6 +230,8 @@ class databrowser:
         time: Optional[str] = None,
         host: Optional[str] = None,
         time_select: Literal["flexible", "strict", "file"] = "flexible",
+        bbox: Optional[Tuple[float, float, float, float]] = None,
+        bbox_select: Literal["flexible", "strict", "file"] = "flexible",
         stream_zarr: bool = False,
         multiversion: bool = False,
         fail_on_error: bool = False,
@@ -238,6 +256,10 @@ class databrowser:
         if time:
             self._params["time"] = time
             self._params["time_select"] = time_select
+        if bbox:
+            bbox_str = ",".join(map(str, bbox))
+            self._params["bbox"] = bbox_str
+            self._params["bbox_select"] = bbox_select
         if facets:
             self._add_search_keyword_args_from_facet(facets, facet_search)
 
@@ -399,6 +421,84 @@ class databrowser:
                 intake.open_esm_datastore(temp_f.name),
             )
 
+    def stac_catalogue(
+        self,
+        filename: Optional[Union[str, Path]] = None,
+        **kwargs: Any,
+    ) -> str:
+        """Create a static STAC catalogue from
+        the search.
+
+        Parameters
+        ~~~~~~~~~~
+        filename: str, default: None
+            The filename of the STAC catalogue. If not given
+            or doesn't exist the STAC catalogue will be saved
+            to the current working directory.
+        **kwargs: Any
+            Additional keyword arguments to be passed to the request.
+
+        Returns
+        ~~~~~~~
+        BinaryIO
+        A zip file stream
+
+        Raises
+        ~~~~~~
+        ValueError: If stac-catalogue creation failed.
+
+        Example
+        ~~~~~~~
+        Let's create a static STAC catalogue:
+
+        .. execute_code::
+
+            from tempfile import mktemp
+            temp_path = mktemp(suffix=".zip")
+
+            from freva_client import databrowser
+            db = databrowser(dataset="cmip6-hsm")
+            db.stac_catalogue(filename=temp_path)
+            print(f"STAC catalog saved to: {temp_path}")
+
+        """
+
+        kwargs.update({"stream": True})
+        stac_url = self._cfg.stac_url
+        pprint("[b][green]Downloading the STAC catalog started ...[green][b]")
+        result = self._request("GET", stac_url, **kwargs)
+        if result is None or result.status_code == 404:
+            raise ValueError(  # pragma: no cover
+                "No STAC catalog found. Please check if you have any search results."
+            )
+        default_filename = (
+            result.headers.get("Content-Disposition", "")
+            .split("filename=")[-1]
+            .strip('"')
+        )
+
+        if filename is None:
+            save_path = Path.cwd() / default_filename
+        else:
+            save_path = Path(cast(str, filename))
+        if save_path.is_dir() and save_path.exists():
+            save_path = save_path / default_filename
+
+        save_path.parent.mkdir(parents=True, exist_ok=True)
+
+        total_size = 0
+        with open(save_path, "wb") as f:
+            for chunk in result.iter_content(chunk_size=8192):
+                if chunk:
+                    f.write(chunk)
+                    total_size += len(chunk)
+
+        return (
+            f"STAC catalog saved to: {save_path} "
+            f"(size: {total_size / 1024 / 1024:.2f} MB). "
+            f"Or simply download from: {result.url}"
+        )
+
     @classmethod
     def count_values(
         cls,
@@ -409,6 +509,8 @@ class databrowser:
         time: Optional[str] = None,
         host: Optional[str] = None,
         time_select: Literal["flexible", "strict", "file"] = "flexible",
+        bbox: Optional[Tuple[float, float, float, float]] = None,
+        bbox_select: Literal["flexible", "strict", "file"] = "flexible",
         multiversion: bool = False,
         fail_on_error: bool = False,
         extended_search: bool = False,
@@ -432,8 +534,11 @@ class databrowser:
             This can be a string representation of a time range or a single
             timestamp. The timestamp has to follow ISO-8601. Valid strings are
             ``%Y-%m-%dT%H:%M`` to ``%Y-%m-%dT%H:%M`` for time ranges and
-            ``%Y-%m-%dT%H:%M``. **Note**: You don't have to give the full string
-            format to subset time steps ``%Y``, ``%Y-%m`` etc are also valid.
+            ``%Y-%m-%dT%H:%M``.
+
+            .. note:: You don't have to give the full string format to subset time
+                    steps ``%Y``, ``%Y-%m`` etc are also valid.
+
         time_select: str, default: flexible
             Operator that specifies how the time period is selected. Choose from
             flexible (default), strict or file. ``strict`` returns only those files
@@ -443,6 +548,20 @@ class databrowser:
             ``flexible`` returns those files that have either start or end period
             covered. ``file`` will only return files where the entire time
             period is contained within `one single` file.
+        bbox: str, default: ""
+            Special search facet to refine/subset search results by spatial extent.
+            This can be a list representation of a bounding box or a WKT polygon.
+            Valid lists are ``min_lon max_lon min_lat max_lat`` for bounding
+            boxes and Well-Known Text (WKT) format for polygons.
+
+        bbox_select: str, default: flexible
+            Operator that specifies how the spatial extent is selected. Choose from
+            flexible (default), strict or file. ``strict`` returns only those files
+            that fully contain the query extent. The bbox search ``-10 10 -10 10``
+            will not select files covering only ``0 5 0 5`` with the ``strict``
+            method. ``flexible`` will select those files as it returns files that
+            have any overlap with the query extent. ``file`` will only return files
+            where the entire spatial extent is contained by the query geometry.
         extended_search: bool, default: False
             Retrieve information on additional search keys.
         host: str, default: None
@@ -494,6 +613,8 @@ class databrowser:
             flavour=flavour,
             time=time,
             time_select=time_select,
+            bbox=bbox,
+            bbox_select=bbox_select,
             host=host,
             multiversion=multiversion,
             fail_on_error=fail_on_error,
@@ -545,6 +666,8 @@ class databrowser:
         time: Optional[str] = None,
         host: Optional[str] = None,
         time_select: Literal["flexible", "strict", "file"] = "flexible",
+        bbox: Optional[Tuple[float, float, float, float]] = None,
+        bbox_select: Literal["flexible", "strict", "file"] = "flexible",
         multiversion: bool = False,
         fail_on_error: bool = False,
         extended_search: bool = False,
@@ -571,8 +694,11 @@ class databrowser:
             This can be a string representation of a time range or a single
             timestamp. The timestamp has to follow ISO-8601. Valid strings are
             ``%Y-%m-%dT%H:%M`` to ``%Y-%m-%dT%H:%M`` for time ranges and
-            ``%Y-%m-%dT%H:%M``. **Note**: You don't have to give the full string
-            format to subset time steps ``%Y``, ``%Y-%m`` etc are also valid.
+            ``%Y-%m-%dT%H:%M``.
+
+            .. note:: You don't have to give the full string format to subset time
+                    steps ``%Y``, ``%Y-%m`` etc are also valid.
+
         time_select: str, default: flexible
             Operator that specifies how the time period is selected. Choose from
             flexible (default), strict or file. ``strict`` returns only those files
@@ -582,6 +708,20 @@ class databrowser:
             ``flexible`` returns those files that have either start or end period
             covered. ``file`` will only return files where the entire time
             period is contained within *one single* file.
+        bbox: str, default: ""
+            Special search facet to refine/subset search results by spatial extent.
+            This can be a list representation of a bounding box or a WKT polygon.
+            Valid lists are ``min_lon max_lon min_lat max_lat`` for bounding
+            boxes and Well-Known Text (WKT) format for polygons.
+
+        bbox_select: str, default: flexible
+            Operator that specifies how the spatial extent is selected. Choose from
+            flexible (default), strict or file. ``strict`` returns only those files
+            that fully contain the query extent. The bbox search ``-10 10 -10 10``
+            will not select files covering only ``0 5 0 5`` with the ``strict``
+            method. ``flexible`` will select those files as it returns files that
+            have any overlap with the query extent. ``file`` will only return files
+            where the entire spatial extent is contained by the query geometry.
         extended_search: bool, default: False
             Retrieve information on additional search keys.
         multiversion: bool, default: False
@@ -650,12 +790,30 @@ class databrowser:
             from freva_client import databrowser
             print(databrowser.metadata_search("reana*", realm="ocean", flavour="cmip6"))
 
+        In datasets with multiple versions only the `latest` version (i.e.
+        `highest` version number) is returned by default. Querying a specific
+        version from a multi versioned datasets requires the ``multiversion``
+        flag in combination with the ``version`` special attribute:
+
+        .. execute_code::
+
+            from freva_client import databrowser
+            res = databrowser.metadata_search(dataset="cmip6-fs",
+                model="access-cm2", version="v20191108", extended_search=True,
+                multiversion=True)
+            print(res)
+
+        If no particular ``version`` is requested, information of all versions
+        will be returned.
+
         """
         this = cls(
             *facets,
             flavour=flavour,
             time=time,
             time_select=time_select,
+            bbox=bbox,
+            bbox_select=bbox_select,
             host=host,
             multiversion=multiversion,
             fail_on_error=fail_on_error,

{freva_client-2502.0.0 → freva_client-2505.0.0}/src/freva_client/utils/databrowser_utils.py

@@ -148,6 +148,11 @@ class Config:
         """Define the url for creating intake catalogues."""
         return f"{self.databrowser_url}/intake-catalogue/{self.flavour}/{self.uniq_key}"
 
+    @property
+    def stac_url(self) -> str:
+        """Define the url for creating stac catalogue."""
+        return f"{self.databrowser_url}/stac-catalogue/{self.flavour}/{self.uniq_key}"
+
     @property
     def metadata_url(self) -> str:
         """Define the endpoint for the metadata search."""