Strong .nc IO support #32 from JuliaClimate/lonlatfirst

JuliaClimate · Nov 13, 2020 · 5dd7b70 · 5dd7b70 · Datseris · Nov 13, 2020
2 parents 02497e3 + 4a80b60
commit 5dd7b70
Show file tree

Hide file tree

Showing 8 changed files with 350 additions and 199 deletions.
diff --git a/.gitignore b/.gitignore
@@ -1,3 +1,4 @@
+*.nc
 Manifest.toml
 ################################################################################
 #                          DrWatson Project Structure                          #

diff --git a/Project.toml b/Project.toml
@@ -1,7 +1,7 @@
 name = "ClimateBase"
 uuid = "35604d93-0fb8-4872-9436-495b01d137e2"
 authors = ["Datseris <datseris.george@gmail.com>", "Philippe Roy <borghor@yahoo.ca>"]
-version = "0.8.0"
+version = "0.9.0"
 
 [deps]
 Dates = "ade2ca70-3891-5945-98fb-dc099432e06a"

diff --git a/docs/src/index.md b/docs/src/index.md
@@ -42,8 +42,8 @@ C = latmean(B)
 ```
 where in this averaging process each data point is weighted by the cosine of its latitude.
 
-## Making a `ClimArray`
-You can create a `ClimArray` yourself, or you can load data from an `.nc` file with CF-conventions, using `ClimArray`.
+### Making a `ClimArray`
+You can create a `ClimArray` yourself, or you can load data from an `.nc` file with CF-conventions, see [NetCDF IO](@ref).
 ```@docs
 ClimArray(::AbstractArray, ::Tuple)
 ```
@@ -56,7 +56,9 @@ end
 ```
 We explicitly assume that `Lon, Lat` are measured in degrees and not radians or meters (extremely important for spatial averaging processes).
 
----
+## NetCDF IO
+ClimateBase.jl has support for `file.nc ⇆ ClimArray`.
+To load a `ClimArray` directly from an `.nc` file do:
 ```@docs
 ClimArray(::Union{String, Vector{String}})
 ```
@@ -73,6 +75,11 @@ nckeys
 ncdetails
 ```
 
+You can also write a bunch of `ClimArray`s directly into an `.nc` file with
+```@docs
+climarrays_to_nc
+```
+
 ## Temporal
 Functions related with the `Time` dimension.
 ```@docs
@@ -112,6 +119,7 @@ spacemean
 spaceagg
 hemispheric_means
 hemispheric_functions
+lonlatfirst
 ```
 
 ## General aggregation

diff --git a/src/ClimateBase.jl b/src/ClimateBase.jl
@@ -2,7 +2,7 @@ module ClimateBase
 
 # TODO: Be sure all exported names have docstrings
 include("core/coredefs.jl")
-include("core/loading_nc.jl")
+include("core/nc_io.jl")
 include("core/aggregation.jl")
 
 include("physical_dimensions/spatial.jl")

diff --git a/src/core/coredefs.jl b/src/core/coredefs.jl
@@ -24,6 +24,10 @@ export EqArea, Grid, spacestructure
 
 STANDARD_DIMS = (Lon, Lat, Time, Hei, Pre, Coord)
 
+"""
+    COMMONNAMES
+A dictionary of common names of dimensions (as strings) to actual dimension types.
+"""
 const COMMONNAMES = Dict(
     "lat" => Lat,
     "latitude" => Lat,
@@ -37,6 +41,7 @@ const COMMONNAMES = Dict(
     "level" => Pre,
 )
 
+
 # the trait EqArea is for equal area grids. Functions can use the `spacestructure` and
 # dispatch on `EqArea` or other types while still being type-stable
 struct EqArea end
@@ -64,6 +69,7 @@ struct ClimArray{T,N,D<:Tuple,R<:Tuple,A<:AbstractArray{T,N},Me} <: AbstractDime
     attrib::Me
 end
 ClimArray(A::DimensionalArray) = ClimArray(A.data, A.dims, A.refdims, A.name, A.metadata)
+ClimArray(A::ClimArray; name = A.name, attrib = A.attrib) = ClimArray(A.data, A.dims, A.refdims, name, attrib)
 
 """
     ClimArray(A::Array, dims::Tuple; name = "", attrib = nothing)