Radar Software Toolkit

The Radar Software Toolkit (RST) is maintained by the SuperDARN Data Analysis Working Group (DAWG). For general information and updates from the DAWG, visit our website.

Documentation

RST’s documentation is currently hosted on two sites:

• RST readthedocs includes the installation guide, RST Tutorials, and SuperDARN data formats:
  https://radar-software-toolkit-rst.readthedocs.io/en/latest/
• RST API documentation includes the software structure and binary command line description and options:
  https://superdarn.github.io/rst/

Installation

Installation guide for:

• Linux
• MacOSX
• Windows yet to be implemented

How to cite the RST

Instructions for citing the RST are available on Zenodo. Scroll to the end of the page and choose your perferred citation format.

Data access and usage policy

SuperDARN data are published on FRDR in the rawacf/dat format. These data are licensed under the Creative Commons Attribution-NonCommercial 4.0 (CC BY-NC 4.0) license.

Please read the SuperDARN data policy when downloading data from FRDR.

For all usage of SuperDARN data, users are asked to include the following standard acknowledgement text:

The authors acknowledge the use of SuperDARN data. SuperDARN is a collection of radars funded by national scientific funding agencies of Australia, Canada, China, France, Italy, Japan, Norway, South Africa, United Kingdom and the United States of America.

When data from an individual radar or radars are used, users must contact the principal investigator(s) of those radar(s) to obtain the appropriate acknowledgement information and to offer collaboration, where appropriate. PI contact information can be found here.

For more information, please read citing SuperDARN data.

Contribute to the RST

The DAWG welcomes new testers and developers to join the team. Here are some ways to contribute:

• Test pull requests: to determine which pull requests need to be tested right away, filter them by their milestones
• Discuss issues and answer questions
• Become a developer: if you would like to contribute code to the RST, please submit a new issue on Github, or contact us at darn-dawg at isee dot nagoya-u dot ac dot jp.