Metadata-Version: 2.1
Name: pydarn
Version: 1.0.0.1
Summary: Data visualization library for SuperDARN data
Home-page: https://github.com/SuperDARN/pydarn.git
Author: SuperDARN
License: UNKNOWN
Description: ![pydarn](https://raw.githubusercontent.com/SuperDARN/pydarn/master/docs/imgs/pydarn_logo.png)
        
        [![License: GPL v3](https://img.shields.io/badge/License-GPLv3-blue.svg)](https://www.gnu.org/licenses/gpl-3.0) [![Python 3.6](https://img.shields.io/badge/python-3.6-blue.svg)](https://www.python.org/downloads/release/python-360/) [![GitHub version](https://badge.fury.io/gh/boennemann%2Fbadges.svg)](http://badge.fury.io/gh/boennemann%2Fbadges)
        [![DOI](https://zenodo.org/badge/DOI/10.5281/zenodo.3727270.svg)](https://doi.org/10.5281/zenodo.3727270)
        
        Python data visualization library for the Super Dual Auroral Radar Network (SuperDARN).
        
        ## Changelog
        
        ## Version 1.0 - Release!
        
        pyDARN is released! Included are the following features:
        - Reading and writing DMap format IQDAT, RAWACF, FITACF, GRID/GRD and MAP files
        - Reading and writing HDF5 format files for Borealis radar data, as well as conversion to and from DMap format
        - Range-time parameter style plots for RAWACF and FITACF files
        - Summary plots for RAWACF and FITACF files
        - Time series plots for RAWACF and FITACF files
        
        ## Documentation
        
        pyDARN's documentation can found [here](https://pydarn.readthedocs.io/en/latest)
        
        ## Getting Started
        
        
        `pip install pydarn`
        
        Or read the [installation guide](https://pydarn.readthedocs.io/en/latest/user/install/).
        
        If wish to get access to SuperDARN data please read the [SuperDARN data access documentation](https://pydarn.readthedocs.io/en/latest/user/superdarn_data/).
        Please make sure to also read the documentation on [**citing superDARN and pydarn**](https://pydarn.readthedocs.io/en/latest/user/citing/). 
        
        As a quick tutorial on using pydarn to read a non-compressed file: 
        ```python
        import pydarn 
        
        # read a non-compressed file
        fitacf_file = '20180220.C0.rkn.stream.fitacf'
        
        # pyDARN functions to read a fitacf file
        reader = pydarn.SDarnRead(fitacf_file)
        records = reader.read_fitacf()
        ```
        
        or to read a compressed file:
        ``` python
        import bz2
        import pydarn 
        
        # read in compressed file
        fitacf_file = '20180220.C0.rkn.stream.fitacf.bz2'
        with bz2.open(fitacf_file) as fp: 
              fitacf_stream = fp.read()
        
        # pyDARN functions to read a fitacf file stream
        reader = pydarn.SDarnRead(fitacf_stream, True)
        records = reader.read_fitacf()
        ```
        
        For more information and tutorials on pyDARN please see the [tutorial section](https://pydarn.readthedocs.io/en/latest/)
        
        ## 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](https://github.com/SuperDARN/pydarn/pulls) need to be tested right away, filter them by their milestones (v1.1.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](https://github.com/SuperDARN/pydarn/projects). 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](https://github.com/SuperDARN/pydarn/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](https://github.com/SuperDARN/pydarn/issues) and filter by milestone's to see what needs to get done right away. 
        
        Please contact the leading developer, Marina Schmidt (marina.t.schmidt@gmail.com), if you would like to become a member of the team!
        
Platform: UNKNOWN
Classifier: Development Status :: 5 - Production/Stable
Classifier: License :: OSI Approved :: GNU General Public License v3 (GPLv3)
Classifier: Programming Language :: Python :: 3.6
Classifier: Programming Language :: Python :: 3.7
Requires-Python: >=3.6
Description-Content-Type: text/markdown
