Skip to content

natgeo-wong/ARMLive.jl

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

26 Commits
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

ARMLive.jl Logo

ARMLive.jl

Repo Status GitHub Actions
MIT License Release Version Stable Documentation Latest Documentation

Created By: Nathanael Wong (nathanaelwong@fas.harvard.edu)

Introduction

ARMLive.jl is a Julia package that aims to streamline the following processes:

  • Querying and downloading data from the ARM Live Data Webservice
  • Organizing downloaded ARM data into a structured directory format
  • Reading ARM NetCDF data files using NCDatasets.jl

Installation

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

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

You can update ARMLive.jl to the latest version using

(@v1.12) pkg> update ARMLive

And if you want to get the latest release without waiting for me to update the Julia Registry, you may fix the version to the main branch of the GitHub repository:

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

Required Setup

In order to use this package, you need to:

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

This creates a .armliverc file in your home directory containing your credentials.

Usage

Please refer to the documentation for instructions and examples.

using ARMLive

# Create a dataset specification
ads = ARMDataset(
    stream = "sgpmetE13.b1",
    start  = Date(2020,1,1),
    stop   = Date(2020,1,31)
)

# Query available files
files = query(ads)

# Download the data
download(ads)

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

Supported Datasets

ARMLive.jl supports downloading any datastream available through the ARM Live Data Webservice. Common datastreams include:

  • Surface meteorology (e.g., sgpmetE13.b1)
  • Radiosonde data (e.g., sgpsondewnpnC1.b1)
  • Radiation measurements (e.g., sgpradflux1longC1.c1)

See the ARM Data Discovery portal for a full list of available datastreams.

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!

About

Julia package to download ARM data using the ARMLive protocols

Resources

License

Stars

Watchers

Forks

Packages

 
 
 

Contributors

Languages