minor maintenance release v0.4.1 (#227)

* Add research notice to readme (#206)
* Update query docstring (#212)
* action to automatically update uml diagrams (#208)
* switch to svg
* update docs with new uml diagrams. Add visualization class to components list
* update action trigger to after approved pull request reviews
* update variable names for clarity and in line with common usage (#211)
  * change 'dataset' to 'product' in core and test code
  * update 'source' input parameter to 'path' in variables module (part of a not-yet-implemented feature).
* tests that require an active NSIDC Earthdata session (#209)
  * NOTE: using the fixture to successfully start a session can be considered the test
* check errors raised by empty query object from bounding box split in openaltimetry visualization (#220)
* updated product_summary_info function to latest fields returned by CMR (product_id --> title) (#218)
* traffic/downloads statistics updates and limit traffic action to parent repo (#221)
* GitHub traffic auto-update to not run traffic action on forks.
* remove extra code block from example notebook (#225)
* populate v0.4.1 changelog and add to index (#226)

Co-authored-by: Yo Yehudi <[email protected]>
Co-authored-by: Whyjay Zheng <[email protected]>
Co-authored-by: Romina Piunno <[email protected]>
Co-authored-by: Tian Li <[email protected]>
Co-authored-by: JP Swinski <[email protected]>

.github/workflows/traffic_action.yml

@@ -12,6 +12,7 @@ jobs:
   traffic:
     # The type of runner that the job will run on
     runs-on: ubuntu-latest
+    if: github.repository_owner == 'icesat2py'
 
     # Steps represent a sequence of tasks that will be executed as part of the job
     steps:

.github/workflows/uml_action.yml

@@ -0,0 +1,32 @@
+name: Update UML diagrams
+on:
+  workflow_dispatch:
+  pull_request_review:
+    types: [submitted]
+
+jobs:
+  diagrams:
+    if: github.event.review.state == 'approved'
+    name: Update UML diagrams
+    runs-on: ubuntu-latest
+    steps:
+      - name: Check out repository
+        uses: actions/checkout@v2
+      - name: set up environment
+        run: |
+          pip install -r requirements.txt
+          pip install icepyx pylint 
+          sudo apt-get install graphviz
+      - name: run pyreverse
+        run: |
+          pyreverse ./icepyx/core -p user_uml -o svg
+          pyreverse ./icepyx/core -f ALL -p dev_uml -o svg
+          rm ./packages_dev_uml.svg
+          mv ./*.svg ./doc/source/user_guide/documentation/
+      - name: Commit changes
+        uses: EndBug/add-and-commit@v4
+        with:
+          author_name: GitHub Action
+          message: "GitHub action UML generation auto-update"
+          add: "./doc/source/user_guide/documentation/*"
+          ref: git branch --show-current

.travis.yml

@@ -28,10 +28,10 @@ stages:
 jobs:
   include:
     - stage: basic tests
-      script: pytest icepyx/ --ignore icepyx/tests/behind_NSIDC_API_login.py
+      script: pytest icepyx/ --ignore icepyx/tests/test_behind_NSIDC_API_login.py
       after_success: codecov
 
-    # - stage: behind Earthdata
-    #   script:
-    #     - export NSIDC_LOGIN=$NSIDC_LOGIN
-    #     - pytest icepyx/tests/behind_NSIDC_API_login.py
+    - stage: behind Earthdata
+      script:
+        - export NSIDC_LOGIN=$NSIDC_LOGIN
+        - pytest icepyx/tests/test_behind_NSIDC_API_login.py

README.rst

@@ -93,3 +93,20 @@ Please note that this project is released with a Contributor Code of Conduct. By
 
 .. |Contributor Covenant| image:: https://img.shields.io/badge/Contributor%20Covenant-v2.0%20adopted-ff69b4.svg
    :target: code_of_conduct.md
+
+Research notice
+~~~~~~~~~~~~~~~
+
+Please note that this repository is participating in a study into
+sustainability of open source projects. Data will be gathered about this
+repository for approximately the next 12 months, starting from June
+2021.
+
+Data collected will include number of contributors, number of PRs, time
+taken to close/merge these PRs, and issues closed.
+
+For more information, please visit `the informational
+page <https://sustainable-open-science-and-software.github.io/>`__ or
+download the `participant information
+sheet <https://sustainable-open-science-and-software.github.io/assets/PIS_sustainable_software.pdf>`__.
+