ARMLive.jl

Appearance

ARMLive.jlAccessing ARM Data using Julia

Query, download, and read data from ARMLive.

API
View on Github
ARMLive Logo

Query ARM Data

Search for available files in any ARM datastream within a specified date range.

Automated Downloads

Download ARM data files with progress tracking and organized directory structure.

NCDatasets Integration

Read downloaded ARM NetCDF files directly using NCDatasets.jl.

Introduction ​

ARMLive.jl is a lightweight Julia package that provides programmatic access to the ARM Live Data Webservice. It allows you to query, download, and read data from the Atmospheric Radiation Measurement (ARM) program.

Installation Instructions ​

The latest version of ARMLive can be installed using the Julia package manager (accessed by pressing ] in the Julia command prompt)

julia
julia> ]
(@v1.12) pkg> add ARMLive

You can update ARMLive.jl to the latest version using

julia
(@v1.12) pkg> update ARMLive

And if you want to get the latest release without waiting for me to update the Julia Registry (although this generally isn't necessary since I make a point to release patch versions as soon as I find bugs or add new working features), you may fix the version to the main branch of the GitHub repository:

julia
(@v1.12) pkg> add ARMLive#main

Required Setup ​

Before using ARMLive.jl, you need to:

  1. Register for an account at the ARM Data Discovery portal

  2. Obtain your access token from the ARM Live Data Webservice

  3. Run the setup() function to store your credentials:

julia
using ARMLive
setup(user="your_username", token="your_token")

Quick Example ​

julia
using ARMLive

# Create a dataset type
ads = ARMDataset(
    stream = "sgpmetE13.b1",
    start  = Date(2020,1,1),
    stop   = Date(2020,1,31),
    path   = <path-to-data-directory>
)

# Query available files
files = query(ads)

# Download the data
download(ads)

# Read data for a specific date
ds = read(ads, Date(2020,1,15))

Getting help ​

If you are interested in using ARMLive.jl or are trying to figure out how to use it, please feel free to ask me questions and get in touch! Please feel free to open an issue if you have any questions, comments, suggestions, etc!