Export datasets top level (#537)

* export datasets at top level

* remove unnecessary imports

* add empty line

* export JRA55NetCDFBackend

* Update examples/ecco_mixed_layer_depth.jl

Co-authored-by: Simone Silvestri <[email protected]>

* Update examples/ecco_inspect_temperature_salinity.jl

Co-authored-by: Simone Silvestri <[email protected]>

---------

Co-authored-by: Simone Silvestri <[email protected]>

Author: navidcy

examples/ecco_inspect_temperature_salinity.jl

@@ -4,7 +4,6 @@ using Oceananigans.ImmersedBoundaries: mask_immersed_field!
 using CairoMakie
 using Printf
 using ClimaOcean
-using ClimaOcean.DataWrangling.ECCO: ECCOFieldTimeSeries, ECCO4Monthly
 using CFTime
 using Dates
 

examples/ecco_mixed_layer_depth.jl

@@ -1,6 +1,5 @@
 using ClimaOcean
 using ClimaOcean.Diagnostics: MixedLayerDepthField
-using ClimaOcean.DataWrangling.ECCO: ECCOFieldTimeSeries, ECCO4Monthly
 using Oceananigans
 using CairoMakie
 using Printf

examples/mediterranean_simulation_with_ecco_restoring.jl

@@ -20,7 +20,6 @@ using Oceananigans
 using Oceananigans: architecture
 using ClimaOcean
 using ClimaOcean.ECCO
-using ClimaOcean.ECCO: ECCO4Monthly
 using Oceananigans.Units
 using Printf
 using Dates

examples/near_global_ocean_simulation.jl

@@ -14,7 +14,6 @@
 # including grid setup, physical processes modeling, and data visualization.
 
 using ClimaOcean
-using ClimaOcean.ECCO
 using Oceananigans
 using Oceananigans.Units
 using CairoMakie
@@ -82,8 +81,8 @@ ocean.model
 
 # We initialize the ocean model with ECCO4 temperature and salinity for January 1, 1992.
 
-set!(ocean.model, T=ECCOMetadatum(:temperature),
-                  S=ECCOMetadatum(:salinity))
+set!(ocean.model, T=Metadatum(:temperature, dataset=ECCO4Monthly()),
+                  S=Metadatum(:salinity, dataset=ECCO4Monthly()))
 
 # ### Prescribed atmosphere and radiation
 #

examples/one_degree_simulation.jl

@@ -9,7 +9,6 @@
 # CairoMakie to visualize the simulation.
 
 using ClimaOcean
-using ClimaOcean.ECCO
 using Oceananigans
 using Oceananigans.Units
 using Dates
@@ -121,7 +120,7 @@ function progress(sim)
     Tmin, Tmax = minimum(T), maximum(T)
     emax = maximum(e)
     umax = (maximum(abs, u), maximum(abs, v), maximum(abs, w))
-            
+
     step_time = 1e-9 * (time_ns() - wall_time[])
 
     msg1 = @sprintf("Time: %s, iter: %d", prettytime(sim), iteration(sim))

examples/single_column_os_papa_simulation.jl

@@ -15,7 +15,6 @@
 # ```
 
 using ClimaOcean
-using ClimaOcean.ECCO
 using Oceananigans
 using Oceananigans.Units
 using Oceananigans.BuoyancyFormulations: buoyancy_frequency
@@ -40,7 +39,7 @@ grid = RectilinearGrid(size = 200,
 
 # # An "ocean simulation"
 #
-# Next, we use ClimaOcean's ocean_simulation constructor to build a realistic
+# Next, we use ClimaOcean's `ocean_simulation` constructor to build a realistic
 # ocean simulation on the single-column grid,
 
 ocean = ocean_simulation(grid; Δt=10minutes, coriolis=FPlane(latitude = φ★))
@@ -49,10 +48,10 @@ ocean = ocean_simulation(grid; Δt=10minutes, coriolis=FPlane(latitude = φ★))
 
 ocean.model
 
-# We set initial conditions from ECCO:
+# We set initial conditions from ECCO4:
 
-set!(ocean.model, T=ECCOMetadatum(:temperature),
-                  S=ECCOMetadatum(:salinity))
+set!(ocean.model, T=Metadatum(:temperature, dataset=ECCO4Monthly()),
+                  S=Metadatum(:salinity, dataset=ECCO4Monthly()))
 
 # # A prescribed atmosphere based on JRA55 re-analysis
 #

experiments/one_degree_simulation/one_degree_simulation.jl

@@ -1,5 +1,4 @@
 using ClimaOcean
-using ClimaOcean.ECCO: ECCO4Monthly
 using Oceananigans.OrthogonalSphericalShellGrids
 using Oceananigans
 using Oceananigans.Units

src/ClimaOcean.jl

@@ -31,6 +31,12 @@ export
     Metadata,
     Metadatum,
     ECCOMetadatum,
+    EN4Metadatum,
+    ETOPO2022,
+    ECCO2Daily, ECCO2Monthly, ECCO4Monthly,
+    EN4Monthly,
+    GLORYSDaily, GLORYSMonthly, GLORYSStatic,
+    RepeatYearJRA55, MultiYearJRA55,
     first_date,
     last_date,
     all_dates,
@@ -86,17 +92,20 @@ include("Diagnostics/Diagnostics.jl")
 
 using .VerticalGrids
 using .DataWrangling
-using .DataWrangling: JRA55, ECCO, EN4, Copernicus, ETOPO
+using .DataWrangling: ETOPO, ECCO, Copernicus, EN4, JRA55
 using .Bathymetry
 using .InitialConditions
 using .OceanSeaIceModels
 using .OceanSimulations
 using .SeaIceSimulations
 
 using ClimaOcean.OceanSeaIceModels: PrescribedAtmosphere, ComponentInterfaces, MomentumRoughnessLength, ScalarRoughnessLength
-using ClimaOcean.DataWrangling.JRA55: JRA55PrescribedAtmosphere, JRA55NetCDFBackend
-using ClimaOcean.DataWrangling.ECCO
 using ClimaOcean.DataWrangling.ETOPO
+using ClimaOcean.DataWrangling.ECCO
+using ClimaOcean.DataWrangling.Copernicus
+using ClimaOcean.DataWrangling.EN4
+using ClimaOcean.DataWrangling.JRA55
+using ClimaOcean.DataWrangling.JRA55: JRA55NetCDFBackend
 
 using PrecompileTools: @setup_workload, @compile_workload
 

src/DataWrangling/DataWrangling.jl

@@ -201,16 +201,16 @@ function default_inpainting(metadata)
 end
 
 # Datasets
-include("JRA55/JRA55.jl")
+include("ETOPO/ETOPO.jl")
 include("ECCO/ECCO.jl")
-include("EN4/EN4.jl")
 include("Copernicus/Copernicus.jl")
-include("ETOPO/ETOPO.jl")
+include("EN4/EN4.jl")
+include("JRA55/JRA55.jl")
 
+using .ETOPO
 using .ECCO
+using .Copernicus
 using .EN4
 using .JRA55
-using .Copernicus
-using .ETOPO
 
 end # module

src/DataWrangling/metadata.jl

@@ -58,7 +58,7 @@ Keyword Arguments
 =================
 
 - `dataset`: Supported datasets are `ETOPO2022()`, `ECCO2Monthly()`, `ECCO2Daily()`, `ECCO4Monthly()`, `EN4Monthly()`,
-             `RepeatYearJRA55()`, and `MultiYearJRA55()`.
+             `GLORYSDaily()`, `GLORYSMonthly()`, `RepeatYearJRA55()`, and `MultiYearJRA55()`.
 
 - `dates`: The dates of the dataset (`Dates.AbstractDateTime` or `CFTime.AbstractCFDateTime`).
            Note that `dates` can either be a range or a vector of dates, representing a time-series.