Skip to main content

HFRadarPy

Toolbox to work with High Frequency Radar (HFR) files.

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

Installation

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.

History

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.

Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

hfradarpy-1.0.0.1.tar.gz (5.2 MB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

hfradarpy-1.0.0.1-py2.py3-none-any.whl (5.2 MB view details)

Uploaded Python 2Python 3

File details

Details for the file hfradarpy-1.0.0.1.tar.gz.

File metadata

  • Download URL: hfradarpy-1.0.0.1.tar.gz
  • Upload date:
  • Size: 5.2 MB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.2.0 CPython/3.9.13

File hashes

Hashes for hfradarpy-1.0.0.1.tar.gz
Algorithm Hash digest
SHA256 561b4232334084fa83546fad088687fb3b7d9de053a20c4df1c5e241c2384540
MD5 fb260ffde71241d8f8ad309a693cb29f
BLAKE2b-256 287af036dd8575cdf79fb85fc36b5460a079d0bfb721019e76c84470e4292b5d

See more details on using hashes here.

File details

Details for the file hfradarpy-1.0.0.1-py2.py3-none-any.whl.

File metadata

  • Download URL: hfradarpy-1.0.0.1-py2.py3-none-any.whl
  • Upload date:
  • Size: 5.2 MB
  • Tags: Python 2, Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.2.0 CPython/3.9.13

File hashes

Hashes for hfradarpy-1.0.0.1-py2.py3-none-any.whl
Algorithm Hash digest
SHA256 6f5512b9d8d988b0258436168a6e9bd6b235ffaa48f571588570b9578d792e39
MD5 399e16b4a7f1634c4867aeda271b72cb
BLAKE2b-256 8acd965cca3c06b4f2fcbac6d936655a25ceef809d4506e85c5bfc1ed29c9370

See more details on using hashes here.

Release history Release notifications | RSS feed

This release

1.0.0.1 This release

2 files

0.1.5

2 files

0.1.4.7

2 files

0.1.4.3

2 files

0.1.4.1

2 files

0.1.3

2 files

0.1.2

2 files

Anthropic, PBC Visionary sponsor Bloomberg Visionary sponsor Hudson River Trading Visionary sponsor Meta Visionary sponsor NVIDIA Visionary sponsor Microsoft Sustainability sponsor Depot Continuous Integration AWS Cloud computing and Security Sponsor Datadog Monitoring Fastly CDN Google Download Analytics Sentry Error logging StatusPage Status page