convenience (#531)

Co-authored-by: Navid C. Constantinou <[email protected]>

Author: simone-silvestri

src/DataWrangling/Copernicus/Copernicus.jl

@@ -21,7 +21,8 @@ import ClimaOcean.DataWrangling:
     z_interfaces,
     metadata_filename,
     inpainted_metadata_path,
-    reversed_vertical_axis
+    reversed_vertical_axis,
+    available_variables
 
 using Scratch
 
@@ -62,6 +63,8 @@ CopernicusMetadatum = Metadatum{<:CopernicusDataset}
 Base.size(::CopernicusMetadatum) = (4320, 2040, 50, 1)
 reversed_vertical_axis(::CopernicusDataset) = true
 
+available_variables(::CopernicusDataset) = copernicus_dataset_variable_names
+
 copernicus_dataset_variable_names = Dict(
     :temperature => "thetao",
     :depth => "deptho",

src/DataWrangling/ECCO/ECCO.jl

@@ -42,7 +42,8 @@ import ClimaOcean.DataWrangling:
     is_three_dimensional,
     inpainted_metadata_path,
     reversed_vertical_axis,
-    default_mask_value
+    default_mask_value,
+    available_variables
 
 download_ECCO_cache::String = ""
 function __init__()
@@ -144,6 +145,10 @@ z_interfaces(::SomeECCODataset) = [
       0.0,
 ]
 
+available_variables(::ECCO2Monthly) = ECCO2_dataset_variable_names
+available_variables(::ECCO2Daily)   = ECCO2_dataset_variable_names
+available_variables(::ECCO4Monthly) = ECCO4_dataset_variable_names
+
 ECCO4_dataset_variable_names = Dict(
     :temperature           => "THETA",
     :salinity              => "SALT",

src/DataWrangling/EN4/EN4.jl

@@ -47,7 +47,8 @@ import ClimaOcean.DataWrangling:
     latitude_interfaces,
     is_three_dimensional,
     reversed_vertical_axis,
-    inpainted_metadata_path
+    inpainted_metadata_path,
+    available_variables
 
 import Oceananigans.Fields: location
 
@@ -71,6 +72,7 @@ reversed_vertical_axis(::EN4Monthly) = true
 
 longitude_interfaces(::EN4Monthly) = (0.5, 360.5)
 latitude_interfaces(::EN4Monthly) = (-83.5, 89.5)
+available_variables(::EN4Monthly) = EN4_dataset_variable_names
 
 z_interfaces(::EN4Monthly) = [
     -5500.0,

src/DataWrangling/JRA55/JRA55_metadata.jl

@@ -12,7 +12,7 @@ import Oceananigans.Fields: set!
 import Base
 
 import Oceananigans.Fields: set!, location
-import ClimaOcean.DataWrangling: all_dates, metadata_filename, download_dataset, default_download_directory
+import ClimaOcean.DataWrangling: all_dates, metadata_filename, download_dataset, default_download_directory, available_variables
 
 struct MultiYearJRA55 end
 struct RepeatYearJRA55 end
@@ -88,6 +88,9 @@ end
 dataset_variable_name(data::JRA55Metadata) = JRA55_dataset_variable_names[data.name]
 location(::JRA55Metadata) = (Center, Center, Center)
 
+available_variables(::MultiYearJRA55)  = JRA55_variable_names
+available_variables(::RepeatYearJRA55) = JRA55_variable_names
+
 # A list of all variables provided in the JRA55 dataset:
 JRA55_variable_names = (:river_freshwater_flux,
                         :rain_freshwater_flux,

src/DataWrangling/metadata.jl

@@ -249,6 +249,13 @@ extended in the data specific modules.
 """
 metadata_filename(metadata) = [metadata_filename(metadatum) for metadatum in metadata]
 
+"""
+    available_variables(metadata)
+
+Return the available variables in the dataset.
+"""
+available_variables(metadata) = available_variables(metadata.dataset)
+
 struct Celsius end
 struct Kelvin end