release 0.3.2 (icesat2py#155)

* note authentication settings

* Validate input numpy (icesat2py#105): numpy scalars now available for the case where the spatial extent consists of a polygon and it is given by a single list

* update travis trigger to deal with fork PRs

* add current path to pip install -e option (icesat2py#129)

* Adding Phyto team contributors (icesat2py#139)

* add icepyx usage tracking (tools and docs) (icesat2py#150)

* Added a publication to icepyx_pubs.bib (icesat2py#152)

* removed normal proj references due to DAAC change in capabilities.xml  (icesat2py#153)

* add changelog for bug fix release (icesat2py#154)

Co-authored-by: Facundo Sapienza <[email protected]>
Co-authored-by: Anthony Arendt <[email protected]>
Co-authored-by: Kelsey Bisson <[email protected]>
Co-authored-by: Romina <[email protected]>
Co-authored-by: mollymwieringa <[email protected]>
Co-authored-by: ted maksym <[email protected]>
Co-authored-by: Molly <[email protected]>
Co-authored-by: nabib <[email protected]>
Co-authored-by: alexdibella <[email protected]>
Co-authored-by: Tian Li <[email protected]>
Co-authored-by: Amy Steiker <[email protected]>

Author: 11 people

.github/workflows/traffic_action.yml

@@ -0,0 +1,35 @@
+# temporarily store GitHub traffic data
+# from: https://github.com/marketplace/actions/repository-traffic
+on:
+  schedule: 
+    # runs once a week on sunday
+    - cron: "55 23 * * 0"
+
+jobs:
+  # This workflow contains a single job called "traffic"
+  traffic:
+    # The type of runner that the job will run on
+    runs-on: ubuntu-latest
+
+    # Steps represent a sequence of tasks that will be executed as part of the job
+    steps:
+    # Checks-out your repository under $GITHUB_WORKSPACE, so your job can access it
+    # DevGoal: figure out how to put the traffic data directly into doc/source/tracking
+    - uses: actions/checkout@v2
+      with:
+        ref: "traffic"
+    
+    # Calculates traffic and clones and stores in CSV file
+    - name: GitHub traffic 
+      uses: sangonzal/[email protected]
+      env:
+        TRAFFIC_ACTION_TOKEN: ${{ secrets.TRAFFIC_ACTION_TOKEN }} 
+     
+    # Commits files to repository
+    - name: Commit changes
+      uses: EndBug/add-and-commit@v4
+      with:
+        author_name: Jessica Scheick
+        message: "GitHub traffic"
+        add: "./traffic/*"
+        ref: "traffic"  # commits to branch "traffic"

.gitignore

@@ -116,4 +116,10 @@ venv.bak/
 *.hdf5
 *.csv
 *.zarr
-*.tif
+*.tif
+
+# data file exception for tracking info
+!clones.csv
+!views.csv
+!downloads_data.csv
+!sys_downloads_data.csv

.travis.yml

@@ -6,7 +6,7 @@ install:
 
 stages:
   - name: basic tests
-    if: type = push OR type = pull_request
+    if: (type = pull_request) OR (type = push AND repo = icesat2py/icepyx AND branch IN (master, development))
   - name: behind Earthdata
     if: branch = master OR commit_message =~ nsidc_tests OR type = cron
 
@@ -32,6 +32,8 @@ deploy:
       if: commit_message =~ test_pypi
     skip_existing: true
     distributions: "sdist bdist_wheel"
+
+# NOTE: the API token on Travis must be set to ALL branches, because a tag build is not considered to be on the master branch: https://travis-ci.community/t/pypi-upload-with-api-token-not-working/5338/5
   - provider: pypi
     username: "__token__"
     password: $PyPI_API_Token

CONTRIBUTORS.rst

@@ -4,17 +4,24 @@ Project Contributors
 The following people have made contributions to the project (in alphabetical
 order by last name) and are considered "The icepyx Developers":
 
+* `Nicole Abib <https://github.com/nabib/>`_ - University of Oregon
 * `Anthony Arendt <https://github.com/aaarendt/>`_ - University of Washington
+* `Kelsey Bisson <https://github.com/kelseybisson>`_ - Oregon State University
 * `Shashank Bhushan <https://github.com/ShashankBice>`_ - University of Washington
+* `Alessandro Di Bella <https://github.com/alexdibella>`_ - Technical University of Denmark
 * `Raphael Hagen <https://github.com/norlandrhagen>`_ - University of Washington
 * `Scott Henderson <https://github.com/scottyhq>`_ - University of Washington
 * `Thomas Johnson <https://github.com/loudTom>`_ - University College London
 * `Zheng Liu <https://github.com/liuzheng-arctic>`_ - University of Washington
+* `Ted Maksym <https://github.com/tedmaksym>`_ - Woods Hole Oceanographic Institution
 * `Joachim Meyer <https://github.com/jomey>`_ - University of Utah
 * `Fernando Perez <https://github.com/fperez>`_ - University of California, Berkeley
+* `Romina Piunno <https://github.com/RomiP>`_ - University of Toronto
+* `Facundo Sapienza <https://github.com/facusapienza21>`_ - University of California, Berkeley
 * `Jessica Scheick <https://github.com/jessicas11>`_ - Unaffiliated (ORCID: `0000-0002-3421-4459 <https://www.orcid.org/0000-0002-3421-4459>`_)
 * `David Shean <https://github.com/dshean>`_ - University of Washington
 * `Ben Smith <https://github.com/smithb>`_ - University of Washington
 * `Amy Steiker <https://github.com/asteiker>`_ - NSIDC, University of Colorado
-* `Bidhyananda Yadav <https://github.com/bidhya>`_ - Ohio State University
 * `Anna Valentine <https://github.com/annavalentine>`_ - Colorado School of Mines
+* `Molly Wieringa <https://github.com/mollymwieringa>`_ - University of Washington
+* `Bidhyananda Yadav <https://github.com/bidhya>`_ - Ohio State University

README.rst

@@ -63,7 +63,7 @@ Alternatively, in a command line or terminal, navigate to the folder in your clo
 
 .. code-block::
 
-  pip install -e
+  pip install -e .
 
 
 Future developments of icepyx may include conda as another simplified installation option.

doc/source/community/resources.rst

@@ -10,7 +10,7 @@ Resources Used in the Initial Development of icepyx
 ---------------------------------------------------
 
 First ICESat-2 Cryospheric Hackweek at the University of Washington (June 2019)
-^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
+^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
 This June 2019 event resulted in the production of a series of `tutorials <https://github.com/ICESAT-2HackWeek/ICESat2_hackweek_tutorials>`_, developed primarily by members of the ICESat-2 Science Team and early data users, aimed at educating the cryospheric community in obtaining and using ICESat-2 datasets. During the actual Hackweek, teams of researchers and data scientists developed a series of interesting `projects <https://github.com/ICESAT-2HackWeek/projects_2019>`_ related to their interests/research. 
 
 The available tutorials, most of which contain one or more Jupyter Notebooks to illustrate concepts, are listed below. Additional information for citing (including licensing) and running (e.g. through a Pangeo Binder) these tutorials can be found at the above link.

doc/source/conf.py

@@ -39,6 +39,7 @@
     "nbsphinx",
     "recommonmark",
     "contributors",  # custom extension, from pandas
+    "sphinxcontrib.bibtex",
 ]
 
 source_suffix = {
@@ -97,4 +98,36 @@
 
 
 def setup(app):
-    app.add_stylesheet("style.css")
+    #     app.add_stylesheet("style.css")
+    app.add_css_file("style.css")
+
+
+# this should possibly be moved to the sphinxext directory as a standalone .py file
+# -- custom style for pybtex output -------------------------------------------
+from pybtex.style.formatting.unsrt import Style as UnsrtStyle
+from pybtex.style.labels.alpha import LabelStyle as AlphaLabelStyle
+from pybtex.plugin import register_plugin
+
+# I seem to be unable to figure out how to control what is used for the label. It would
+# make sense if it were fed into this function, which then just formatted it, but I can't figure out from where
+# class MyLabel(AlphaLabelStyle):
+#     def format_label(self, entry):
+# #         return entry.fields.get('comment')
+#         return entry.key
+
+
+class MyStyle(UnsrtStyle):
+    name = "mystyle"
+    default_name_style = "lastfirst"  # 'lastfirst' or 'plain'
+    #     default_label_style = "mylabel"  # 'number' or 'alpha'
+    default_sorting_style = "author_year_title"  # 'none' or 'author_year_title'
+
+    def __init__(self, *args, **kwargs):
+        super(MyStyle, self).__init__(*args, **kwargs)
+
+
+#         self.label_style = MyLabel()
+#         self.format_labels = self.label_style.format_label
+
+# register_plugin("pybtex.style.labels", "mylabel", MyLabel)
+register_plugin("pybtex.style.formatting", "mystyle", MyStyle)

doc/source/index.rst

@@ -43,4 +43,5 @@ icepyx is both a software library and a community composed of ICESat-2 data user
    :caption: Community and Resources
 
    community/resources
-   community/contact
+   community/contact   
+   tracking/tracking

doc/source/tracking/icepyx_pubs.bib

@@ -0,0 +1,53 @@
+@misc{2020_IS2-HW-tutorials,
+  author       = {Arendt, Anthony and
+  		 Scheick, Jessica and
+                  Shean, David and
+                  Buckley, Ellen and
+                  Grigsby, Shane and
+                  Haley, Charley and
+                  Heagy, Lindsey and
+                  Mohajerani, Yara and
+                  Neumann, Tom and
+                  Nilsson, Johan and
+                  Markus, Thorsten and
+                  Paolo, Fernando S. and
+                  Perez, Fernando and
+                  Petty, Alek and
+                  Schweiger, Axel and
+                  Smith, Benjamin and
+                  Steiker, Amy and
+                  Alvis, Sebastian and
+                  Henderson, Scott and
+                  Holschuh, Nick and
+                  Liu, Zheng and
+                  Sutterly, Tyler},
+  title        = {2020 {ICESat-2 Hackweek Tutorials}},
+  month        = aug,
+  year         = 2020,
+  publisher    = {Zenodo},
+  version      = {1.0.0},
+  doi          = {10.5281/zenodo.3966463},
+  url          = {https://doi.org/10.5281/zenodo.3966463},
+ comment	= {tutorials}
+}
+
+@misc{js2019agu,
+author = {Scheick, J and Arendt, A and Heagy, L and Perez, F},
+note = {Abstract and poster. American Geophysical Union Fall Meeting, San Francisco, California, USA. 9-13 December 2019.},
+title = {{Introducing} icepyx, an open source {Python} library for obtaining and working with {ICESat-2} data},
+year = {2019},
+comment = {abstract,poster},
+doi = {10.1002/essoar.10501423.1},
+}
+
+@Article{tc-14-3629-2020,
+AUTHOR = {Li, T. and Dawson, G. J. and Chuter, S. J. and Bamber, J. L.},
+TITLE = {Mapping the grounding zone of Larsen~C Ice Shelf, Antarctica, from ICESat-2 laser altimetry},
+JOURNAL = {The Cryosphere},
+VOLUME = {14},
+YEAR = {2020},
+NUMBER = {11},
+PAGES = {3629--3643},
+URL = {https://tc.copernicus.org/articles/14/3629/2020/},
+DOI = {10.5194/tc-14-3629-2020}
+}