RC v0.0.4

.github/ISSUE_TEMPLATE/bug_report.md

@@ -0,0 +1,29 @@
+---
+name: Bug report
+about: Create a report to report a problem that needs to be fixed
+labels: bug
+title: "BUG: "
+
+---
+
+# Description
+A clear and concise description of what the bug is, including a description
+of what you expected the outcome to be.
+
+# To Reproduce this bug:
+Steps to reproduce the behavior:
+1. Go to '...'
+2. Click on '....'
+3. Scroll down to '....'
+4. See error
+
+Consider including images or test files to help others reproduce the bug and
+solve the problem.
+
+## Test configuration
+ - OS: [e.g. Hal]
+ - Version [e.g. Python 3.47]
+ - Other details about your setup that could be relevant
+
+# Additional context
+Add any other context about the problem here.

.github/ISSUE_TEMPLATE/feature_request.md

@@ -0,0 +1,27 @@
+---
+name: Feature request
+about: Suggest an idea for this project
+title: "ENH: "
+labels: enhancement
+
+---
+
+# Description
+A clear and concise description of the new feature or behaviour you would like.
+
+## Potential impact
+
+- Is the feature related to an existing problem?
+- How critical is this feature to your workflow?
+- How wide of an impact to you anticipate this enhancement having?
+- Would this break any existing functionality?
+
+## Potential solution(s)
+A clear and concise description of what you want to happen.
+
+# Alternatives
+A clear description of any alternative solutions or features you've considered.
+
+# Additional context
+Add any other context or screenshots about the feature request here, potentially
+including your operational configuration.

.github/ISSUE_TEMPLATE/question.md

@@ -0,0 +1,19 @@
+---
+name: Question
+about: A question about this project
+title: "QUEST: "
+labels: question
+
+---
+
+# Description
+A clear and concise summary of your query
+
+## Example code (optional)
+If relevant, include sample code, images, or files so that others can understand
+the full context of your question.
+
+## Configuration
+ - OS: [e.g. Hal]
+ - Version [e.g. Python 3.47]
+ - Other details about your setup that could be relevant

.github/pull_request_template.md

@@ -0,0 +1,53 @@
+# Description
+
+Addresses # (issue)
+
+Please include a summary of the change and which issue is fixed. Please also
+include relevant motivation and context. List any dependencies that are required
+for this change.  Please see ``CONTRIBUTING.md`` for more guidelines.
+
+# Type of change
+
+Please delete options that are not relevant.
+
+- Bug fix (non-breaking change which fixes an issue)
+- New feature (non-breaking change which adds functionality or documentation)
+- Breaking change (fix or feature that would cause existing functionality
+      to not work as expected)
+- This change requires a documentation update
+
+# How Has This Been Tested?
+
+Please describe the tests that you ran to verify your changes. Provide
+instructions so we can reproduce the problem and the solution. Including images
+or test files is frequently very useful.  Please also list any relevant details
+for your test configuration.
+
+- Test A
+
+```
+Test B
+```
+
+## Test Configuration
+* Operating system: Hal
+* Version number: Python 3.X
+* Any details about your local setup that are relevant
+
+# Checklist:
+
+- [ ] Make sure you are merging into the ``develop`` (not ``main``) branch
+- [ ] My code follows the style guidelines of this project
+- [ ] I have performed a self-review of my own code
+- [ ] I have linted the files updated in this pull request
+- [ ] I have commented my code, particularly in hard-to-understand areas
+- [ ] I have made corresponding changes to the documentation
+- [ ] My changes generate no new warnings
+- [ ] I have added tests that prove my fix is effective or that my feature works
+- [ ] New and existing unit tests pass locally with my changes
+- [ ] Any dependent changes have been merged and published in downstream modules
+- [ ] Add a note to ``CHANGELOG.md``, summarizing the changes
+
+If this is a release PR, replace the first item of the above checklist with the
+release checklist on the pysat wiki:
+https://github.com/pysat/pysat/wiki/Checklist-for-Release

.gitignore

@@ -26,6 +26,7 @@ var/
 *.egg-info/
 .installed.cfg
 *.egg
