Skip to content

Modernize examples#100

Merged
simone-silvestri merged 22 commits into
mainfrom
ss/modernize-examplaes
Feb 17, 2026
Merged

Modernize examples#100
simone-silvestri merged 22 commits into
mainfrom
ss/modernize-examplaes

Conversation

@simone-silvestri
Copy link
Copy Markdown
Collaborator

I thought the examples might be a bit of modernization. I asked cursor to change the descriptions to match the style of Oceananigans. I am not sure about the result

Comment thread examples/arctic_basin_seasonal_cycle.jl Outdated
using Oceananigans
using Oceananigans.Units
using Oceananigans.Utils: Time
using Oceananigans.OutputReaders
Copy link
Copy Markdown
Member

@glwagner glwagner Nov 16, 2025

Choose a reason for hiding this comment

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

we shouldn't have to import this

something I put in the AGENTS.md file for Oceananigans was to minimize import statements in examples. Examples should exercise the public user interface, which is exported by using ClimaSeaIce.

We could also reexport the relevant parts of the Oceananigans interface by ClimaSeaIce directly. This is the approach I am taking with Breeze, so that people only need to write using Breeze.

Comment on lines 120 to 124
Q_shortwave = FluxFunction(linearly_interpolate_solar_flux, parameters=Rs)
Q_longwave = FluxFunction(linearly_interpolate_flux, parameters=Rl)
Q_sensible = FluxFunction(linearly_interpolate_flux, parameters=Qs)
Q_latent = FluxFunction(linearly_interpolate_flux, parameters=Ql)
Q_emission = RadiativeEmission(emissivity=ϵ, stefan_boltzmann_constant=σ)
Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

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

suggest coming up with mathematical notation for these (we will eventually codify this in Horizon/ClimaOcean)

@glwagner
Copy link
Copy Markdown
Member

are the examples all loaded in the docs? could be another change to make

@glwagner
Copy link
Copy Markdown
Member

Maybe add an AGENTS.md file in this PR as well for ClimaSeaIce?

Comment thread src/ClimaSeaIce.jl Outdated
Comment thread src/EnthalpyMethodSeaIceModel.jl Outdated
@simone-silvestri
Copy link
Copy Markdown
Collaborator Author

Let's merge this @glwagner @navidcy
We can add AGENTS.md subsequently

@navidcy
Copy link
Copy Markdown
Member

navidcy commented Feb 15, 2026

#115 is also relevant here; but can definitely be left for a new PR!

@navidcy navidcy added the 📜 documentation Improvements or additions to documentation label Feb 16, 2026
@navidcy
Copy link
Copy Markdown
Member

navidcy commented Feb 16, 2026

Let's merge this and I'll work on #115 on a different PR

@simone-silvestri simone-silvestri merged commit 34c125f into main Feb 17, 2026
6 checks passed
@simone-silvestri simone-silvestri deleted the ss/modernize-examplaes branch February 17, 2026 08:15
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

📜 documentation Improvements or additions to documentation

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants