Skip to content

Update README.md to document execution on instantaneous (restart) and time averaged states (grid) #31

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.

Sign up for GitHub

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

Jump to bottom
Draft
ma595 wants to merge 3 commits into
base: main
Choose a base branch
from
Draft

Update README.md to document execution on instantaneous (restart) and time averaged states (grid) #31

ma595 wants to merge 3 commits into from

Conversation

@ma595
Copy link
Member

@ma595 ma595 commented May 15, 2025 •
edited
Loading

This documents how we run Spinup-Evaluation in two modes.

  • Instantaneous (Restart) files
  • Time averaged (Grid_) files

In each case, provide associated references as --reference.

  • Update diagram (.svg)

Fixes #25

@ma595 ma595 self-assigned this May 15, 2025
@ma595 ma595 marked this pull request as draft May 15, 2025 06:57
@ma595 ma595 changed the title Update README.md to run on Instantaneous and Time averaged states Update README.md to document execution on instantaneous (restart) and time averaged states (grid) May 22, 2025
@ma595 ma595 added the documentation Improvements or additions to documentation label Jul 16, 2025
@ma595 ma595 mentioned this pull request Jul 30, 2025
Draft
@ma595 ma595 mentioned this pull request Aug 28, 2025
Merged
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

No reviews

Assignees

@ma595 ma595

Labels

documentation Improvements or additions to documentation

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

Restructure main.py to work on time averaged (Grid_*), or instantaneous (Restart) state.

2 participants

@ma595