+.build
 
 # PyInstaller
 #  Usually these files are written by a python script from a template

.travis.yml

@@ -1,10 +1,16 @@
 language: python
 dist: xenial
-matrix:
+jobs:
   include:
-    - python: 3.6
-    - python: 3.7
-    - python: 3.8
+    - name: '3.7 with flake8'
+      python: '3.7'
+      script:
+          - flake8 . --count --select=E,F,W
+          - pytest --cov=pysatMadrigal/
+    - python: '3.8'
+      script: pytest --cov=pysatMadrigal/
+    - python: '3.9'
+      script: pytest --cov=pysatMadrigal/
 
 services: xvfb
 cache: pip
@@ -15,42 +21,16 @@ addons:
     - gfortran
     - libncurses5-dev
 
-install:
-  - sudo apt-get update
-  # We do this conditionally because it saves us some downloading if the
-  # version is the same.
-  - wget https://repo.continuum.io/miniconda/Miniconda3-latest-Linux-x86_64.sh -O miniconda.sh
-  - bash miniconda.sh -b -p $HOME/miniconda
-  - source "$HOME/miniconda/etc/profile.d/conda.sh"
-  - hash -r
-  - conda config --set always_yes True --set changeps1 False
-  - conda update -q conda
-  # Useful for debugging any issues with conda
-  - conda info -a
-  # Create conda test environment
-  - conda create -q -n test-environment python=$TRAVIS_PYTHON_VERSION numpy scipy pandas xarray requests beautifulsoup4 lxml netCDF4 h5py pytest-cov pytest-ordering coveralls future
-  - conda activate test-environment
-  # Dependencies not available through conda, install through pip
-  - pip install pytest-flake8
-  - pip install madrigalWeb
-  - pip install PyForecastTools
-  - pip install pysatCDF >/dev/null
-  # Custom pysat install
-  - cd ..
-  - git clone https://github.com/pysat/pysat.git
-  - cd pysat
-  - git checkout develop-3
-  - python setup.py install
-  - export PYTHONPATH=$PYTHONPATH:$(pwd)
+before_install:
+  - python -m pip install --upgrade pip
+  # Get the program and testing requirements
+  - pip install -r test_requirements.txt
+  - pip install -r requirements.txt
   # set up data directory
   - mkdir /home/travis/build/pysatData
-  - cd ../pysatMadrigal
-  # install pysatMadrigal
+  - python -c "import pysat; pysat.params['data_dirs'] = '/home/travis/build/pysatData'"
+install:
   - python setup.py install
 
-# command to run tests
-script:
- - pytest -vs --cov=pysatMadrigal/ --flake8
-
 after_success:
- - coveralls
+ - coveralls --rcfile=setup.cfg

.zenodo.json

@@ -0,0 +1,37 @@
+{
+    "keywords": [
+      "satellite", 
+      "radar", 
+      "Madrigal", 
+      "DMSP", 
+      "pysat", 
+      "JRO", 
+      "Jicamarca Radio Observatory", 
+      "TEC", 
+      "Total Electron Content", 
+      "Ionosphere",
+      "Space Physics", 
+      "Heliophysics"
+    ], 
+    "creators": [
+      {
+        "affiliation": "U.S. Naval Research Laboratory", 
+        "name": "Burrell, Angeline G.",
+        "orcid": "0000-0001-8875-9326"
+      }, 
+      {
+        "affiliation": "Goddard Space Flight Center",
+        "name": "Klenzing, Jeff",
+        "orcid": "0000-0001-8321-6074"
+      }, 
+      {
+        "affiliation": "The University of Texas at Dallas", 
+        "name": "Stoneback, Russell",
+        "orcid": "0000-0001-7216-4336"  
+      }, 
+      {
+        "affiliation": "Predictive Science", 
+        "name": "Pembroke, Asher"
+      }
+    ]
+}

CHANGELOG.md

