Merge pull request #21 from SuperDARN/release/v1.1

Release pyDARNio v1.1

.github/ISSUE_TEMPLATE/bug_template.md

@@ -0,0 +1,47 @@
+---
+name: Bug Report 
+about: reporting a bug
+---
+
+# BUG 
+
+*description of the bug*
+
+## Priority
+
+- [ ] Minor - typo, incorrect naming, fails on specific uncommon situation
+- [ ] Major - misrepresentation of data, failure in a common situation 
+- [ ] Urgent - failure in usage, large misrepresentation
+
+## Example of the bug 
+
+*please provide **code** and **output** of the bug*
+
+### Attempts
+
+*What have you tried already to fix it?*
+
+*What have you tried to get around it?*
+
+### Data Location
+
+*Please indicate where (and how) to get the data file that was used to obtain the bug.*
+
+## Potential Bug Location 
+
+*Please note this is not required.*
+*If you can link to some code in pyDARNio where you think the bug is coming from this will help the developer fix it sooner.*
+
+## Potential Solution(s)
+
+*Please note this is not required.*
+*If you have some idea of how to fix/improve on the bug then please describe here for possible solution(s).*
+
+## Extra Notes
+
+*Please provide other pertinent details about this feature:*
+- *Operating System*
+- *Python version 3.X.X*
+- *Examples of what the visual output should look like*
+- *Other data files that show the same bug*
+- *How to access data files to test out the bug*

.github/ISSUE_TEMPLATE/deprecation_template.md

@@ -0,0 +1,24 @@
+---
+name: Deprecation 
+about: to suggest removing an option or a feature
+---
+
+# DEPRECATION 
+
+**Feature:**
+
+**Module:**  *python_filename.py*
+
+**package** */directory*
+
+## Reason
+
+*Why should this feature be deprecated?  Possible reasons include being outside of pyDARNio's current scope or being a legacy function that is no longer used.*
+
+## Replacement
+
+*Would anything replace this feature?*
+
+## Details
+
+*Please provide any other details about the deprecation process, such as a timeline for warning the user about the deprecation.*

.github/ISSUE_TEMPLATE/discussion_template.md

@@ -0,0 +1,41 @@
+---
+name: Discussion  
+about: initiate an open discussion with other developers
+---
+
+# Discussion 
+
+**Topic:**
+
+## Description
+
+*Please describe, provide details, and examples for this discussion.*
+
+## Category
+
+- [ ] User-friendly  
+- [ ] Software Design
+- [ ] Data related
+- [ ] Capabilities
+- [ ] Clarity 
+- [ ] Workflow
+
+## Details
+
+*Please provide any other details or description around your question.*
+
+## Example  
+
+*If applicable, fill in one of the following.*
+
+### Code
+
+*Please provide **code** and **output** that the discussion is around.*
+
+### Installation Process 
+
+*Please provide your steps for trying to install pyDARNio.*
+
+### Documentation
+
+*Please link to any documentation or quote the relevant material to request more detailed information on the topic.*

.github/ISSUE_TEMPLATE/documentation_template.md

@@ -0,0 +1,44 @@
+---
+name: Documentation
+about: propose updates to documentation
+---
+
+# Documentation 
+
+*title or suggestion of documentation*
+
+## Purpose
+
+- [ ] update
+- [ ] new 
+- [ ] remove
+- [ ] typo/grammar change
+- [ ] markdown improvement
+
+## Category 
+
+- [ ] code documentation
+- [ ] wiki
+- [ ] README
+- [ ] installation guide
+    - [ ] OS specifics
+    - [ ] dependency
+    - [ ] environment
+- [ ] tutorials
+    - [ ] plotting
+    - [ ] io
+    - [ ] utils/exceptions
+- [ ] examples
+- [ ] citing/licensing
+- [ ] trouble shooting
+    - [ ] installation
+    - [ ] tutorials
+- [ ] history
+- [ ] guidelines
+    - [ ] developer
+    - [ ] communication
+
+## Details
+
+*Please describe and link to any readthedocs/code you are suggesting improvements/changes to be made on.*
+

.github/ISSUE_TEMPLATE/feature_template.md

