Merge PR #239 (GCGridObj tools for cubed-sphere grids)

This merge brings PR #239 (GCGridObj tools for cubed-sphere grids, by @lizziel) into GCPy. This adds several utility functions for working with data on cubed-sphere grids. These were from the GcGridObj repository by Liam Bindle and Sebastian Eastham, but had never been formally merged into GCPy. Of note, there is now a function find_index, which will allow a user to find the indices of a cubed-sphere grid box given the lat & lon values. This is necessary in several benchmarking contexts. Signed-off-by: Bob Yantosca <[email protected]>
geoschem · Jul 25, 2023 · 9d0d089 · 9d0d089
2 parents 0ae1143 + 3619644
commit 9d0d089
Show file tree

Hide file tree

Showing 4 changed files with 644 additions and 0 deletions.
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -21,6 +21,7 @@ The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
 - Added `multi_index_lat` keyword to `reshape_MAPL_CS` function in `gcpy/util.py`
 - Added FURA to `emission_species.yml` and `benchmark_categories.yml`
 - Added new routine `format_number_for_table` in `util.py`
+- Added module `gcpy/cstools.py` with utility functions for cubed-sphere grids
 
 ### Changed
 - Simplified the Github issues templates into two options: `new-feature-or-discussion.md` and `question-issue.md`
@@ -35,6 +36,7 @@ The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
 - Routine `print_totals` now prints small and/or large numbers in scientific notation
 - Truncate names in benchmark & emissions tables to improve readability
 - Add TransportTracers species names to `gcpy/emissions_*.yml` files
+- Updated `docs/environment_files/environment.yml` to install `pyproj==3.6.0` via pip
 
 ### Fixed
 - Generalized test for GCHP or GCClassic restart file in `regrid_restart_file.py`

diff --git a/docs/environment_files/environment.yml b/docs/environment_files/environment.yml
@@ -27,6 +27,7 @@ dependencies:
         - numpy==1.21.1               # Optimized mathematical functions
         - pandas==1.3.1               # Tables/timeseries manipulation
         - pycodestyle==2.9.1          # Python style checker (formerly PEP8)
+        - pyproj==3.6.0               # Python map projections library
         - pylint==2.15.3              # Python linter
         - pypdf2==1.26.0              # PDF utilities (bookmarks, etc.)
         - recommonmark==0.7.1         # Dependency for Sphinx

diff --git a/gcpy/__init__.py b/gcpy/__init__.py
@@ -26,3 +26,4 @@
 from .benchmark import *
 from .file_regrid import *
 from .grid_stretching_transforms import *
+from .cstools import *