Skip to content

Fix the README quick-start and GPU instructions - #461

Merged
ali-ramadhan merged 3 commits into
mainfrom
ali/fix-readme-quick-start
Oct 29, 2026
Merged

ali-ramadhan merged 3 commits into
mainfrom
ali/fix-readme-quick-start

Conversation

@ali-ramadhan

Copy link
Copy Markdown
Collaborator
  • Use NPZD(grid) and NonhydrostaticModel(grid; ...) in the quick-start, as in the docs. NutrientPhytoplanktonZooplanktonDetritus(; grid) and NonhydrostaticModel(; grid, ...) don't exist in any supported version, so the quick-start errored.
  • Load CUDA in the GPU instructions (GPU() is defined by Oceananigans' CUDA extension) and use the quick-start's grid there, as the text says (the old size and extent put the front outside the domain). This is a separate commit.

The quick-start runs on Oceananigans 0.115.0 and 0.116.1 (including the visualization), and the GPU version runs on a GPU.

🤖 Generated with Claude Code

ali-ramadhan and others added 2 commits October 28, 2026 14:39
…s APIs

`NonhydrostaticModel(; grid, ...)` and `NutrientPhytoplanktonZooplanktonDetritus(; grid)`
don't exist in any supported version, so the quick-start errored. Use
`NonhydrostaticModel(grid; ...)` and `NPZD(grid)`, as in the documentation's quick-start.

Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
`GPU()` is defined by Oceananigans' CUDA extension, so CUDA has to be loaded. The
GPU grid also still had the size and extent the quick-start used before 150d55c,
which puts the front outside the domain, rather than the quick-start's grid with
`CPU()` swapped for `GPU()` as the text says.

Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>

@jagoosw jagoosw left a comment

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.

Thank you!

@ali-ramadhan
ali-ramadhan merged commit e94a15f into main Oct 29, 2026
14 checks passed
@ali-ramadhan
ali-ramadhan deleted the ali/fix-readme-quick-start branch October 29, 2026 22:28
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