pydarn

Python library for visualizing SuperDARN Data

https://github.com/superdarn/pydarn

Science Score: 49.0%

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

  • CITATION.cff file
  • codemeta.json file
    Found codemeta.json file
  • .zenodo.json file
    Found .zenodo.json file
  • DOI references
    Found 5 DOI reference(s) in README
  • Academic publication links
    Links to: zenodo.org
  • Academic email domains
  • Institutional organization owner
  • JOSS paper metadata
  • Scientific vocabulary similarity
    Low similarity (15.4%) to scientific vocabulary

Keywords

plots superdarn-data
Last synced: 6 months ago · JSON representation

Repository

Python library for visualizing SuperDARN Data

Basic Info
  • Host: GitHub
  • Owner: SuperDARN
  • License: lgpl-3.0
  • Language: Python
  • Default Branch: develop
  • Homepage:
  • Size: 28.6 MB
Statistics
  • Stars: 35
  • Watchers: 8
  • Forks: 11
  • Open Issues: 11
  • Releases: 14
Topics
plots superdarn-data
Created almost 8 years ago · Last pushed 7 months ago
Metadata Files
Readme License Code of conduct Zenodo

README.md

pydarn

License: LGPL v3 Python 3.6 GitHub release (latest by date) DOI

Python data visualization library for the Super Dual Auroral Radar Network (SuperDARN).

Changelog

Version 4.1.1 - Patch Release!

This patch release includes: - matplotlib v3.10 support (fixed incompatibility) - scipy dependency capped at v1.14.1 - NEW marker and markersize kwargs for pydarn.Fan.plot_radar_position() - NEW pydarn.RadarID enum abstracting away the station ID numbers of each radar

Documentation

pyDARN's documentation can be found here

Getting Started

pip install pydarn

Or read the installation guide.

If wish to get access to SuperDARN data please read the SuperDARN data access documentation. Please make sure to also read the documentation on citing superDARN and pydarn.

As a quick tutorial on using pydarn to read a non-compressed file:

```python import matplotlib.pyplot as plt

import pydarn

read a non-compressed file

fitacf_file = '20190831.C0.cly.fitacf'

pyDARN functions to read a fitacf file

fitacfdata = pydarn.SuperDARNRead(fitacffile).read_fitacf()

pydarn.RTP.plotsummary(fitacfdata, beam_num=2) plt.show() ```

summary plot

For more information and tutorials on pyDARN please see the tutorial section.

We also have a Jupyter notebook with many examples to support our recent publication.

Getting involved

pyDARN is always looking for testers and developers keen on learning python, github, and/or SuperDARN data visualizations! Here are some ways to get started:

  • Testing Pull Request: to determine which pull requests need to be tested right away, filter them by their milestones (v3.0 is currently highest priority).
  • Getting involved in projects: if you are looking to help in a specific area, look at pyDARN's projects tab. The project you are interested in will give you information on what is needed to reach completion. This includes things currently in progress, and those awaiting reviews.
  • Answer questions: if you want to try your hand at answering some pyDARN questions, or adding to the discussion, look at pyDARN's issues and filter by labels.
  • Become a developer: if you want to practice those coding skills and add to the library, look at pyDARN issues and filter by milestone's to see what needs to get done right away.

Please read pyDARN team on how to join the pyDARN team.

Owner

  • Name: SuperDARN
  • Login: SuperDARN
  • Kind: organization

Github for the international Super Dual Auroral Radar Network (SuperDARN) community

GitHub Events

Total
  • Create event: 8
  • Release event: 2
  • Issues event: 9
  • Watch event: 5
  • Delete event: 8
  • Issue comment event: 31
  • Push event: 21
  • Pull request review event: 4
  • Pull request event: 19
Last Year
  • Create event: 8
  • Release event: 2
  • Issues event: 9
  • Watch event: 5
  • Delete event: 8
  • Issue comment event: 31
  • Push event: 21
  • Pull request review event: 4
  • Pull request event: 19

Issues and Pull Requests

Last synced: 6 months ago

All Time
  • Total issues: 5
  • Total pull requests: 11
  • Average time to close issues: 3 months
  • Average time to close pull requests: about 1 month
  • Total issue authors: 4
  • Total pull request authors: 3
  • Average comments per issue: 3.6
  • Average comments per pull request: 0.36
  • Merged pull requests: 10
  • Bot issues: 0
  • Bot pull requests: 0
Past Year
  • Issues: 5
  • Pull requests: 11
  • Average time to close issues: 3 months
  • Average time to close pull requests: about 1 month
  • Issue authors: 4
  • Pull request authors: 3
  • Average comments per issue: 3.6
  • Average comments per pull request: 0.36
  • Merged pull requests: 10
  • Bot issues: 0
  • Bot pull requests: 0
Top Authors
Issue Authors
  • carleyjmartin (11)
  • RemingtonRohel (3)
  • aburrell (1)
  • sapols (1)
  • Yas979 (1)
  • billetd (1)
  • victoriyaforsythe (1)
  • prakas27 (1)
Pull Request Authors
  • carleyjmartin (14)
  • RemingtonRohel (13)
  • billetd (9)
  • ksterne (2)
  • PrestonXPitzer (1)
  • shibaji7 (1)
Top Labels
Issue Labels
enhancement (3) bug (3) refactor (1) good first issue (1) High Priority (1) discussion (1)
Pull Request Labels
enhancement (5) easy PR (3) FIX (3) High Priority (2) Release (1) refactor (1) good first issue (1) Documentation (1)

Packages

  • Total packages: 1
  • Total downloads:
    • pypi 242 last-month
  • Total dependent packages: 0
  • Total dependent repositories: 1
  • Total versions: 15
  • Total maintainers: 5
pypi.org: pydarn

Data visualization library for SuperDARN data

  • Versions: 15
  • Dependent Packages: 0
  • Dependent Repositories: 1
  • Downloads: 242 Last month
  • Docker Downloads: 0
Rankings
Docker downloads count: 4.3%
Dependent packages count: 10.1%
Average: 15.8%
Dependent repos count: 21.6%
Downloads: 27.3%
Last synced: 6 months ago

Dependencies

pyproject.toml pypi