@@ -0,0 +1,36 @@
+# Change Log
+All notable changes to this project will be documented in this file.
+This project adheres to [Semantic Versioning](https://semver.org/).
+
+## [0.0.4] - 2021-06-11
+- Made changes to structure to comply with updates in pysat 3.0.0
+- Deprecations
+  - Restructed Instrument methods, moving `madrigal` to `general` and extracting
+    local methods from the instrument modules to platform-specific method files
+  - Cycled testing support to cover Python 3.7-3.9
+- Enhancements
+  - Added coords from pysat.utils
+  - Added Vertical TEC Instrument
+  - Added documentation
+  - Added load routine for simple formatted data
+  - Expanded feedback during data downloads
+  - Updated documentation configuration to improve maintainability
+  - Updated documentation style, displaying logo on sidebar in html format
+  - Changed zenodo author name format for better BibTeX compliance
+  - Updated CONTRIBUTING and README information
+- Bug Fix
+  - Updated Madrigal methods to simplify compound data types and enable
+    creation of netCDF4 files using `Instrument.to_netcdf4()`
+  - Updated load for multiple files in pandas format
+  - Fixed remote listing routine to return filenames instead of experiments
+  - Fixed bug introduced by change in xarray requiring engine kwarg
+  - Fixed bug that would not list multiple types of files
+
+## [0.0.3] - 2020-06-15
+- pypi compatibility
+
+## [0.0.2] - 2020-05-13
+- zenodo link
+
+## [0.0.1] - 2020-05-13
+- Alpha release

CODE_OF_CONDUCT.md

@@ -0,0 +1,75 @@
+# Contributor Covenant Code of Conduct
+
+## Our Pledge
+
+In the interest of fostering an open and welcoming environment, we as
+contributors and maintainers pledge to making participation in our project and
+our community a harassment-free experience for everyone, regardless of age,
+body size, disability, ethnicity, gender identity and expression, level of
+experience, nationality, personal appearance, race, religion, or sexual
+identity and orientation.
+
+## Our Standards
+
+Examples of behavior that contributes to creating a positive environment
+include:
+
+* Using welcoming and inclusive language
+* Being respectful of differing viewpoints and experiences
+* Gracefully accepting constructive criticism
+* Focusing on what is best for the community
+* Showing empathy towards other community members
+
+Examples of unacceptable behavior by participants include:
+
+* The use of sexualized language or imagery and unwelcome sexual attention or
+  advances
+* Trolling, insulting/derogatory comments, and personal or political attacks
+* Public or private harassment
+* Publishing others' private information, such as a physical or electronic
+  address, without explicit permission
+* Other conduct which could reasonably be considered inappropriate in a
+  professional setting
+
+## Our Responsibilities
+
+Project maintainers are responsible for clarifying the standards of acceptable
+behavior and are expected to take appropriate and fair corrective action in
+response to any instances of unacceptable behavior.
+
+Project maintainers have the right and responsibility to remove, edit, or
+reject comments, commits, code, wiki edits, issues, and other contributions
+that are not aligned to this Code of Conduct, or to ban temporarily or
+permanently any contributor for other behaviors that they deem inappropriate,
+threatening, offensive, or harmful.
+
+## Scope
+
+This Code of Conduct applies both within project spaces and in public spaces
+when an individual is representing the project or its community. Examples of
+representing a project or community include using an official project e-mail
+address, posting via an official social media account, or acting as an
+appointed representative at an online or offline event. Representation of a
+project may be further defined and clarified by project maintainers.
+
+## Enforcement
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be
+reported by contacting the project team at pysat.developers@gmail.com. The
+project team will review and investigate all complaints, and will respond in a
+way that it deems appropriate to the circumstances. The project team is
+obligated to maintain confidentiality with regard to the reporter of an
+incident. Further details of specific enforcement policies may be posted
+separately.
+
+Project maintainers who do not follow or enforce the Code of Conduct in good
+faith may face temporary or permanent repercussions as determined by other
+members of the project's leadership.
+
+## Attribution
+
+This Code of Conduct is adapted from the [Contributor Covenant][homepage],
+version 1.4, available at [https://contributor-covenant.org/version/1/4][version]
+
+[homepage]: https://contributor-covenant.org
+[version]: https://contributor-covenant.org/version/1/4/