Data

Tools

Indexes

Applications

Experiments

Open Source Science

hfradarpy

Toolbox to read in High Frequency Radar (HFR) files written in the Codar Tabular Format (CTF). Easily read CODAR Ocean Sensors SeaSonde and HELZEL Messtechnik GmbH WERA radial files.

https://github.com/rucool/hfradarpy

Science Score: 62.0%

This score indicates how likely this project is to be science-related based on various indicators:

  • ✓
    CITATION.cff file
    Found CITATION.cff file
  • ✓
    codemeta.json file
    Found codemeta.json file
  • ✓
    .zenodo.json file
    Found .zenodo.json file
  • ○
    DOI references
  • ○
    Academic publication links
  • ✓
    Committers with academic emails
    3 of 4 committers (75.0%) from academic institutions
  • ✓
    Institutional organization owner
    Organization rucool has institutional domain (rucool.marine.rutgers.edu)
  • ○
    JOSS paper metadata
  • ○
    Scientific vocabulary similarity
    Low similarity (15.9%) to scientific vocabulary
Last synced: 6 months ago · JSON representation ·

Repository

Toolbox to read in High Frequency Radar (HFR) files written in the Codar Tabular Format (CTF). Easily read CODAR Ocean Sensors SeaSonde and HELZEL Messtechnik GmbH WERA radial files.

Basic Info
  • Host: GitHub
  • Owner: rucool
  • License: mit
  • Language: Python
  • Default Branch: master
  • Homepage:
  • Size: 137 MB
Statistics
  • Stars: 5
  • Watchers: 5
  • Forks: 11
  • Open Issues: 0
  • Releases: 5
Created almost 8 years ago · Last pushed almost 2 years ago
Metadata Files
Readme Changelog Contributing License Citation Authors

README.rst 

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

.. image:: https://github.com/rucool/hfradarpy/actions/workflows/python-package.yml/badge.svg

.. 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://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
--------------

We 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

To install HFRadarPy, run this command in your terminal:

.. code-block:: console

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

Owner

  • Name: RUCOOL
  • Login: rucool
  • Kind: organization
  • Location: New Brunswick, NJ

Rutgers University - Center for Ocean Observing Leadership

Citation (CITATION.cff) 

# This CITATION.cff file was generated with cffinit.
# Visit https://bit.ly/cffinit to generate yours today!

cff-version: 1.2.0
title: HFRadarPy
message: >-
  If you find this software useful, please cite it
  using the metadata from this file.
type: software
authors:
  - given-names: Michael
    email: michaesm@marine.rutgers.edu
    affiliation: Rutgers University
    orcid: 'https://orcid.org/0000-0002-3572-8267'
    family-names: Smith
  - given-names: Teresa
    email: garner@ccpo.odu.edu
    affiliation: Old Dominion University
    family-names: Updyke
  - given-names: Kyle
    family-names: Wilcox
    email: kyle@axiomdatascience.com
    affiliation: Axiom Data Science
repository-code: 'https://www.github.com/rucool/hfradarpy'
url: 'https://hfradarpy.readthedocs.io/en/latest/'
abstract: >-
  HFRadarPy (HFRP) is a Python package designed for
  exploration, cleaning, and manipulation of data
  generated by HF radar surface current mapping
  instruments.
keywords:
  - open-source
  - high frequency radar
  - oceanography
  - surface currents
  - quality control
  - time series
  - analysis
license: MIT

GitHub Events

Total
Last Year

Committers

Last synced: almost 3 years ago

All Time
  • Total Commits: 265
  • Total Committers: 4
  • Avg Commits per committer: 66.25
  • Development Distribution Score (DDS): 0.219
Past Year
  • Commits: 35
  • Committers: 2
  • Avg Commits per committer: 17.5
  • Development Distribution Score (DDS): 0.229
Top Committers
Name Email Commits
Mike Smith m****m@m****u 207
Teresa Updyke g****r@c****u 40
Kyle Wilcox k****e@a****m 16
Laura Palamara Nazzaro n****o@m****u 2
Committer Domains (Top 20 + Academic)
marine.rutgers.edu: 2 axiomdatascience.com: 1 ccpo.odu.edu: 1

Issues and Pull Requests

Last synced: 7 months ago

All Time
  • Total issues: 1
  • Total pull requests: 36
  • Average time to close issues: 1 day
  • Average time to close pull requests: 3 days
  • Total issue authors: 1
  • Total pull request authors: 5
  • Average comments per issue: 2.0
  • Average comments per pull request: 0.06
  • Merged pull requests: 34
  • Bot issues: 0
  • Bot pull requests: 1
Past Year
  • Issues: 0
  • Pull requests: 0
  • Average time to close issues: N/A
  • Average time to close pull requests: N/A
  • Issue authors: 0
  • Pull request authors: 0
  • Average comments per issue: 0
  • Average comments per pull request: 0
  • Merged pull requests: 0
  • Bot issues: 0
  • Bot pull requests: 0
View more stats
Top Authors
Issue Authors
  • neaptide (1)
Pull Request Authors
  • teresaupdyke (28)
  • najascutellatus (5)
  • kwilcox (3)
  • dependabot[bot] (1)
  • lnazzaro (1)
Top Labels
Issue Labels
Pull Request Labels
dependencies (1)

Packages

  • Total packages: 2
  • Total downloads:
    • pypi 24 last-month
  • Total dependent packages: 0
    (may contain duplicates)
  • Total dependent repositories: 2
    (may contain duplicates)
  • Total versions: 7
  • Total maintainers: 1
pypi.org: hfradarpy

Toolbox to read in High Frequency Radar (HFR) files written in CODAR Tabular Format (CTF).

  • Versions: 6
  • Dependent Packages: 0
  • Dependent Repositories: 1
  • Downloads: 24 Last month
Rankings
Dependent packages count: 10.0%
Forks count: 10.5%
Average: 21.7%
Dependent repos count: 21.8%
Stargazers count: 27.8%
Downloads: 38.3%
Maintainers (1)
michaesm
Last synced: 7 months ago
conda-forge.org: hfradarpy
  • Versions: 1
  • Dependent Packages: 0
  • Dependent Repositories: 1
Rankings
Dependent repos count: 24.3%
Forks count: 44.9%
Average: 46.6%
Dependent packages count: 51.6%
Stargazers count: 65.4%
Last synced: 7 months ago

Dependencies

requirements.txt pypi
  • click *
  • joblib *
  • netcdf4 *
  • pyproj *
  • xarray *
.github/workflows/codeql-analysis.yml actions
  • actions/checkout v2 composite
  • github/codeql-action/analyze v1 composite
  • github/codeql-action/autobuild v1 composite
  • github/codeql-action/init v1 composite
.github/workflows/package-conda.yml actions
  • actions/checkout v2 composite
  • actions/setup-python v2 composite
.github/workflows/python-package.yml actions
  • actions/checkout v2 composite
  • actions/setup-python v2 composite
.github/workflows/python-publish.yml actions
  • actions/checkout v2 composite
  • actions/setup-python v2 composite
  • pypa/gh-action-pypi-publish 27b31702a0e7fc50959f5ad993c78deac1bdfc29 composite
setup.py pypi