Metadata-Version: 2.4
Name: hfradarpy
Version: 1.0.0.1
Summary: Toolbox to read in High Frequency Radar (HFR) files written in CODAR Tabular Format (CTF).
Home-page: https://github.com/rowg/hfradarpy
Author: Michael Smith
Author-email: michaesm@marine.rutgers.edu
License: MIT license
Keywords: hfradarpy
Classifier: Development Status :: 2 - Pre-Alpha
Classifier: Intended Audience :: Developers
Classifier: License :: OSI Approved :: MIT License
Classifier: Natural Language :: English
Classifier: Programming Language :: Python :: 3.10
Classifier: Programming Language :: Python :: 3.11
Requires-Python: >=3.10
Description-Content-Type: text/x-rst
License-File: LICENSE
License-File: AUTHORS.rst
Requires-Dist: xarray
Requires-Dist: netcdf4
Requires-Dist: pyproj
Requires-Dist: click
Requires-Dist: dask
Requires-Dist: geopandas
Requires-Dist: cartopy
Requires-Dist: matplotlib
Requires-Dist: cmocean
Requires-Dist: joblib
Requires-Dist: basemap
Requires-Dist: geopy
Requires-Dist: oceans
Dynamic: author
Dynamic: author-email
Dynamic: classifier
Dynamic: description
Dynamic: description-content-type
Dynamic: home-page
Dynamic: keywords
Dynamic: license
Dynamic: license-file
Dynamic: requires-dist
Dynamic: requires-python
Dynamic: summary

=========
HFRadarPy
=========


.. .. image:: https://circleci.com/gh/rucool/HFRadarPy/tree/master.svg?style=svg
..    :target: https://circleci.com/gh/rucool/HFRadarPy/tree/master

.. .. image:: https://codecov.io/gh/rucool/hfradarpy/branch/master/graph/badge.svg
..    :target: https://codecov.io/gh/rucool/hfradarpy




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


* Free software: MIT license
* Documentation: https://hfradarpy.readthedocs.io.


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.


.. _Download the Miniforge installer: http://conda.pydata.org/miniconda.html

.. _latest release: https://conda-forge.org/download/

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

.. code-block:: console

        conda config --add channels conda-forge

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

.. _conda-forge: https://conda-forge.org/

Run this command to install HFRadarPy:

.. code-block:: console

    $ 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:

.. code-block:: console

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

Or download the `tarball`_:

.. code-block:: console

    $ 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.

.. code-block:: console

        $ cd ~/Downloads/hfradarpy/

Create conda environment from the included environment_dev.yml file:

.. code-block:: console

        $ conda env create -f environment_dev.yml

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

.. code-block:: console

        $ conda activate hfradarpy # OSX/Unix

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

.. code-block:: console

    $ python setup.py install

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

.. code-block:: console

    $ pip install .

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

.. code-block:: console

    $ 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':

.. code-block:: console

    $ pytest

.. _Github repo: https://github.com/rucool/hfradarpy
.. _tarball: https://github.com/rucool/hfradarpy/tarball/master

Credits
-------

This package was created with Cookiecutter_ and the `audreyr/cookiecutter-pypackage`_ project template.

.. _Cookiecutter: https://github.com/audreyr/cookiecutter
.. _`audreyr/cookiecutter-pypackage`: https://github.com/audreyr/cookiecutter-pypackage


=======
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.
