Skip to main content

Data visualization library for SuperDARN data

Project description

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.2 - Patch Release!

This patch release fixes a bug installing when from PyPI, and corrects the ownership of ADE, ADW, KOD, KSR, MCM, and SPS to Penn State.

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:

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
fitacf_data = pydarn.SuperDARNRead(fitacf_file).read_fitacf()

pydarn.RTP.plot_summary(fitacf_data, 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.

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

pydarn-4.1.2.tar.gz (115.2 kB view details)

Uploaded Source

Built Distribution

pydarn-4.1.2-py3-none-any.whl (145.3 kB view details)

Uploaded Python 3

File details

Details for the file pydarn-4.1.2.tar.gz.

File metadata

  • Download URL: pydarn-4.1.2.tar.gz
  • Upload date:
  • Size: 115.2 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.1.0 CPython/3.11.9

File hashes

Hashes for pydarn-4.1.2.tar.gz
Algorithm Hash digest
SHA256 99695d19b0e4bbf9ec3070146ba6a3d8cbcb1baefd1647e4f94bd7d08c01e7ac
MD5 f0ddedc1028672cfd553559b3758ce75
BLAKE2b-256 c145b8053fc7e49bb0cee4466fdb2d08d39de1642e922ee728c54e7ff1ba81df

See more details on using hashes here.

File details

Details for the file pydarn-4.1.2-py3-none-any.whl.

File metadata

  • Download URL: pydarn-4.1.2-py3-none-any.whl
  • Upload date:
  • Size: 145.3 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.1.0 CPython/3.11.9

File hashes

Hashes for pydarn-4.1.2-py3-none-any.whl
Algorithm Hash digest
SHA256 1f68096d2540db1bd3f68cf8b363fca6c5ff87cde5ec1d2ff53174eb60a795ac
MD5 f4ddef707153b6315ec38ddbb193bc86
BLAKE2b-256 e3aa173e4d8a337d56272cc15f4a29fca93628f0639dd891a4196f91765a3778

See more details on using hashes here.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page