{"id":49237257,"url":"https://github.com/CliMA/ClimaOcean.jl","last_synced_at":"2026-05-27T16:00:44.996Z","repository":{"id":61573013,"uuid":"552121954","full_name":"CliMA/ClimaOcean.jl","owner":"CliMA","description":"🌎 Regional-to-global coupled ocean and sea ice simulations based on Oceananigans","archived":false,"fork":false,"pushed_at":"2026-05-18T18:34:07.000Z","size":4887,"stargazers_count":62,"open_issues_count":135,"forks_count":29,"subscribers_count":8,"default_branch":"main","last_synced_at":"2026-05-18T20:34:25.326Z","etag":null,"topics":["climate-model","fluid-dynamics","fluid-dynamics-simulator","machine-learning","ocean-modelling"],"latest_commit_sha":null,"homepage":"https://clima.github.io/ClimaOceanDocumentation/stable/","language":"Julia","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"other","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/CliMA.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":"CITATION.cff","codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null,"zenodo":null,"notice":null,"maintainers":null,"copyright":null,"agents":null,"dco":null,"cla":null}},"created_at":"2022-10-15T21:43:56.000Z","updated_at":"2026-05-16T00:12:43.000Z","dependencies_parsed_at":"2023-10-14T19:32:56.607Z","dependency_job_id":"38f96daa-81e1-44d5-afed-b90abf0bc3a4","html_url":"https://github.com/CliMA/ClimaOcean.jl","commit_stats":{"total_commits":219,"total_committers":5,"mean_commits":43.8,"dds":"0.36986301369863017","last_synced_commit":"9125cb5e59334c3705879424952fb0582b98ed3b"},"previous_names":[],"tags_count":64,"template":false,"template_full_name":null,"purl":"pkg:github/CliMA/ClimaOcean.jl","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/CliMA%2FClimaOcean.jl","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/CliMA%2FClimaOcean.jl/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/CliMA%2FClimaOcean.jl/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/CliMA%2FClimaOcean.jl/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/CliMA","download_url":"https://codeload.github.com/CliMA/ClimaOcean.jl/tar.gz/refs/heads/main","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/CliMA%2FClimaOcean.jl/sbom","scorecard":null,"host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":286080680,"owners_count":33406444,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2026-05-23T04:15:53.637Z","status":"ssl_error","status_checked_at":"2026-05-23T04:15:53.242Z","response_time":53,"last_error":"SSL_read: unexpected eof while reading","robots_txt_status":"success","robots_txt_updated_at":"2025-07-24T06:49:26.215Z","robots_txt_url":"https://github.com/robots.txt","online":false,"can_crawl_api":true,"host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["climate-model","fluid-dynamics","fluid-dynamics-simulator","machine-learning","ocean-modelling"],"created_at":"2026-04-24T17:00:32.379Z","updated_at":"2026-05-27T16:00:44.990Z","avatar_url":"https://github.com/CliMA.png","language":"Julia","funding_links":[],"categories":["Cryosphere"],"sub_categories":["Sea Ice"],"readme":"\u003c!-- Title --\u003e\n\u003ch1 align=\"center\"\u003e\n  ClimaOcean.jl\n\u003c/h1\u003e\n\n\u003c!-- description --\u003e\n\u003cp align=\"center\"\u003e\n  \u003cstrong\u003e🌎 A framework for realistic ocean-only and coupled ocean + sea-ice simulations driven by prescribed atmospheres and based on \u003ca href=https://github.com/CliMA/Oceananigans.jl\u003eOceananigans\u003c/a\u003e and \u003ca href=https://github.com/CliMA/ClimaSeaIce.jl\u003eClimaSeaIce\u003c/a\u003e\u003c/strong\u003e.\n\u003c/p\u003e\n\n###\n\n\u003e [!IMPORTANT]\n\u003e The generic coupling framework and data wrangling utilities originally developed in ClimaOcean are being moved to [**NumericalEarth.jl**](https://github.com/NumericalEarth/NumericalEarth.jl), a new package for building coupled Earth system models with interchangeable components.\n\u003e ClimaOcean.jl will continue to exist as a focused package for realistic ocean and ocean + sea-ice simulations built on [Oceananigans](https://github.com/CliMA/Oceananigans.jl) and [ClimaSeaIce](https://github.com/CliMA/ClimaSeaIce.jl), depending on NumericalEarth for shared functionality.\n\u003e See the [discussion](https://github.com/CliMA/ClimaOcean.jl/discussions/675) for more details.\n\n[![DOI](https://zenodo.org/badge/DOI/10.5281/zenodo.7677442.svg?style=flat-square)](https://doi.org/10.5281/zenodo.7677442)\n[![Build status](https://badge.buildkite.com/3113cca353b83df3b5855d3f0d69827124614aef7017c835d2.svg?style=flat-square)](https://buildkite.com/clima/climaocean-ci)\n[![Documentation](https://img.shields.io/badge/documentation-stable%20release-blue?style=flat-square)](https://clima.github.io/ClimaOceanDocumentation/stable/)\n[![Documentation](https://img.shields.io/badge/documentation-in%20development-orange?style=flat-square)](https://clima.github.io/ClimaOceanDocumentation/dev/)\n\n## Installation\n\nClimaOcean is a registered package. To install from a Julia REPL:\n\n```julia\njulia\u003e using Pkg\n\njulia\u003e Pkg.add(\"ClimaOcean\")\n\njulia\u003e Pkg.instantiate()\n```\n\nUse `Pkg.add(url=\"https://github.com/CliMA/ClimaOcean.jl.git\", rev=\"main\")` to install the latest version of `ClimaOcean`.\nFor more information, see the [documentation for `Pkg.jl`](https://pkgdocs.julialang.org).\n\n## Why? What's the difference between ClimaOcean and [Oceananigans](https://github.com/CliMA/Oceananigans.jl)?\n\nOceananigans is a general-purpose library for ocean-flavored fluid dynamics.\nClimaOcean implements a framework for driving realistic Oceananigans simulations with prescribed atmospheres, and coupling them to prognostic sea ice simulations.\n\n### A core abstraction: `ClimaOcean.OceanSeaIceModel`\n\nOur system for realistic modeling is anchored by `ClimaOcean.OceanSeaIceModel`, which encapsulates the ocean simulation, sea ice simulation, prescribed atmospheric state, and specifies how the three communicate.\nTo illustrate how `OceanSeaIceModel` works we set up a simulation on a grid with 10 vertical levels and 1/4-degree horizontal resolution:\n\n```julia\nusing Oceananigans\nusing Oceananigans.Units\nusing Dates\nusing CUDA\nimport ClimaOcean\n\narch = GPU()\ngrid = LatitudeLongitudeGrid(arch,\n                             size = (1440, 560, 10),\n                             halo = (7, 7, 7),\n                             longitude = (0, 360),\n                             latitude = (-70, 70),\n                             z = (-3000, 0))\n\nbathymetry = ClimaOcean.regrid_bathymetry(grid) # builds gridded bathymetry based on ETOPO1\ngrid = ImmersedBoundaryGrid(grid, GridFittedBottom(bathymetry))\n\n# Build an ocean simulation initialized to the ECCO state estimate version 2 on Jan 1, 1993\nocean = ClimaOcean.ocean_simulation(grid)\nstart_date = DateTime(1993, 1, 1)\nset!(ocean.model,\n     T=ClimaOcean.Metadatum(:temperature; date=start_date, dataset=ClimaOcean.ECCO2Daily()),\n     S=ClimaOcean.Metadatum(:salinity;    date=start_date, dataset=ClimaOcean.ECCO2Daily()))\n\n# Build and run an OceanSeaIceModel (with no sea ice component) forced by JRA55 reanalysis\natmosphere = ClimaOcean.JRA55PrescribedAtmosphere(arch)\ncoupled_model = ClimaOcean.OceanSeaIceModel(ocean; atmosphere)\nsimulation = Simulation(coupled_model, Δt=20minutes, stop_time=30days)\nrun!(simulation)\n```\n\nThe simulation above achieves approximately 8 simulated years per day of wall time on an Nvidia H100 GPU.\n\nSince `ocean.model` is an `Oceananigans.HydrostaticFreeSurfaceModel`, we can leverage `Oceananigans` features in our scripts.\nFor example, to plot the surface speed at the end of the simulation we write\n\n```julia\nu, v, w = ocean.model.velocities\nspeed = Field(sqrt(u^2 + v^2))\ncompute!(speed)\n\nusing GLMakie\nheatmap(view(speed, :, :, ocean.model.grid.Nz), colorrange=(0, 0.5), colormap=:magma, nan_color=:lightgray)\n```\n\nwhich produces\n\n![image](https://github.com/user-attachments/assets/4c484b93-38fe-4840-bf7d-63a3a59d29e1)\n\n### Additional features: a utility for `ocean_simulation`s and data wrangling\n\nA second core abstraction in ClimaOcean is `ocean_simulation`. `ocean_simulation` configures an Oceananigans model for realistic simulations including temperature and salinity, the TEOS-10 equation of state, boundary conditions to store computed air-sea fluxes, the automatically-calibrated turbulence closure `CATKEVerticalDiffusivity`, and the [`WENOVectorInvariant` advection scheme](https://doi.org/10.1029/2023MS004130) for mesoscale-turbulence-resolving simulations.\n\nClimaOcean also provides convenience features for wrangling datasets of bathymetry, ocean temperature, salinity, ocean velocity fields, and prescribed atmospheric states.\n\nClimaOcean is built on top of Oceananigans and [ClimaSeaIce](https://github.com/CliMA/ClimaSeaIce.jl), so it's important that ClimaOcean users become proficient with [Oceananigans](https://github.com/CliMA/Oceananigans.jl).\nNote that though ClimaOcean is currently focused on hydrostatic modeling with `Oceananigans.HydrostaticFreeSurfaceModel`, realistic nonhydrostatic modeling is also within the scope of this package.\n\n\n### Citing\n\nIf you use ClimaOcean for your research, teaching, or fun 🤩, everyone in our community will be grateful\nif you give credit by citing the corresponding Zenodo record, e.g.,\n\n\u003e Wagner, G. L. et al. (2025). CliMA/ClimaOcean.jl: v0.8.10 (v0.8.10). Zenodo. https://doi.org/10.5281/zenodo.7677442\n\nand also the recent [preprint submitted to the Journal of Advances in Modeling Earth Systems](https://doi.org/10.48550/arXiv.2502.14148) that presents an overview of all the things that make Oceananigans unique:\n\n\u003e \"High-level, high-resolution ocean modeling at all scales with Oceananigans\"\n\u003e\n\u003e by Gregory L. Wagner, Simone Silvestri, Navid C. Constantinou, Ali Ramadhan, Jean-Michel Campin,\n\u003e Chris Hill, Tomas Chor, Jago Strong-Wright, Xin Kai Lee, Francis Poulin, Andre Souza, Keaton J. Burns,\n\u003e Siddhartha Bishnu, John Marshall, and Raffaele Ferrari\n\u003e\n\u003e submitted to the Journal of Advances in Modeling Earth Systems, arXiv:[2502.14148](https://doi.org/10.48550/arXiv.2502.14148)\n\n\u003cdetails\u003e\u003csummary\u003ebibtex\u003c/summary\u003e\n  \u003cpre\u003e\u003ccode\u003e@article{Oceananigans-overview-paper-2025,\n  title = {{High-level, high-resolution ocean modeling at all scales with Oceananigans}},\n  author = {G. L. Wagner and S. Silvestri and N. C. Constantinou and A. Ramadhan and J.-M. Campin and C. Hill and T. Chor and J. Strong-Wright and X. K. Lee and F. Poulin and A. Souza and K. J. Burns and S. Bishnu and J. Marshall and R. Ferrari},\n  journal = {arXiv preprint},\n  year = {2025},\n  archivePrefix = {arXiv},\n  eprint = {2502.14148},\n  doi = {10.48550/arXiv.2502.14148},\n  notes = {submitted to the Journal of Advances in Modeling Earth Systems},\n}\u003c/code\u003e\u003c/pre\u003e\n\u003c/details\u003e\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2FCliMA%2FClimaOcean.jl","html_url":"https://awesome.ecosyste.ms/projects/github.com%2FCliMA%2FClimaOcean.jl","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2FCliMA%2FClimaOcean.jl/lists"}