Repository navigation
v0.117.0
Oceananigans v0.117.0
Breaking changes
- New
Opentopology, distinct fromBounded: operators may read the physical halos beyond anOpendirection as if they were part of the domain (#6276). - Open boundary conditions are reworked into part of time stepping. Each open boundary has its own storage and is advanced by
initialize_boundary_conditions!,cache_boundary_conditions!andstep_boundary_conditions!, no longer insidefill_halo_regions!(#6277). - The default
JLD2Writercompression changes fromDeflatetoShuffle+ZstdFilter(1). Both are lossless, but reading new files requires a JLD2 that supports Zstd (#5891). - The Cox-stencil
IsopycnalSkewSymmetricDiffusivityis removed in favor of the triad implementation, so results change (#5955). TripolarGridcells beyond the southern wall are now inactive (#5564).- With
Float32data andFloat64times,FieldTimeSeriesreads at exact time hits now returnFloat64, as interpolated reads already did (#6366). - The nodes of a regular coordinate no longer depend on its halo or partition (#6183).
Changes to solutions
- The
WENOVectorInvariant()vertical momentum flux is now consistent with the divergence cross term. This removes a spurious growing 2Δz mode (#6402).
New features
GridFittedVerticalBoundariesandPartialCellVerticalBoundaries(#6153).at_maximum,at_minimum, andfindmax(f, field)(#6323).- Calendar-year
Cyclical, numeric schedules onDateTimeclocks, andDateTimestop times (#6342). - Biogeochemistry checkpointing (#6382).
Distributedwarns about misconfigured MPI/GPU setups (#6314).- Constant fields as
JLD2WriterandNetCDFWriteroutputs (#5177).
Merged pull requests:
- Single column grid
update_state!is missing theupdate_model_field_time_series!(#3756) (@simone-silvestri) - Adding some distributed grid tests (#4158) (@simone-silvestri)
- Support constant fields as
JLD2WriterandNetCDFWriteroutputs (#5177) (@simone-silvestri) - Mark cells beyond the southern wall of
TripolarGrids as inactive (#5564) (@simone-silvestri) - Fix on_architecture for ImmersedBoundaryGrid on distributed grids (#5628) (@briochemc)
- Switch default JLD2Writer compression to Shuffle + Zstd (#5891) (@giordano)
- Remove Cox stencil ISSD (#5955) (@simone-silvestri)
- Add GridFittedVerticalBoundaries and PartialCellVerticalBoundaries (#6153) (@aklocker42)
- Make the nodes of a regular coordinate independent of its halo and partition (#6183) (@enri66)
- Static dimensions and offsets (#6270) (@simone-silvestri)
- (0.117.0) Introduce an
Opentopology (#6276) (@simone-silvestri) - Rework open boundaries (#6277) (@simone-silvestri)
- Test if stored reciprocals speed up the code (#6281) (@simone-silvestri)
- bump OrderedCollections (#6282) (@ExpandingMan)
- Plot Yin-Yang fields with quadmesh! in the Makie extension (#6297) (@navidcy)
- Allow any number of substeps even with
ExtendedHalos(#6312) (@simone-silvestri) - Validate distributed configuration (#6314) (@simone-silvestri)
- Add at_maximum and at_minimum to locate coordinates of extrema (#6323) (@glwagner)
- Use ParallelTestRunner branch to kill workers when jobs are cancelled (#6324) (@giordano)
- Reactant run!: peel the first step only for Adams-Bashforth (#6330) (@dkytezab)
- Changes metal on_architecture for
StepRangeLento twice precision (#6331) (@jagoosw) - Document all open boundary schemes in the numerical implementation docs (#6337) (@tomchor)
- Convert Float64 arrays to Float32 when moving them to Metal (#6338) (@glwagner)
- Fix SplitExplicitFreeSurface with DateTime clocks (#6341) (@glwagner)
- Calendar-year Cyclical, numeric schedules on DateTime clocks, and DateTime stop times (#6342) (@glwagner)
- Use a FieldTimeSeries at a traced time: skip full-window updates, adapt the interpolation's clock time (#6346) (@dkytezab)
- Add Baker (2026) to publications list (#6349) (@navidcy)
- Readme refresh (#6350) (@navidcy)
- Make the inferred type of operation indices independent of the inference cache (#6354) (@giordano)
- Build regular coordinates without assuming the type that range returns (#6359) (@giordano)
- on_architecture for reshaped host arrays, and for arrays with missing values on ReactantState (#6360) (@dkytezab)
- Improve performance of tridiagonal solve for an OffsetArray of ComplexF32 (#6361) (@francispoulin)
- FieldTimeSeries time interpolation: one return type for an exact hit and an interpolated read (#6366) (@dkytezab)
- Compute the WENO weights of BFloat16 schemes in Float32 (#6367) (@giordano)
- Exchange the barotropic halos before the first substep with
CompleteHaloFilling(#6370) (@aklocker42) - [test] Test against Reactant 0.2.297 - 0.2.299 (#6379) (@dkytezab)
- Checkpoint biogeochemistry (#6382) (@ali-ramadhan)
- Update the Lagrangian particle state at the end of every
SplitRungeKuttatime step (#6383) (@ali-ramadhan) - Make GHA delete previous benchmark comments (#6384) (@simone-silvestri)
- Fix partial distributed mean and Average (#6385) (@Pangoraw)
- Fix pickup when
auxiliary_fieldsinclude anAbstractOperationorFunctionField(#6391) (@ali-ramadhan) - Document that RungeKutta3TimeStepper treats implicit terms with backward Euler (#6392) (@glwagner)
- Adapt the fields of AdaptiveVerticallyImplicitDiscretization for kernels (#6393) (@glwagner)
- Use an Open topology in the distributed open-boundary face test (#6399) (@enri66)
- Fix spurious instability in
WENOVectorInvariantby making the vertical flux consistent with the divergence cross term (#6402) (@glwagner) - Extend methods with qualified names in OceananigansReactantExt (#6403) (@navidcy)
- Resolve method ambiguities and check explicit imports in all modules (#6404) (@navidcy)
- Extend methods explicitly: AbstractOperations (#6406) (@navidcy)
- Extend methods explicitly: Biogeochemistry (#6407) (@navidcy)
- Extend methods explicitly: Diagnostics (#6408) (@navidcy)
- Extend methods explicitly: DistributedComputations (#6409) (@navidcy)
- Extend methods explicitly: Fields (#6410) (@navidcy)
- Extend methods explicitly: ImmersedBoundaries (#6411) (@navidcy)
- Extend methods explicitly: Models (#6412) (@navidcy)
- Extend methods explicitly: OrthogonalSphericalShellGrids (#6413) (@navidcy)
- Extend methods explicitly: OutputWriters (#6414) (@navidcy)
- Extend methods explicitly: TimeSteppers (#6415) (@navidcy)
- Extend methods explicitly: TurbulenceClosures (#6416) (@navidcy)
- Extend methods explicitly: Utils (#6417) (@navidcy)
- Fix
ShallowWaterModelallocating memory at every grid point on the CPU (#6422) (@ali-ramadhan) - Run doctests in the test suite instead of the docs build (#6423) (@navidcy)
- Re-align continuation lines after qualifying method extensions (#6424) (@navidcy)
- Dependabot runs three times a week and watches the docs environment (#6427) (@dkytezab)
- Bump JLD2 in /docs (#6428) (@dependabot[bot])
- Bump SeawaterPolynomials in /docs (#6429) (@dependabot[bot])
- Bump Rotations in /docs (#6430) (@dependabot[bot])
- Add Zheng et al. (2026) to the publications list (#6438) (@navidcy)
- Bump Adapt in /docs (#6446) (@dependabot[bot])
- Fix ifelse returning Union (#6447) (@Pangoraw)
Closed issues:
- Reducing a Field with
mean()is much slower than reducing its underlying array (#4633) - Add
archas an argument toheuristic_workgroup(#5207) DelinearizeIndexingPassfromfill_halo_regions(#5252)- Can't raise
_compute_source_term!with Reactant (#5272) QuasiAdamsBashforth2Reactant extension correctness (#5301)Boundedhalo-filling bug? (#5319)- on_architecture(arch, ::GridFittedBottom{<:Field}) crashes on middle ranks of 1×N≥3 distributed TripolarGrid (#5627)
- Reactant extension
update_state!eager call (#5714) - Overwrite
LinearAlgebra.normfor Reactant (#5834) - Most open boundary schemes aren't on the docs page (#6311)
- Reactant run! traces the first time step twice for every timestepper; only Adams-Bashforth needs the peel (#6329)
- update_field_time_series! on a window that holds every snapshot reads the time on the host, failing at a traced time (#6345)
- TimeSeriesInterpolation's adapt_structure leaves the clock time unadapted, so a Field of it fails to compile on ReactantState (#6347)
- First nested lazy reduction compiled in a julia process is about 1000x slower than subsequent runs (#6351)
- FieldTimeSeries with Float32 data and Float64 times reads as Union{Float32, Float64} (#6364)
prognostic_state(model)skipsmodel.biogeochemistry(#6380)SplitRungeKuttatime steppers never callupdate_lagrangian_particle_state!, so particletracked_fieldsare never updated (#6381)- Picking up from a checkpoint fails when
auxiliary_fieldsinclude anAbstractOperationorFunctionField(#6390) WENOVectorInvarianthas a spurious linear instability with a 2Δz structure: proof, mechanism, and a fix (#6400)- Extend methods explicitly: Module.f(...) = ... instead of import Module: f (#6405)
ShallowWaterModelallocates ~9 KiB per grid point per RK3 stage on the CPU (#6421)