Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Update plot.py for more recent xarray; also allow dask arrays to be passed to single_panel, six_plot routines #257

Merged
merged 4 commits into from
Aug 30, 2023
Merged

Update plot.py for more recent xarray; also allow dask arrays to be passed to single_panel, six_plot routines #257

Show file tree
Hide file tree
Changes from 3 commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
e5db1fe
Now allow dask.array.Array arguments in single_panel and six_plot
yantosca Aug 29, 2023
e34b309
Unpeg xarray in environment.yml (undoing update from PR #255)
yantosca Aug 29, 2023
147ad32
Update Pydoc comments in plot.py; Update CHANGELOG.md
yantosca Aug 29, 2023
73b7c36
Fixed typo in pydoc comments in "six_plot" routine of plot.py
yantosca Aug 30, 2023
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 2 additions & 0 deletions CHANGELOG.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -26,6 +26,7 @@ The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
- Added new routine `format_number_for_table` in `util.py`
- Added BrSALA and BrSALC to `emission_species.yml`
- Added `ENCODING = "UTF-8"` to `gcpy/constants.py`
- Added statement `from dask.array import Array as DaskArray` in `gcpy plot.py`

### Changed
- Simplified the Github issues templates into two options: `new-feature-or-discussion.md` and `question-issue.md`
Expand All @@ -46,6 +47,7 @@ The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
- Added `main()` routine to `gcpy/file_regrid.py`; Also added updates suggested by Pylint
- Fixed broken regridding code in `gcpy/file_regrid.py`; also refactored for clarity
- Rewrote `Regridding.rst` page; Confirmed that regridding examples work properly
- Now allow `plot_val` to be of type `dask.array.Array` in `plot.py` routines `six_plot` and `single_panel`

### Fixed
- Generalized test for GCHP or GCClassic restart file in `regrid_restart_file.py`
Expand Down
8 changes: 1 addition & 7 deletions docs/environment_files/environment.yml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -35,13 +35,7 @@ dependencies:
- scipy # Scientific python package
- sparselt>=0.1.3 # Regridding earth system model data
- tabulate # Pretty-printing for column data
#
# NOTE: The most recent xarray (2023.8.0) seems to break backwards
# compatibility with the benchmark plotting code. Peg to 2023.2.0
# until we can update GCPy for the most recent xarray.
# -- Bob Yantosca (29 Aug 2023)
#
- xarray==2023.2.0 # Read data from netCDF etc files
- xarray # Read data from netCDF etc files
#
# NOTE: These packages need to be pegged at specific versions
# in order to avoid an ImportError.
Expand Down
25 changes: 16 additions & 9 deletions gcpy/plot.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -11,6 +11,7 @@
import matplotlib.pyplot as plt
import matplotlib.ticker as mticker
import numpy as np
from dask.array import Array as DaskArray
import xarray as xr
import cartopy.crs as ccrs
from matplotlib.backends.backend_pdf import PdfPages
Expand Down Expand Up @@ -87,8 +88,8 @@ def six_plot(
all_nan: bool
Set this flag to True if the data to be plotted consist
only of NaNs
plot_val: xarray DataArray or numpy.ndarray
Single variable GEOS-Chem output values to plot
plot_vals: xarray.DataArray, numpy.ndarray, or dask.array.Array
Single data variable GEOS-Chem output to plot
grid: dict
Dictionary mapping plot_val to plottable coordinates
ax: matplotlib axes
Expand Down Expand Up @@ -167,7 +168,7 @@ def six_plot(
or imshow() (Lat/Lon).
"""
# TODO: Abstract six_plot and related routines out of plot.py
verify_variable_type(plot_val, (np.ndarray, xr.DataArray))
verify_variable_type(plot_val, (np.ndarray, xr.DataArray, DaskArray))

# Compute the min & max values
vmin, vmax = compute_vmin_vmax_for_plot(
Expand Down Expand Up @@ -1288,10 +1289,15 @@ def get_extent_for_colors(ds, minlon, maxlon, minlat, maxlat):
temp = minlon
minlon = maxlon
maxlon = temp
return ds_new.where(ds_new[lon_var] >= minlon, drop=True).\
where(ds_new[lon_var] <= maxlon, drop=True).\
where(ds_new[lat_var] >= minlat, drop=True).\
where(ds_new[lat_var] <= maxlat, drop=True)

# Add .compute() to force evaluation of ds_new[lon_var]
# See https://github.com/geoschem/gcpy/issues/254
# Also note: This may return as a dask.array.Array object
return ds_new.where(\
ds_new[lon_var].compute() >= minlon, drop=True).\
where(ds_new[lon_var].compute() <= maxlon, drop=True).\
where(ds_new[lat_var].compute() >= minlat, drop=True).\
where(ds_new[lat_var].compute() <= maxlat, drop=True)

ds_ref_reg = get_extent_for_colors(
ds_ref,
Expand Down Expand Up @@ -1624,6 +1630,7 @@ def get_extent_for_colors(ds, minlon, maxlon, minlat, maxlat):
maxs = [vmax_ref, vmax_dev, vmax_abs]

ratio_logs = [False, False, False, False, True, True]

# Plot
for i in range(6):
six_plot(
Expand Down Expand Up @@ -2909,7 +2916,7 @@ def single_panel(
Core plotting routine -- creates a single plot panel.

Args:
plot_vals: xarray DataArray or numpy array
plot_vals: xarray.DataArray, numpy.ndarray, or dask.array.Array
Single data variable GEOS-Chem output to plot

Keyword Args (Optional):
Expand Down Expand Up @@ -3020,7 +3027,7 @@ def single_panel(
plot: matplotlib plot
Plot object created from input
"""
verify_variable_type(plot_vals, (xr.DataArray, np.ndarray))
verify_variable_type(plot_vals, (xr.DataArray, np.ndarray, DaskArray))

# Create empty lists for keyword arguments
if pres_range is None:
Expand Down