Next steps for release 0.3.0

Author: jr3cermak

conda/slow_bootstrap.sh

@@ -1,5 +1,5 @@
 # Use this technique to slowly bootstrap
-# an environment.  
+# an environment.
 # conda create -y -q -n gridTools python==3.7.10
 # conda activate gridTools
 conda install -q -y geoviews=1.9.1

docs/development/CHANGELOG.md

@@ -1,8 +1,12 @@
 # Changelog
 
+# 2021-07-10
+
+ - Working through deployment checklist.
+
 # 2021-07-09
 
- - For UAF/chinook with old glibc, it is best to bootstrap with python and 
+ - For UAF/chinook with old glibc, it is best to bootstrap with python and
    geoviews up front and then load all the other packages.  All examples
    and editors work.
 

docs/development/ImportantReferences.md

@@ -155,3 +155,11 @@
 
  * ParaView
    * https://www.paraview.org/gallery/
+
+ * Julia: https://julialang.org/
+   - faster and interchangeable between python and julia and julia and python
+   - already integrated into the jupyter notebook framework
+
+ * Pyston: https://github.com/pyston/pyston
+   - 30% speed improvement over Python
+

docs/development/TODO.md

@@ -28,8 +28,7 @@
 
 # BUGS
 
- - [ ] latitude is not reliably reproduced between platforms; other
-       fields show reproducibility.
+ - [ ] Investigate reliably of produced grids between platforms
  - [ ] A nested dictionary will clobber other nested elements instead
        of updating elements.  Recode `setPlotParameters` and
        `setGridParameters` to recursively update dictionary elements.