@@ -0,0 +1,56 @@
+---
+name: New Feature
+about: Notify that a new feature is being planned
+---
+
+# New Feature
+
+**Name**: *Feature name*
+
+**module**:  *potential_filename.py* 
+
+**package**: *which directory it should go in*
+
+## Scope
+
+*Create a check list using markdowns [checklist syntax](https://help.github.com/en/github/managing-your-work-on-github/about-task-lists) on the scope of the feature*
+
+*What will the feature do?*
+
+*What will the feature not do?* 
+
+## Description
+
+*Please provide a description of the new feature and if it will improve or solve a problem.*
+
+### pyDARNio Checklist 
+
+-  [ ] Does this fit within pyDARNio's scope? 
+-  [ ] Is this a minor change i.e., new small utility function?
+-  [ ] Is this a major change i.e., new plotting function?
+-  [ ] Do you need help developing it? 
+-  [ ] Have you created a pyDARNio GitHub [project](https://github.com/SuperDARN/pyDARNio/projects) to show the tasks needed to be done? 
+
+### Development help
+
+*pyDARNio does not have a dedicated development team on hand for full feature development. 
+However, if you are able to provide some time and help, the community will try to aid you in the best way they can to make your feature possible.*
+
+*If you need help please indicate what expertise you are looking for:*
+- [ ] developer help with design and integration of code
+- [ ] scientific help with ensuring what you develop is scientifically correct/accurate
+- [ ] project management to help organize what steps need to be taken to make this possible 
+
+*Please also provide any other information you may need help with, not including testing/reviewers of code*
+
+## User Interface 
+
+*Please provide **pseudocode** on how you see your new feature interacting with the code or user-interface*
+
+## Extra Notes
+
+*Please provide any other details about this feature*
+- *publications*
+- *GitHub link of code in another language or in python*
+- *examples you may have seen that you will like to incorporate - data visuals*
+- *potential solutions to current/future problems*

.github/ISSUE_TEMPLATE/question_template.md

@@ -0,0 +1,38 @@
+---
+name: Question
+about: Ask for help or advice on using RST
+---
+
+# Question
+
+**Question:**
+
+## Category
+
+- [ ] Usage 
+- [ ] Troubleshooting
+- [ ] Software Design
+- [ ] Data related
+- [ ] Capabilities
+- [ ] Clarity 
+- [ ] Workflow
+
+## Details
+
+*Please provide any other details or description around your question.*
+
+## Example  
+
+*If applicable fill in one of the following.*
+
+### Code
+
+*please provide **pseudocode/code** and **output** that the question is associated with.*
+
+### Installation Process 
+
+*Please provide your steps for trying to install pyDARNio.*
+
+### Documentation
+
+*Please link to any documentation or quote the relevant material to request more detailed information on the topic.*

.github/ISSUE_TEMPLATE/release_template.md

@@ -0,0 +1,35 @@
+---
+name: Proposing a Release
+about: propose release to be made 
+---
+
+# Release
+
+**Release number**: v*number*
+
+- [ ] Major - Structural/User interface change
+- [ ] Minor - New feature or Deprecated feature
+- [ ] Patch - bug fixes 
+
+## Scope
+
+*What is the main focus of this release? (e.g. new feature, specific bug fixes, new interface, ...)*
+
+## Propose Deadline
+
+**Date**: *Set a tentative date for the release branch to be made by*
+
+## Pull Requests
+
+**All PRs merged into `develop` will be included in this release**
+
+### Pull Request To Be Included
+
+**Here is a list of PRs/Issues that need to be merged in still before the release**
+*Create a check list using markdowns [checklist syntax](https://help.github.com/en/github/managing-your-work-on-github/about-task-lists) on the Pull Requests that still need to be still merged*
+
+### Pull Requests To not be Included
+
+**Here is a list of PRs/Issues that are not to be merged in before the release branch is released**
+*Create a check list using markdowns [checklist syntax](https://help.github.com/en/github/managing-your-work-on-github/about-task-lists) on the Pull Requests that should not be merged in*
+

.github/pull_request_template.md

@@ -0,0 +1,19 @@
+# Scope 
+
+*Describe the scope of this PR*
+
+**issue:**
+
+## Approval
+
+**Number of approvals:** *number of approvals before one can merge the code*
+
+## Test
+
+*provide a list or code to test*
+
+*Reminder, please check your code is:
+  - copyrighted (if applicable)
+  - Appropriate disclaimer added
+  - Modification line filled in (if applicable)*
+

.zenodo.json

@@ -5,73 +5,35 @@
         },
         {
             "affiliation": "University of Saskatchewan",
-            "name": "Schmidt, M.T.",
-            "orcid": "0000-0002-3265-977X"
+            "name": "Krieger, K.J."
         },
         {
             "affiliation": "University of Saskatchewan",
-            "name": "Billett, D.D.",
-            "orcid": "0000-0002-8905-8609"
-        },
-        {
-            "affiliation": "The University Centre in Svalbard",
-            "name": "Bland, E.C.",
-            "orcid": "0000-0002-0252-0400"
-        },
-        {
-            "affiliation": "US Naval Research Laboratory",
-            "name": "Burrell, A.G.",
-            "orcid": "0000-0001-8875-9326"
+            "name": "Kotyk, K."
         },
         {
             "affiliation": "University of Saskatchewan",
             "name": "Detwiller, M.H."
         },
-        {
-            "affiliation": "The University Centre in Svalbard",
-            "name": "Herlingshaw, K.",
-            "orcid": "0000-0001-6861-1914"
-        },
         {
             "affiliation": "University of Saskatchewan",
-            "name": "Krieger, K."
+            "name": "Billett, D.D.",
+            "orcid": "0000-0002-8905-8609"
         },
         {
-            "affiliation": "University of Saskatchewan",
-            "name": "Kotyk, K."
+            "affiliation": "US Naval Research Laboratory",
+            "name": "Burrell, A.G.",
+            "orcid": "0000-0001-8875-9326"
         },
         {
             "affiliation": "University of Saskatchewan",
             "name": "Martin, C.J.",
             "orcid": "0000-0002-8278-9783"
         },
-        {
-            "affiliation": "University of Saskatchewan", 
-            "name": "Peters, D.GO."
-        },
-        {
-            "affiliation": "SRI International",
-            "name": "Reimer, A.S.",
-            "orcid": "0000-0002-4621-3453"
-        },
-        {
-            "affiliation": "University of Bergen",
-            "name": "Reistad, J.P.",
-            "orcid": "0000-0003-3509-5479" 
-        },
         {
             "affiliation": "University of Saskatchewan",
-            "name": "Roberston, C.R."
-        },
-        {
-            "affiliation": "Virginia Tech",
-            "name": "Sterne, K.T.",
-            "orcid": "0000-0002-1076-0009"
-        },
-        {
-            "affiliation": "Dartmouth College",
-            "name": "Thomas, E.G.",
-            "orcid": "0000-0001-8036-8793"
+            "name": "Schmidt, M.T.",
+            "orcid": "0000-0002-3265-977X"
         }
     ]
 }