xnrl 2022.9.29

xNRL - Read NRL files into xarray Datasets nested within pandas DataFrames

Distribution Statement A. Approved for public release. Distribution unlimited.

Author: Naval Research Laboratory, Marine Meteorology Division

This program is free software: you can redistribute it and/or modify it under the terms of the NRLMMD License included with this program. If you did not receive the license, see https://github.com/U-S-NRL-Marine-Meteorology-Division/ for more information.

This program is distributed WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the included license for more details.

xNRL helps you read NRL NWP output into xarray Datasets nested within Pandas DataFrames.

Install

xNRL requires numpy, pandas, and xarray.

Install with pip

pip install xnrl

Clone and install with pip

git clone https://github.com/U-S-NRL-Marine-Meteorology-Division/xnrl.git
cd xnrl
pip install -e .

The -e makes the code editable.

You can update the code with

cd xnrl
git pull origin main

Install with Conda

Copy the environment_xnrl.yml file and create the Conda environment.

conda env create -f environment_xnrl.yml

Note: This only installs the current main branch and does not let you edit the code. You can update xnrl (and all packages in the environment) with

conda env update -f environment_xnrl.yml

Examples

import xnrl

# Load COAMPS flatfiles into an xarray Dataset
fp = '<path>/*pre*00120*'
ds = xnrl.open_dataset(fp, model='COAMPS')