Skip to content

Data section update#1131

Draft
charles-turner-1 wants to merge 5 commits intopaige/data-update-1124from
charles/1124-data-section
Draft

Data section update#1131
charles-turner-1 wants to merge 5 commits intopaige/data-update-1124from
charles/1124-data-section

Conversation

@charles-turner-1
Copy link

@charles-turner-1 charles-turner-1 commented Jan 30, 2026

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.

  • Bug fix (non-breaking change which fixes an issue, e.g. dead links)
  • New link / content

Checklist:

  • The new content is accessible and located in the appropriate section
  • My changes do not break navigation and do not generate new warnings
  • I have checked that the links are valid and point to the intended content
  • I have checked my code/text and corrected any misspellings
    • Use of Catalog/Catalogue is consistent throughout

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.

@github-actions
Copy link

github-actions bot commented Jan 30, 2026

PR Preview
🚀 Preview of PR head commit c87844d deployed to https://docs.access-hive.org.au/pr-previews/1131
2026-02-06 17:35 AEDT
Preview generated through the Deploy to GitHub Pages workflow run 21741235787.

@charles-turner-1 charles-turner-1 changed the base branch from josh/data-update-1124 to paige/data-update-1124 February 3, 2026 01:32
@charles-turner-1
Copy link
Author

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

Comment on lines +16 to +17
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.

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This could probably be simplified? Maybe...

Suggested change
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.

Comment on lines +19 to +43
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()
```

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Maybe this could be simplified further too? Code is simple enough we probably don't need to walk the user through each step.

Suggested change
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()

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Maybe a link to the access-nri-intake-catalog readthedocs tutorial somewhere too?

Copy link
Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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!

Copy link
Author

@charles-turner-1 charles-turner-1 left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Accidentally left this comment as a pending review all weekend... Fixing it up now!

Copy link
Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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!

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants