hfradarpy 0.1.5
Toolbox to read in High Frequency Radar (HFR) files written in CODAR Tabular Format (CTF).
License: MIT license
Requires Python: >=3.7
Keywords: hfradarpy

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


.. image:: https://img.shields.io/pypi/v/hfradarpy.svg
    :target: https://pypi.python.org/pypi/hfradarpy

.. image:: https://readthedocs.org/projects/hfradarpy/badge/?version=latest
        :target: https://hfradarpy.readthedocs.io/en/latest/?version=latest
        :alt: Documentation Status
    
.. image:: https://github.com/<rucool>/hfradarpy/actions/workflows/<WORKFLOW_FILE>/badge.sv

.. .. 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 read in High Frequency Radar (HFR) files written in CODAR Tabular Format (CTF).


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


Features
--------

* TODO

============
Installation
============


Stable release
--------------

To install HFRadarPy, run this command in your terminal:

.. code-block:: console

    $ pip install hfradarpy

This is the preferred method to install HFRadarPy, as it will always install the most recent stable release.

If you don't have `pip`_ installed, this `Python installation guide`_ can guide
you through the process.

.. _pip: https://pip.pypa.io
.. _Python installation guide: http://docs.python-guide.org/en/latest/starting/installation/


We also recommend using miniconda to manage your Python environments. Download and follow the `Miniconda installation guide`_ for the appropriate
Miniconda installer for your operating system. 

.. _Miniconda installation guide: http://conda.pydata.org/miniconda.html

Make sure to add the channel, `conda-forge`_, to your .condarc. You can
find out more about conda-forge from their website:

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

You can do this with the following command:

.. code-block:: console

        conda config --add channels conda-forge

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 git://github.com/rucool/hfradarpy

Or download the `tarball`_:

.. code-block:: console

    $ curl -OJL https://github.com/rucool/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
=======

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.