arl-met#

Read and analyze ARL meteorological files.

Contents:

Installation#

From Source#

To install from source:

git clone https://github.com/jmineau/arl-met.git
cd arl-met
pip install -e .

Development Installation#

For development, install with the development dependencies:

git clone https://github.com/jmineau/arl-met.git
cd arl-met
python -m pip install --upgrade pip
pip install -e ".[dev,docs]"
pre-commit install

Requirements#

Python 3.10 or higher

Quick Start#

This guide will help you get started with arl-met.

Opening ARL Files#

The main entry point is the open_dataset() function:

from arlmet import open_dataset

# Open an ARL meteorological file
ds = open_dataset("path/to/file.arl")

Using the ARLMet Class#

You can also use the ARLMet class directly:

from arlmet import ARLMet

# Create an ARLMet instance
arl = ARLMet("path/to/file.arl")

# Access records
records = arl.records

Working with Data#

The package reads ARL packed meteorological data and provides access to:

Surface variables: Pressure, temperature, winds, fluxes, precipitation
Upper-air variables: Winds, temperature, heights, moisture

Example workflow:

from arlmet import open_dataset

# Open the file
ds = open_dataset("data.arl")

# Access variables, coordinates, and metadata
# (specific API details depend on implementation)

Next Steps#

See the API Reference for detailed API documentation
Check out the ARL File Format page to understand the ARL file format

API Reference#

arlmet

arlmet: Python package for reading and analyzing NOAA ARL meteorological files.

Contributing#

See the CONTRIBUTING.md file for guidelines on how to contribute to this project.