Skip to content

Add more detailed pipeline instructions#9

Open
ma595 wants to merge 2 commits intomainfrom
update-docs
Open

Add more detailed pipeline instructions#9
ma595 wants to merge 2 commits intomainfrom
update-docs

Conversation

@ma595
Copy link
Copy Markdown
Member

@ma595 ma595 commented Mar 19, 2026

This provides more detailed pipeline instructions, with recommendations for evaluating at specific steps. My plan is to turn this into a jupyter notebook once data has been uploaded to Zenodo, but this will be a separate PR.

TODOs

  • Upload DINO data to Zenodo.
  • Provide more detailed README.md instructions.

Closes #11

@ma595 ma595 requested a review from SimonSadler March 19, 2026 17:38
1. **Clone this repository with submodules**

```bash
git clone --recurse-submodules git@github.com:m2lines/nemo-spinup-bench.git
Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

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

I wonder how many end-users only pull via HTTPS. Do we expect them to have SSH setup for GitHub?

Copy link
Copy Markdown
Member Author

Choose a reason for hiding this comment

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

this is a good point. I will correct.


The spin-up acceleration pipeline forecasts the ocean state forward in time using dimensionality reduction and Gaussian process regression, generates updated restart files, and evaluates the result against a reference numerical run. We begin with a baseline evaluation of the reference simulation so that the final evaluation can be compared against it.

4. **Establish a baseline evaluation** of the cold-start reference simulation:
Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

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

I'm not clear about what this actually does and what the output files represent.

Copy link
Copy Markdown
Member Author

Choose a reason for hiding this comment

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

Do you mean specifically the baseline cold-start evaluation?

Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

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

Yes.

Copy link
Copy Markdown
Member Author

Choose a reason for hiding this comment

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

I think once I get an example dataset in this PR, it'll become clearer.


7. **Evaluate** the projected state and compare against the baseline:

This is the evaluation on the updated restart state compared to the reference at 80 years. We recommend outputting restart files fairly frequently to test different step settings.
Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

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

Is this comparing against the baseline files that were created in step 4? If so, where are they referenced in the command? Also, how do they relate to the reference sim, if that's given?

Copy link
Copy Markdown
Member Author

Choose a reason for hiding this comment

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

It's the same reference dataset (i.e. a full simulation run) but at a different time snapshot.

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.

CI that runs all components on Zenodo data?

2 participants