{"id":13408854,"url":"https://github.com/team-ocean/veros","last_synced_at":"2025-05-15T07:03:48.248Z","repository":{"id":19586808,"uuid":"87419383","full_name":"team-ocean/veros","owner":"team-ocean","description":"The versatile ocean simulator, in pure Python, powered by JAX.","archived":false,"fork":false,"pushed_at":"2025-04-16T07:39:14.000Z","size":29633,"stargazers_count":350,"open_issues_count":25,"forks_count":56,"subscribers_count":8,"default_branch":"main","last_synced_at":"2025-05-15T07:03:06.863Z","etag":null,"topics":["climate","distributed","geophysics","gpu","jax","multi-core","oceanography","parallel","python"],"latest_commit_sha":null,"homepage":"https://veros.readthedocs.io","language":"Python","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"gpl-3.0","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/team-ocean.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}},"created_at":"2017-04-06T10:59:21.000Z","updated_at":"2025-05-13T20:36:23.000Z","dependencies_parsed_at":"2023-02-19T02:46:07.796Z","dependency_job_id":"2d450829-7598-47f4-bab2-96ddd37f24b7","html_url":"https://github.com/team-ocean/veros","commit_stats":{"total_commits":1504,"total_committers":17,"mean_commits":88.47058823529412,"dds":0.3996010638297872,"last_synced_commit":"f01270c74247ab01e2d5ec989f07b50bff4d7588"},"previous_names":[],"tags_count":21,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/team-ocean%2Fveros","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/team-ocean%2Fveros/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/team-ocean%2Fveros/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/team-ocean%2Fveros/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/team-ocean","download_url":"https://codeload.github.com/team-ocean/veros/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":254291961,"owners_count":22046424,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","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","distributed","geophysics","gpu","jax","multi-core","oceanography","parallel","python"],"created_at":"2024-07-30T20:00:55.914Z","updated_at":"2025-05-15T07:03:48.215Z","avatar_url":"https://github.com/team-ocean.png","language":"Python","funding_links":[],"categories":["Climate computing and modeling","Software and Tools","Python","Hydrosphere","Computational Fluid Dynamics","Libraries","Observation and Conservation of Ecosystems"],"sub_categories":["Ocean Models","Shallow Water / Ocean Dynamics","Ocean and Climate"],"readme":"\u003cp align=\"center\"\u003e\n\u003cimg src=\"doc/_images/veros-logo-400px.png?raw=true\"\u003e\n\u003c/p\u003e\n\n\u003cp align=\"center\"\u003e\n\u003ci\u003eVersatile Ocean Simulation in Pure Python\u003c/i\u003e\n\u003c/p\u003e\n\n\u003cp align=\"center\"\u003e\n  \u003ca href=\"http://veros.readthedocs.io/?badge=latest\"\u003e\n    \u003cimg src=\"https://readthedocs.org/projects/veros/badge/?version=latest\" alt=\"Documentation status\"\u003e\n  \u003c/a\u003e\n  \u003ca href=\"https://github.com/team-ocean/veros/actions/workflows/test-all.yml\"\u003e\n    \u003cimg src=\"https://github.com/team-ocean/veros/actions/workflows/test-all.yml/badge.svg\" alt=\"Test status\"\u003e\n  \u003c/a\u003e\n  \u003ca href=\"https://codecov.io/gh/team-ocean/veros\"\u003e\n    \u003cimg src=\"https://codecov.io/gh/team-ocean/veros/branch/main/graph/badge.svg\" alt=\"Code Coverage\"\u003e\n  \u003c/a\u003e\n  \u003ca href=\"https://zenodo.org/badge/latestdoi/87419383\"\u003e\n    \u003cimg src=\"https://zenodo.org/badge/87419383.svg\" alt=\"DOI\"\u003e\n  \u003c/a\u003e\n\u003c/p\u003e\n\nVeros, *the versatile ocean simulator*, aims to be the swiss army knife of ocean modeling. It is a full-fledged primitive equation ocean model that supports anything between idealized toy models and [realistic, high-resolution, global ocean simulations](https://agupubs.onlinelibrary.wiley.com/doi/10.1029/2021MS002717). And because Veros is written in pure Python, the days of struggling with complicated model setup workflows, ancient programming environments, and obscure legacy code are finally over.\n\n*In a nutshell, we want to enable high-performance ocean modelling with a clear focus on flexibility and usability.*\n\nVeros supports a NumPy backend for small-scale problems, and a\nhigh-performance [JAX](https://github.com/google/jax) backend\nwith CPU and GPU support. It is fully parallelized via MPI and supports\ndistributed execution on any number of nodes, including multi-GPU architectures (see also [our benchmarks](https://veros.readthedocs.io/en/latest/more/benchmarks.html)).\n\nThe dynamical core of Veros is based on [pyOM2](https://wiki.cen.uni-hamburg.de/ifm/TO/pyOM2), an ocean model with a Fortran backend and Fortran and Python frontends.\n\nTo learn more about Veros, make sure to [visit our documentation](https://veros.readthedocs.io/en/latest/).\n\n#### How about a demonstration?\n\n\u003cp align=\"center\"\u003e\n  \u003ca href=\"https://vimeo.com/391237951\"\u003e\n      \u003cimg src=\"doc/_images/veros-preview.gif?raw=true\" alt=\"0.25×0.25° high-resolution model spin-up\"\u003e\n  \u003c/a\u003e\n\u003c/p\u003e\n\n\u003cp align=\"center\"\u003e\n(0.25×0.25° high-resolution model spin-up, click for better\nquality)\n\u003c/p\u003e\n\n## Features\n\nVeros provides\n\n-   a fully staggered **3-D grid geometry** (*C-grid*)\n-   support for both **idealized and realistic configurations** in\n    Cartesian or pseudo-spherical coordinates\n-   several **friction and advection schemes**\n-   isoneutral mixing, eddy-kinetic energy, turbulent kinetic energy,\n    and internal wave energy **parameterizations**\n-   several **pre-implemented diagnostics** such as energy fluxes,\n    variable time averages, and a vertical overturning stream function\n    (written to netCDF4 output)\n-   **pre-configured idealized and realistic set-ups** that are ready to\n    run and easy to adapt\n-   **accessibility and extensibility** - thanks to the\n    power of Python!\n\n## Veros for the impatient\n\nA minimal example to install and run Veros:\n\n```bash\n$ pip install veros\n$ veros copy-setup acc --to /tmp/acc\n$ veros run /tmp/acc/acc.py\n```\n\nFor more detailed installation instructions, have a look at [our\ndocumentation](https://veros.readthedocs.io).\n\n## Basic usage\n\nTo run Veros, you need to set up a model --- i.e., specify which settings\nand model domain you want to use. This is done by subclassing the\n`VerosSetup` base class in a *setup script* that is written in Python. You\nshould use the `veros copy-setup` command to copy one into your current\nfolder. A good place to start is the\n[ACC model](https://github.com/team-ocean/veros/blob/main/veros/setups/acc/acc.py):\n\n```bash\n$ veros copy-setup acc\n```\n\nAfter setting up your model, all you need to do is call the `setup` and\n`run` methods on your setup class. The pre-implemented setups can all be\nexecuted via `veros run`:\n\n```bash\n$ veros run acc.py\n```\n\nFor more information on using Veros, have a look at [our\ndocumentation](http://veros.readthedocs.io).\n\n## Contributing\n\nContributions to Veros are always welcome, no matter if you spotted an\ninaccuracy in [the documentation](https://veros.readthedocs.io), wrote a\nnew setup, fixed a bug, or even extended Veros\\' core mechanics. There\nare 2 ways to contribute:\n\n1.  If you want to report a bug or request a missing feature, please\n    [open an issue](https://github.com/team-ocean/veros/issues). If you\n    are reporting a bug, make sure to include all relevant information\n    for reproducing it (ideally through a *minimal* code sample).\n2.  If you want to fix the issue yourself, or wrote an extension for\n    Veros - great! You are welcome to submit your code for review by\n    committing it to a repository and opening a [pull\n    request](https://github.com/team-ocean/veros/pulls). However,\n    before you do so, please check [the contribution\n    guide](http://veros.readthedocs.io/quickstart/get-started.html#enhancing-veros)\n    for some tips on testing and benchmarking, and to make sure that\n    your modifications adhere with our style policies. Most importantly,\n    please ensure that you follow the [PEP8\n    guidelines](https://www.python.org/dev/peps/pep-0008/), use\n    *meaningful* variable names, and document your code using\n    [Google-style\n    docstrings](http://sphinxcontrib-napoleon.readthedocs.io/en/latest/example_google.html).\n\n## How to cite\n\nIf you use Veros in scientific work, please consider citing [the following publication](https://gmd.copernicus.org/articles/11/3299/2018/):\n\n```bibtex\n@article{hafner_veros_2018,\n\ttitle = {Veros v0.1 – a fast and versatile ocean simulator in pure {Python}},\n\tvolume = {11},\n\tissn = {1991-959X},\n\turl = {https://gmd.copernicus.org/articles/11/3299/2018/},\n\tdoi = {10.5194/gmd-11-3299-2018},\n\tnumber = {8},\n\tjournal = {Geoscientific Model Development},\n\tauthor = {Häfner, Dion and Jacobsen, René Løwe and Eden, Carsten and Kristensen, Mads R. B. and Jochum, Markus and Nuterman, Roman and Vinter, Brian},\n\tmonth = aug,\n\tyear = {2018},\n\tpages = {3299--3312},\n}\n```\n\nOr have a look at [our documentation](https://veros.readthedocs.io/en/latest/more/publications.html)\nfor more publications involving Veros.\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fteam-ocean%2Fveros","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fteam-ocean%2Fveros","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fteam-ocean%2Fveros/lists"}