API

ARMLive.ARMDataset Type

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

ARMDataset(; stream, start, stop, path=armpath(homedir()), raw=true)

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().

Returns

• An ARMRaw or ARMProcessed dataset specification.

source

ARMLive.query Method

query(ads::ARMDataset)

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

Arguments

• ads: An ARMDataset type.

source

ARMLive.setup Method

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

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

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.

Returns

Nothing

source

Base.download Method

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

• 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

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