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:
$ 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.
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.
Make sure to add the channel, conda-forge, to your .condarc. You can find out more about conda-forge from their website:
You can do this with the following command:
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:
$ git clone git://github.com/rucool/hfradarpy
Or download the tarball:
$ 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.
$ 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.