Closed tomvothecoder closed 1 month ago
[x] A Gentle Introduction to xCDAT (Xarray Climate Data Analysis Tools) (#650)
[x] General Dataset Utilities (#644)
[x] Calculate Geospatial Weighted Averages from Monthly Time Series (#644)
[x] Calculate Time Averages from Time Series Data (#633)
[x] Calculating Climatology and Departures from Time Series Data (#633)
[x] Horizontal Regridding (#646)
[x] Vertical Regridding (#646)
I didn't list "Presentations & Demos," "API Reference," or "Changelog"
Authors: Tom Vo and Stephen Po-Chedley
)Updated XX/YY/ZZZZ using xcdat v0.x.y
)The data used in this example is used directly from the [Earth System Grid Federation (ESGF)](https://aims2.llnl.gov/metagrid/search).
Overview
(make it Overview and Setup
) and we should systematically point the users to our setup pages instead of documenting this in each notebook: Users can install their own instance of xcdat and follow these examples using their own environment (e.g., with vscode, Jupyter, Spyder, iPython) or enable xcdat with existing JupyterHub instances.
%matplotlib inline
? It seems like it doesn't do anything. keep_weights=True
and then plot the weights.spatial.get_weights()
function here lat_bounds
and lon_bounds
don't do anything in this case (and we should make sure this is noted in the docstrings). title
(e.g., title=Nino 3.4 time series
)>
)Spatial averaging is done (pending a PR). I will also review General Dataset Utilities.
A minor glitch: in the linked notebook (https://github.com/pochedls/xcdat/blob/589-doc-reviews/docs/examples/spatial-average.ipynb). The ^{\ \circ} } didn't work to produce degree symbol? Maybe use ^{\circ} in math mode instead?
@chengzhuzhang – these are only supposed to produce degree symbols in the plots – I think they are rendering correctly in the plots? Or am I looking at the wrong thing?
Oh, it is a false alarm. I was trying to mimic your PR, but for regridding. The first lines of some output included the string in math mode which confused me, the figures are indeed fine.
This is now complete with all of the merged PRs.
Describe your documentation update
As suggested by @pochedls, we should perform a routine review of our documentation for accuracy and make sure all information is up-to-date and relevant.