Data section update#1131
Conversation
|
|
Bit of cleanup I need to do here, but let me know whether you think the extra detail is necessary @paigem - I reinstated most of it from the previous catalog bits & just changed the routing |
| A simple use case of the ACCESS-NRI Intake catalog is a user wants to plot a timeseries of a variable from a specific data product.<br> | ||
| For example, the user is interested in plotting a scalar ocean variable called _temp\_global\_ave_ for an [ACCESS-ESM1.5](/models/access-esm) run called _HI\_CN\_05_ (data product). This is an historical run using the same configuration as CMIP6 ACCESS-ESM1.5 historical _r1i1p1f1_, except that the phosphorus limitation within [CASA-CNP](/models/model_components/bgc_land#casa-cnp) is disabled. |
There was a problem hiding this comment.
This could probably be simplified? Maybe...
| A simple use case of the ACCESS-NRI Intake catalog is a user wants to plot a timeseries of a variable from a specific data product.<br> | |
| For example, the user is interested in plotting a scalar ocean variable called _temp\_global\_ave_ for an [ACCESS-ESM1.5](/models/access-esm) run called _HI\_CN\_05_ (data product). This is an historical run using the same configuration as CMIP6 ACCESS-ESM1.5 historical _r1i1p1f1_, except that the phosphorus limitation within [CASA-CNP](/models/model_components/bgc_land#casa-cnp) is disabled. | |
| We are interested in plotting a scalar ocean variable called _temp\_global\_ave_ for an [ACCESS-ESM1.5](/models/access-esm) run called _HI\_CN\_05_. This is an historical run using the same configuration as the CMIP6 ACCESS-ESM1.5 historical _r1i1p1f1_, with the phosphorus limitation within [CASA-CNP](/models/model_components/bgc_land#casa-cnp) disabled. |
| First, load the catalog as follows: | ||
|
|
||
| ```python | ||
| import intake | ||
| catalog = intake.cat.access_nri | ||
| ``` | ||
|
|
||
| To see all available catalogs, run: | ||
| ``` | ||
| catalog | ||
| ``` | ||
|
|
||
| Now you can load and plot available datasets for the <i>temp_global_ave</i> variable of the <i>HI_CN_05</i> data product as follows: | ||
|
|
||
| ```python | ||
| import matplotlib.pyplot as plt | ||
|
|
||
| # This returns an xarray Dataset | ||
| dataset = catalog["HI_CN_05"].search(variable="temp_global_ave").to_dask() | ||
|
|
||
| # Plot the data | ||
| dataset["temp_global_ave"].plot() | ||
| plt.title("") | ||
| plt.grid() | ||
| ``` |
There was a problem hiding this comment.
Maybe this could be simplified further too? Code is simple enough we probably don't need to walk the user through each step.
| First, load the catalog as follows: | |
| ```python | |
| import intake | |
| catalog = intake.cat.access_nri | |
| ``` | |
| To see all available catalogs, run: | |
| ``` | |
| catalog | |
| ``` | |
| Now you can load and plot available datasets for the <i>temp_global_ave</i> variable of the <i>HI_CN_05</i> data product as follows: | |
| ```python | |
| import matplotlib.pyplot as plt | |
| # This returns an xarray Dataset | |
| dataset = catalog["HI_CN_05"].search(variable="temp_global_ave").to_dask() | |
| # Plot the data | |
| dataset["temp_global_ave"].plot() | |
| plt.title("") | |
| plt.grid() | |
| ``` | |
| We can load and plot <i>temp_global_ave</i> for <i>HI_CN_05</i> as follows: | |
| ```python | |
| import intake | |
| import matplotlib.pyplot as plt | |
| # Load the catalogue | |
| catalog = intake.cat.access_nri | |
| # This returns an Xarray Dataset | |
| dataset = catalog["HI_CN_05"].search(variable="temp_global_ave").to_dask() | |
| # Plot the data | |
| dataset["temp_global_ave"].plot() | |
| plt.title("") | |
| plt.grid() |
There was a problem hiding this comment.
Maybe a link to the access-nri-intake-catalog readthedocs tutorial somewhere too?
There was a problem hiding this comment.
Whoops - this was on the old page and I thought it had gotten dragged in for free. I seem to have removed it... Definitely in agreement with you!
charles-turner-1
left a comment
There was a problem hiding this comment.
Accidentally left this comment as a pending review all weekend... Fixing it up now!
There was a problem hiding this comment.
Whoops - this was on the old page and I thought it had gotten dragged in for free. I seem to have removed it... Definitely in agreement with you!
TODO: Fill out description
ACCESS-Hive Docs
Thank you for submitting a pull request to the ACCESS-Hive Docs Project. 🎉
More assistance is available in the how to contribute section on ACCESS-Hive Docs
Description
Please write a brief summary of what this pull request does. This can be as simple as "Fixes a typo" or
"Adds paragraph about running atmospheric model on gadi".
If this pull request addresses an already open issue, then you can link that issue with this syntax:
Fixes #(issue number)
This also works if you include the same text in a commit message.
(Delete these instructions after you write your description. 🙃)
Type of change
Please delete options that are not relevant.
Checklist:
When your pull request is ready please request a review.
Unless there is a specific person you want your PR to be reviewd by, please select the Hive Docs Team:
ACCESS-NRI/hivedocsteam. This ensures the load for reviewing pull requests is shared equitably.