BinData

Data structure containing a string or an array of strings (NetCDF file names) as well as metadata needed to read a file.

BinData(fnames::Union{Array{String},String},precision::Type,iosize::Tuple)

Construct a BinData struct for files that contain one field.

NCData

Data structure containing a string or an array of strings (file names) of NetCDF files as well as information needed to read a file.

NCT

Data structure containing information needed to write a NetCDF file.

NCvar

Data structure containing information needed to write a variable to NetCDF files.

Instead of loading the data into memory, one can provide a list of input file names (see Bindata).

TileData{T}

Data structure containing either a MeshArray struct or BinData struct (see vals), MeshArray structs describing the tile layout (tileinfo), and other information for reading/writing tile data.

TileData(vals,tilesize::Tuple)

Construct a TileData struct. First generate the tileinfo, precision, and numtiles attributes.

getindex(d::BinData,i::Integer)

Return a new BinData object with the ith file, this being time index i.

getindex(d::NCData,i)

Retrieve the ith time step from the NetCDF file.

getindex(v::NCvar,i::Integer)

Retrive an NCvar at time step i.

Currently only works when values is a BinData, NCdata, or array of time steps.

write(myflds::Dict,savename::String;README="",globalattribs=Dict())

Creates NetCDF file and writes myflds and all their dimensions to the file.

write(myfld::NCvar,savename::String;README="",globalattribs=Dict())

Creates NetCDF file and writes myfld and all its dimensions to the file.

addData(v::Union{NCDatasets.CFVariable,NetCDF.NcVar},var::NCvar)

Fill variable with data in netcdf file using either NCDatasets.jl or NetCDF.jl

addDim(ds::NCDatasets.Dataset,dimvar::NCvar) # NCDatasets

Add a dimension to a NCDatasets.Dataset

addDim(dimvar::NCvar)

Add a dimension to a NetCDF file using NetCDF.jl

addDimData(v::Union{NCDatasets.CFVariable,NetCDF.NcVar,Array},var::NCvar)

Add dimension data to predefined dimensions in a NetCDF file.

addVar(ds::NCDatasets.Dataset,field::NCvar)

Add a variable to a NetCDF file using NCDatasets.jl

addVar(field::NCvar,dimlist::Array{NetCDF.NcDim})

Add a variable with dimensions dimlist to a NetCDF file using NetCDF.jl

addVar(field::NCvar})

Add a variable and its dimensions to a NetCDF file using NetCDF.jl

checkdims(v0::Array,var::NCvar)

Helper function: Checks that the size of the data about to be written to the file matches the provided dimensions.

createfile(filename, field::Union{NCvar,Dict{String,NCvar}}, README;
            fillval=NaN, missval=NaN, itile=1, ntile=1)

Create NetCDF file and add variable + dimension definitions using either NCDatasets.jl or NetCDF.jl

ensure_testcases_installed()

Download nctiles-testcases Artifact and decompress files if needed.

findidx(A,val)

Helper function for getting the indices for tiles. A is a gcmfaces struct, val is a numeric value to get the indices of. Returns a Dict of the indices for each face. Not currently exported. Maybe move to MeshArrays?

findtimedim(v::Array)

Helper function: finds which dimension is a time dimension, if any. Can be Array of NCvars or NCDatasets.CFVariables.

getdims(myflds::Dict)

Helper function: retrieves unique dimensions in dictionary of fields.

getnsteps(d)

Helper function: Determines number of time steps in data d. Input d can be BinData, NCData, TileData, or an Array.

gettile(fldvals,tileinfo,tilesize,tilenum::Int)

Helper function for retrieving a tile from a gcmfaces struct as a numeric Array. Not currently exported.

gettiles(fldvals,tilenum::Int)

Helper function for retrieving a tile from a gcmfaces struct as a numeric Array along with associated latitude and longitude. Not currently exported.

hastiledata(myfld::NCvar)

Helper function: returns whether given field or dict of fields has any tiled data.

hastimedim::Array)

Helper function: determines whether an array of dimensions has a time dimension. Can be Array of NCvars or NCDatasets.CFVariables.

hastimedim(v::NCvar)

Helper function: determines whether a variable has a time dimension.

istimedim(d::Union{NCvar,NCDatasets.CFVariable})

Helper function: determines whether d is a time dimension.

pkg_version(name::String)

Get the version number (in current environment) for a package name

readbin(flddata::BinData,tidx=1)

Read in a binary file as an array as specified by BinData

readbin(fname::String,prec::Type,iosize::Tuple,fldidx=1)

Read in a binary file to an Array.

readdata(flddata,tidx=1)

Generic wrapper function to read data from a file regardless of file/data type.

readncdata(var::NCData,i::Union{Colon,Integer}=:)

Read netcdf file as specified in NCData argument. Optional argument i can be used to read a specific records / times.

readncfile(fname,backend::Module=NCDatasets)

Read in a NetCDF file and return variables/dimensions as NCvar structs, and file attributes as Dict. Large variables/dimensions are not loaded into memory. This can use either NCDatasets.jl or NetCDF.jl

replacevalues(vals,ncvar::NCvar)

Helper function: Replaces the "values" attribute of an ncvar without changing anything else. Used to apply land mask.

replacevalues(vals,td::TileData)

Helper function: Replaces the "values" attribute of a TilData struct without changing anything else. Used to apply land mask.

writetiles(v,var,tilenum,timeidx=1)

Helper function for writing a tile to a NetCDF file.