Regions

regions

regions

This module exposes the OceanBench region API.

Functions

Name	Description
available_regions	Return the official OceanBench region identifiers accepted by the CLI --region option.
custom	Create a custom bounded region for programmatic evaluation.
load_region_file	Load a custom region definition from a JSON file.
subset	Return a dataset restricted to the selected OceanBench region.

available_regions

regions.available_regions()

Return the official OceanBench region identifiers accepted by the CLI --region option.

custom

regions.custom(
    identifier,
    display_name,
    minimum_latitude,
    maximum_latitude,
    minimum_longitude,
    maximum_longitude,
)

Create a custom bounded region for programmatic evaluation.

load_region_file

regions.load_region_file(path)

Load a custom region definition from a JSON file.

subset

regions.subset(dataset, region)

Return a dataset restricted to the selected OceanBench region.