@@ -67,7 +66,7 @@
      - [X] convert lon [+0,+360] to [-180,+180]
      - [ ] Unify code that adjusts lon (PR#1)
    - [ ] Verify unification of radius (R) throughout code
- - [ ] grid mask editor (land, etc)
+ - [ ] grid mask editor (ocean, etc)
      - [X] needs upgrade from basemap()
      - [X] create an editor that works in jupyter
      - [ ] add routines for mask checking
@@ -79,7 +78,7 @@
        - [ ] show outline of full grid
        - [ ] show other underlying fields - topo?
        - [ ] ROMS: write edited mask
-       - [ ] MOM6: write edited mask
+       - [X] MOM6: write edited mask
      - [ ] ipython --pylab
        - [ ] MOM6: Obey `MASKING_DEPTH`, `MINIMUM_DEPTH`, `ALLOW_LANDMASK_CHANGES`,
              `MAXIMUM_DEPTH`, `TOPO_EDITS_FILE` MOM6/src/initialization parameters
@@ -89,6 +88,7 @@
          - [ ] grids.roms.ROMS_gridinfo._get_grid_info()
        - [ ] show other underlying fields - topo?
        - [ ] MOM6: write edited mask
+       - [X] ROMS: write edited mask
  - [ ] integration of data sources
    - [ ] generic regridder for creating boundary files (OBCs) from data sources
    - [ ] xesmf regridder for bathymetry sources
@@ -112,13 +112,9 @@
    - [ ] Implement `TOPO_EDITS_FILE` in bathytools.applyExistingLandMask()
    - [ ] Implement `TOPO_EDITS_FILE` in bathytools.applyExistingOceanMask()
    - [ ] Check depth points for values that exceed `MAXIMUM_DEPTH`
- - [ ] improve reproducibility
-   - [X] include a dump of conda environment in the grid file (nc)
-   - [X] add sha256 to grid and variable arrays
-   - [ ] if conda environment does not exist, do some other snooping
  - [ ] Add option to use numpypi package (Alistair) as a configurable
        option in gridtools
- - [X] add datashader and numpypi from github sources; see postBuild script
+ - [X] add xesmf and numpypi from github sources; see postBuild script
    - [ ] implement and document in application
    - [ ] implement and document for programming use
  - [ ] on load of a grid into gridtool library
@@ -217,11 +213,10 @@
    - [ ] Try ETOPO2
      - REF: https://data1.gfdl.noaa.gov/~arl/pubrel/r/mom4p1/src/mom4p1/doc/mosaic_tool.html
      - REF: https://github.com/NOAA-GFDL/FRE-NCtools/issues/35
- - [ ] Investigate the differences between FRE-NCtools vs gridutils.  Are
-       there things that we could use there instead of recreating many wheels.
-       There are lot of FRE-NCtool references in the ROMS to MOM6
-       conversion tool.
- - [ ] Migrate to use of file:// or http://, https:// for file specifications.
+   - [ ] Investigate the differences between FRE-NCtools vs gridutils.  Are
+         there things that we could use there instead of recreating many wheels.
+         There are lot of FRE-NCtool references in the ROMS to MOM6
+         conversion tool.
  - [ ] Allow gridtools to continue to operate with some disabled
        routines that use xesmf.
  - [ ] app:Save remote files; additional sanity checks
@@ -297,11 +292,3 @@
 
  - [ ] ntiles,1 is written in `write_MOM6_topography_file`, is this
        required for MOM6?
-
-# FOLLOWING
-
- - [ ] julia: https://julialang.org/
-   - faster and interchangeable between python and julia and julia and python
-   - already integrated into the jupyter notebook framework
- - [ ] pyston: https://github.com/pyston/pyston
-   - 30% speed improvement over Python

docs/development/archive/0.2.0.md

@@ -1,8 +1,8 @@
 # Retired TODO and Milestones
 
 ## Release 0.2.0
- * TBD
- * June XX, 2021
+ * https://github.com/ESMG/gridtools/commit/9c1c9fd89808cbe9481b3c4335119a7c93827e68
+ * June 22, 2021
 
 ### Milestones
 

docs/development/archive/0.3.0.md

@@ -0,0 +1,26 @@
+# Retired TODO and Milestones
+
+## Release 0.3.0
+ * https://github.com/ESMG/gridtools/commit/....
+ * July xx, 2021
+
+### Milestones
+
+ - [X] Release 0.3
+    - [X] Jupyter version of mask editor
+    - [X] Improve mask editor speed for each click using adaptive subgrids
+    - [X] Apply edited land or ocean mask to existing bathy grid
+    - [X] Rewrite mosaic files based on new bathymetry
+
+### TODOs
+
+ - [X] pylab: write edited ROMS grid
+ - [X] jupyter: write edited MOM6 grid
+ - [X] option to create ocean mask fraction
+ - [X] improved netcdf metadata software descriptions
+   - [X] include a dump of conda environment in the grid file (nc)
+   - [X] add sha256 to grid and variable arrays
+   - [X] if conda environment does not exist, do some other snooping
+
+### BUGS
+

docs/development/releases/0.3.0.md

@@ -7,7 +7,7 @@ Minor updates after tag: `a9f9a893d003e9e7b2a0b66ddb7cdaedc0c2668c`
 
 # Checklist
 
- - [ ] Operating system checks
+ - [X] Operating system checks
  	- [X] `x86_64`: Ubuntu 20.04.2 LTS (64 GB)
  	- [ ] `x86_64`: Ubuntu 20.04.2 LTS (12 GB VM)
         - [X] `aarch64`: Raspberry Pi 4 (8 GB)
@@ -24,8 +24,8 @@ Minor updates after tag: `a9f9a893d003e9e7b2a0b66ddb7cdaedc0c2668c`
          with `conda/gridTools_export-linux-64.yml`
  - [X] Ensure release/version is properly updated in `gridtools/__init__.py`
  - [X] Modify any test CI Github Actions
- - [ ] Update any tests performed by pytest
- - [ ] Update TODOs.md
+ - [X] Update any tests performed by pytest
+ - [X] Update TODOs.md
  - [ ] After submission of PR
    - [ ] Review commit as necessary
    - [ ] Verify CI/Actions pass
@@ -42,4 +42,22 @@ Minor updates after tag: `a9f9a893d003e9e7b2a0b66ddb7cdaedc0c2668c`
 
 # General Release Notes
 
+ - Add application hooks for jupyter and ipylab grid mask editors
+ - Port ROMS grid editor to gridtools using pylab
+ - Initial creation of MOM6 grid editor in Jupyter
+ - Edited ocean mask can be applied to existing grids
+ - Mosaic files can be rewritten with modified grids
+ - Experimenting artifacts on github Actions
+ - Use a platform specific export yml file
+ - Need to use a RTD specific yml file
+ - Provide additional options for loading the gridTools
+   environment using conda
+ - Update extra short cut keys for jupyter. 
+ - Add more descriptions to README.md in examples
+ - Add more default options to examples
+ - Renumber exmaples so they are more `ls` friendly
+ - Consolidate creation of hashes using a single function
+
 # Bug Fixes
+
+ - Fix a couple examples to catch up with API changes

gridtools/app.py

@@ -1065,7 +1065,7 @@ def great_circle(self, lon1, lat1, lon2, lat2):
         return dist
 
     def plotMap(self, x, y):
-    
+
         self.lon = x
         self.lat = y