Skip to content

(0.7.0) Revamp VerticalGrids + add Docs for VerticalGrids #565

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

Merged
merged 62 commits into from
Jun 29, 2025

Conversation

navidcy
Copy link
Member

@navidcy navidcy commented Jun 18, 2025

This is ready for review.

The PR changes the user interface for creating vertical grids.

Also adds a section in the Docs describing the vertical grids. Preview should be here but it might take few hours until you get the final version

https://clima.github.io/ClimaOceanDocumentation/previews/PR565/vertical_grids/

Next should come a PR with a vertical grid implementation that allows us to specify surface spacing, Nz and depth. Will probably involve iterative process, e.g. in the spirit of https://doi.org/10.1016/j.ocemod.2017.03.012

@navidcy navidcy added the build docs Add this label to built the docs in a PR label Jun 18, 2025
Copy link

codecov bot commented Jun 19, 2025

Codecov Report

Attention: Patch coverage is 30.61224% with 34 lines in your changes missing coverage. Please review.

Project coverage is 21.10%. Comparing base (9a01516) to head (80bbe6f).
Report is 1 commits behind head on main.

Files with missing lines Patch % Lines
src/GridUtils.jl 27.65% 34 Missing ⚠️
Additional details and impacted files
@@            Coverage Diff             @@
##             main     #565      +/-   ##
==========================================
- Coverage   23.42%   21.10%   -2.33%     
==========================================
  Files          48       48              
  Lines        2869     2886      +17     
==========================================
- Hits          672      609      -63     
- Misses       2197     2277      +80     

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

🚀 New features to boost your workflow:
  • ❄️ Test Analytics: Detect flaky tests, report on failures, and find test suite problems.

@navidcy navidcy force-pushed the ncc/vertical-grids branch from 716c0c6 to 87cf7d4 Compare June 19, 2025 04:55
@navidcy navidcy requested review from glwagner and simone-silvestri and removed request for glwagner June 19, 2025 05:43
@navidcy navidcy marked this pull request as ready for review June 19, 2025 05:47
@navidcy navidcy changed the title Revamp vertical grids + add Docs Revamp VerticalGrids + add Docs for VerticalGrids Jun 19, 2025
@navidcy navidcy changed the title Revamp VerticalGrids + add Docs for VerticalGrids (0.7.0) Revamp VerticalGrids + add Docs for VerticalGrids Jun 20, 2025
@navidcy navidcy requested a review from glwagner June 25, 2025 20:44
@navidcy navidcy added the documentation Improvements or additions to documentation label Jun 26, 2025
@navidcy
Copy link
Member Author

navidcy commented Jun 27, 2025

merge?

Copy link
Member

@glwagner glwagner left a comment

Choose a reason for hiding this comment

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

I think "Grid utilities" is a better name than "Vertical grids" now. but this belongs in Oceananigans too

@navidcy
Copy link
Member Author

navidcy commented Jun 29, 2025

Merging now.

CliMA/Oceananigans.jl#4623 aims to move ExponentialCoordinate to Oceananigans. When that's merged we can drop it from ClimaOcean.

@navidcy navidcy merged commit 560a4eb into main Jun 29, 2025
26 of 30 checks passed
@navidcy navidcy deleted the ncc/vertical-grids branch June 29, 2025 06:25
navidcy added a commit that referenced this pull request Jun 29, 2025
#565 left all examples commented out accidentally
@navidcy navidcy mentioned this pull request Jun 29, 2025
navidcy added a commit that referenced this pull request Jun 29, 2025
#565 left all examples commented out accidentally
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
build docs Add this label to built the docs in a PR documentation Improvements or additions to documentation
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants