Merge branch 'main' into SymbolOrString

Author: Alexander-Barth

docs/src/index.md

@@ -1,20 +1,24 @@
 
-## Abstract types
+## Data types
 
 In order to implement a new dataset based `CommonDataModel.jl`
 one has to create two types derived from:
-1 .`AbstractVariable`: a variable with named dimension and metadata
-2. `AbstractDataset`: a collection of variable with named dimension, metadata and sub-groups. The sub-groups are also `AbstractDataset`.
 
+1. [`AbstractVariable`](#CommonDataModel.AbstractVariable): a variable with named dimension and metadata
+2. [`AbstractDataset`](#CommonDataModel.AbstractDataset): a collection of variable with named dimension, metadata and sub-groups. The sub-groups are also `AbstractDataset`.
+
+
+`CommonDataModel.jl` also provides a type `CFVariable` which wraps a type derived from `AbstractVariable` and applies the scaling described in
+[`cfvariable`](#CommonDataModel.cfvariable).
 
 Overview of methods:
 
-|            | get names     | get value  | write / set value |
-|------------|---------------|------------|-------------------|
-| Dimensions | `dimnames`    | `dim`      | `defDim`          |
-| Attributes | `attribnames` | `attrib`   | `defAttrib`       |
-| Variables  | `varnames`    | `variable` | `defVar`          |
-| Groups     | `groupnames`  | `group`    | `defGroup`        |
+|            | get names                                     | get value                               e| write / set value                        |
+|------------|-----------------------------------------------|-----------------------------------------|-------------------------------------------|
+| Dimensions | [`dimnames`](#CommonDataModel.dimnames)       | [`dim`](#CommonDataModel.dim)           | [`defDim`](#CommonDataModel.defDim)       |
+| Attributes | [`attribnames`](#CommonDataModel.attribnames) | [`attrib`](#CommonDataModel.attrib)     | [`defAttrib`](#CommonDataModel.defAttrib) |
+| Variables  | [`varnames`](#CommonDataModel.varname   s)    | [`variable`](#CommonDataModel.variable) | [`defVar`](#CommonDataModel.defVar)       |
+| Groups     | [`groupnames`](#CommonDataModel.groupnames)   | [`group`](#CommonDataModel.group)       | [`defGroup`](#CommonDataModel.defGroup)   |
 
 For read-only datasets, the methods in last column are not implemented.
 

src/cfvariable.jl

@@ -27,6 +27,7 @@ dataset(v::CFVariable) = dataset(v.var)
 
 attribnames(v::CFVariable) = keys(v.attrib)
 attrib(v::CFVariable,name::SymbolOrString) = v.attrib[name]
+defAttrib(v::CFVariable,name,value) = defAttrib(v.var,name,value)
 
 dimnames(v::CFVariable) = dimnames(v.var)
 dim(v::CFVariable,name::SymbolOrString) = dim(v.var,name)
@@ -40,12 +41,12 @@ Base.display(v::AbstractVariable) = show(stdout,v)
 """
     v = cfvariable(ds::NCDataset,varname::SymbolOrString; <attrib> = <value>)
 
-Return the NetCDF variable `varname` in the dataset `ds` as a
+Return the variable `varname` in the dataset `ds` as a
 `NCDataset.CFVariable`. The keyword argument `<attrib>` are
-the NetCDF attributes (`fillvalue`, `missing_value`, `scale_factor`, `add_offset`,
+the attributes (`fillvalue`, `missing_value`, `scale_factor`, `add_offset`,
 `units` and `calendar`) relevant to the CF conventions.
 By specifing the value of these attributes, the one can override the value
-specified in the NetCDF file. If the attribute is set to `nothing`, then
+specified in the data set. If the attribute is set to `nothing`, then
 the attribute is not loaded and the corresponding transformation is ignored.
 This function is similar to `ds[varname]` with the additional flexibility that
 some variable attributes can be overridden.
@@ -409,7 +410,7 @@ function Base.setindex!(v::CFVariable,data::Union{T,Array{T,N}},indexes::Union{I
         return data
     end
 
-    throw(NetCDFError(-1, "Time units and calendar must be defined during defVar and cannot change"))
+    @error "Time units and calendar must be defined during defVar and cannot change"
 end
 
 
@@ -440,7 +441,7 @@ end
 """
     _getattrib(ds,v,parentname,attribname,default)
 
-Get a NetCDF attribute, looking also at the parent variable name
+Get an attribute, looking also at the parent variable name
 (linked via the bounds attribute as following the CF conventions).
 The default value is returned if the attribute cannot be found.
 """

test/test_scaling.jl

@@ -105,6 +105,10 @@ CDM.defDim(md,"lat",size(data,2))
 mv = CDM.defVar(md,"data",eltype(data),("lon","lat"), attrib = OrderedDict{String,Any}(
     "units" => "days since 2000-01-01"))
 
+CDM.defAttrib(mv,"foo","bar")
+
+@test CDM.attrib(mv,"foo") == "bar"
+
 mv.var[:,:] .= data
 
 @test CDM.dim(md,"lon") == size(data,1)
@@ -124,4 +128,6 @@ md["data"][1,2] = DateTime(2000,2,1)
 
 
 @test CDM.dataset(md["data"]) == md
+
+
 close(md)