Skip to content

First pass at simplifying PCMDI-AMIP docs (#220) #221

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.

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

Open
wants to merge 3 commits into
base: main
Choose a base branch
from

Conversation

durack1
Copy link
Contributor

@durack1 durack1 commented Mar 14, 2025

This PR is a quick pass at attempting to streamline information presented in the PCMDI-AMIP documentation page.

The key point, is that the granularity (that is not very well defined) about AR7 Fast Track is removed in the below.

This particular case is an excellent example to ponder, as data bugs (admittedly a small issue, of a problem with the last timestep in the siconc/siconcbcs last month) are an issue that has prevented the dataset being incremented with a mip_era = CMIP7, an example that we'll likely see repeated into the coming months.

@vnaik60 it might be useful to ping this example to the folks who you've been interacting with to see if such information hits the mark, is vague or confusing.. Admittedly this amip dataset is one of the more simple ones, as it's a single-experiment use (CMIP7:CMIP:amip).

@znichollscr @vnaik60 @eleanororourke pinging you all for feedback.

@durack1 durack1 requested review from vnaik60 and znichollscr March 14, 2025 15:23
Copy link

No changes to the database between 'main' branch and 69f3e8a

Copy link

No changes to the database between 'main' branch and 4fd5397

Copy link

No changes to the database between 'main' branch and 09e3f84

@durack1
Copy link
Contributor Author

durack1 commented Mar 14, 2025

@johndunne13 does this change reflect the format that you were thinking? (ref #222)

## Key contacts

- Names: Paul Durack
- Names: Paul J. Durack
- Emails: [email protected]

## Summary

<!--- begin-cmip7-phases-source-ids -->
<!--- Do not edit this section, it is automatically updated when the docs are built -->
Copy link
Collaborator

Choose a reason for hiding this comment

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

@durack1 I'm guessing you missed this. Can you please move all the text you wrote out of the section boundaries or update the code which auto-generates this text

Copy link
Contributor Author

Choose a reason for hiding this comment

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

ha ha, where is the code? This is one of those examples of keep it simple that has tripped me up, and I would consider myself a "sophisticated" user..

Copy link
Collaborator

Choose a reason for hiding this comment

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

https://github.com/PCMDI/input4MIPs_CVs/blob/main/docs/dataset-overviews/fill-out-auto-generated-sections.py

This is one of those examples of keep it simple that has tripped me up, and I would consider myself a "sophisticated" user

I know it's not a use case you're used to, and that is causing issues, but what I'm doing is definitely not sophisticated.

If you just move the bespoke text out of that block (leave the changes that actually need to change the template), I can also do the auto-generating updates.

Have a look at Margreet's if you want to see how to split the long text from the key info https://input4mips-cvs.readthedocs.io/en/latest/dataset-overviews/open-biomass-burning-emissions/

- Emails: [email protected]

## Summary

<!--- begin-cmip7-phases-source-ids -->
<!--- Do not edit this section, it is automatically updated when the docs are built -->
### Source IDs for CMIP7 phases
### Source IDs for CMIP phases
Copy link
Collaborator

Choose a reason for hiding this comment

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

I would leave this as CMIP7, as we're not going to start providing information about CMIP5 or CMIP6 here (at least not in the short term)

Copy link
Contributor Author

Choose a reason for hiding this comment

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

We already have CMIP7 and CMIP6Plus as headings on the page further down.. So happy to iterate


For the CMIP7 AR7 fast track phase of CMIP7, use data with the source ID [PCMDI-AMIP-1-1-9](https://aims2.llnl.gov/search?project=input4MIPs&versionType=all&&activeFacets=%7B%22source_id%22%3A%5B%22PCMDI-AMIP-1-1-9%22%5D%7D)
**an issue has been identified in the PCMDI-AMIP-1-1-9 sea ice field for the dataset last month (2022-12).
A resolution is currently being investigated, and a revised dataset `PCMDI-AMIP-1-1-10` will be made available
Copy link
Collaborator

Choose a reason for hiding this comment

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

I would shift this above the auto-generated section, given how key it is

Copy link
Contributor Author

Choose a reason for hiding this comment

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

The auto-generated bit is something I didn't get - the content is what I was keen to update

@johndunne13
Copy link

johndunne13 commented Mar 14, 2025 via email

@znichollscr
Copy link
Collaborator

@durack1 let's do this after #223 as #223 changes the auto-generated sections anyway.

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.

4 participants