API

julia

ARMDataset{ST<:AbstractString, DT<:TimeType}

Specifies an ARM (Atmospheric Radiation Measurement) dataset with the following fields:

stream - The ARM datastream name (e.g., "sgpmetE13.b1").
start - The start date for the data query.
stop - The end date for the data query.
path - The local directory path where data will be stored.

source

ARMLive.ARMDataset Method

julia

ARMDataset(; stream :: ST,
    start  :: DT,
    stop   :: DT,
    path   :: ST = armpath(homedir())
) where {ST <: AbstractString, DT<:TimeType} -> ARMDataset{ST,DT}

Create an ARMDataset specification for querying and downloading ARM data.

Keyword Arguments

stream - The ARM datastream name (e.g., "sgpmetE13.b1").
start - The start date for the data query.
stop - The end date for the data query.
path - The root directory for storing data, default is homedir().

source

ARMLive.query Method

julia

query(ads :: ARMDataset)

Retrieve a list of available files for an ARM data stream.

Arguments

ads: An ARMDataset type.

source

ARMLive.setup Method

julia

setup(;
    user  :: String,
    token :: String,
    path  :: AbstractString = homedir(),
    overwrite :: Bool = false
) -> nothing

Create an ARM credentials configuration file (.armliverc) in the specified directory.

Keyword Arguments

user : The ARM user identifier for authentication.
token : The ARM authentication token.
path : The directory where the .armliverc file will be saved. Defaults to the user's home directory homedir().
overwrite : If true, overwrite an existing .armliverc file. If false, skip creation if the file already exists. Defaults to false.

source

Base.download Method

julia

download(
    ads :: ARMDataset,
    variables   :: Vector{<:AbstractString};
    overwrite   :: Bool = false,
    interactive :: Bool = true
) -> nothing

Download ARM data files for a specified data stream and time period and extract variables of interest if they exist into separate files/folders. This will help to save space when there are too many variables around.

Arguments

ads : An ARMDataset type
variables : A vector of variable names (in String format)

Keyword Arguments

overwrite : If true, overwrite existing files. If false, skip files that already exist. Defaults to false.
interactive : If true, display a progress bar during download. If false, log download messages instead. Defaults to true.

source

Base.download Method

julia

download(
    ads :: ARMDataset;
    overwrite   :: Bool = false,
    interactive :: Bool = true
) -> nothing

Download ARM data files for a specified data stream and time period.

Arguments

ads : An ARMDataset type

Keyword Arguments

overwrite : If true, overwrite existing files. If false, skip files that already exist. Defaults to false.
interactive : If true, display a progress bar during download. If false, log download messages instead. Defaults to true.

source

Base.read Method

julia

read(
    ads :: ARMDataset,
    dt  :: TimeType;
    throw :: Bool = true
) -> ds :: NCDataset

Read ARM data from NetCDF files for a specified date or datetime.

Arguments

ads : An ARMDataset object specifying the data stream and storage path.
dt : A Date or DateTime object specifying which data to read.
throw : If true, throw an error when no data is found. If false, log a warning and return nothing. Defaults to true.

Returns

An NCDataset object containing the data. If multiple files match the datetime, they are automatically aggregated along the time dimension.
Returns nothing if no data is found and throw=false.

source

API ​

API