Features

• Read in CODAR, WERA and University of Hawaii HFR files

• Run quality control tests including QARTOD tests

• Calculate total vectors from radials

• Output results to CTF or NetCDF

Stable release

We recommend using Miniforge to manage your Python environments. Download the Miniforge installer for your computer architecture and operating system. In a Terminal window, run the .sh file that was downloaded.

Add the channel, conda-forge with the following command in your Terminal:

conda config --add channels conda-forge

You can find out more about conda-forge from their website:

Run this command to install HFRadarPy:

$ mamba install hfradarpy

This method will always install the most recent stable release of HFRadarPy.

From sources

The sources for HFRadarPy can be downloaded from the Github repo.

You can either clone the public repository:

$ git clone https://github.com/rowg/HFRadarPy.git

Or download the tarball:

$ curl -OJL https://github.com/rowg/hfradarpy/tarball/master

Once you have a copy of the source, you can should create a new conda/virtual environment:

Create environment

Change your current working directory to the location that you downloaded codar_processing to.

$ cd ~/Downloads/hfradarpy/

Create conda environment from the included environment_dev.yml file:

$ conda env create -f environment_dev.yml

Once the environment is done building, you can activate the environment by typing:

$ conda activate hfradarpy # OSX/Unix

Once the environment is your active environment. You can install the toolbox to that environment.

$ python setup.py install

You can also change directory into the root hfradarpy directory and install with the following:

$ pip install .

Or if you are developing new code in the toolbox, you should install this library as ‘editable’:

$ pip install --no-deps --force-reinstall --ignore-installed -e .

Running tests

After setting up your environment, you can run all of the tests, provided you install ‘pytest’:

$ pytest

Credits

This package was created with Cookiecutter and the audreyr/cookiecutter-pypackage project template.

1.0.0.1 (2026-09-09)

• Move pytest out of install_requires into test-only requirements.

• QC/QARTOD test fixes in radials.py (spatial median, temporal gradient).

• Callsign metadata fix in common.py (issue #16).

1.0.0.0 (2025-01-24)

• Project transferred from rucool/HFRadarPy to rowg/HFRadarPy.

0.1.4.3 (2022-02-28)

• Fourth release on PyPI.

0.1.4.1 (2022-02-28)

• Third release on PyPI.

0.1.3 (2022-02-28)

• Second release on PyPI.

0.1.2 (2021-12-03)

• First release on PyPI.