Veros is the versatile ocean simulator -- it aims to be a powerful tool that makes high-performance ocean modeling approachable and fun. Because Veros is a pure Python module, the days of struggling with complicated model setup workflows, ancient programming environments, and obscure legacy code are finally over.
Veros supports a NumPy backend for small-scale problems and a high-performance JAX backend with CPU and GPU support. It is fully parallelized via MPI and supports distributed execution.
The underlying numerics are based on pyOM2, a Fortran ocean model developed at Institut für Meereskunde, Hamburg University.
Veros is currently being developed at Niels Bohr Institute, Copenhagen University.
How about a demonstration?
(0.25×0.25° high-resolution model spin-up, click for better quality)
Features
Veros provides
- a fully staggered 3-D grid geometry (C-grid)
- support for both idealized and realistic configurations in Cartesian or pseudo-spherical coordinates
- several friction and advection schemes to choose from
- isoneutral mixing, eddy-kinetic energy, turbulent kinetic energy, and internal wave energy parameterizations
- several pre-implemented diagnostics such as energy fluxes, variable time averages, and a vertical overturning stream function (written to netCDF output)
- pre-configured idealized and realistic set-ups that are ready to run and easy to adapt
- accessibility and extensibility - thanks to the power of Python!
Veros for the impatient
A minimal example to install and run Veros:
$ pip install veros
$ veros copy-setup acc --to /tmp/acc
$ veros run /tmp/acc/acc.py
For more detailed installation instructions, have a look at our documentation.
Basic usage
To run Veros, you need to set up a model - i.e., specify which settings and model domain you want to use. This is done by subclassing the VerosSetup base class in a setup script that is written in Python. You should use the veros copy-setup command to copy one into your current folder. A good place to start is the ACC model:
$ veros copy-setup acc
After setting up your model, all you need to do is call the setup and run methods on your setup class. The pre-implemented setups can all be executed via veros run:
$ veros run acc.py
For more information on using Veros, have a look at our documentation.
Contributing
Contributions to Veros are always welcome, no matter if you spotted an inaccuracy in the documentation, wrote a new setup, fixed a bug, or even extended Veros' core mechanics. There are 2 ways to contribute:
- If you want to report a bug or request a missing feature, please open an issue. If you are reporting a bug, make sure to include all relevant information for reproducing it (ideally through a minimal code sample).
- If you want to fix the issue yourself, or wrote an extension for Veros - great! You are welcome to submit your code for review by committing it to a repository and opening a pull request. However, before you do so, please check the contribution guide for some tips on testing and benchmarking, and to make sure that your modifications adhere with our style policies. Most importantly, please ensure that you follow the PEP8 guidelines, use meaningful variable names, and document your code using Google-style docstrings.
How to cite
If you use Veros in scientific work, please consider citing the following publication:
@article{hafner_veros_2018,
title = {Veros v0.1 – a fast and versatile ocean simulator in pure {Python}},
volume = {11},
issn = {1991-959X},
url = {https://gmd.copernicus.org/articles/11/3299/2018/},
doi = {10.5194/gmd-11-3299-2018},
number = {8},
journal = {Geoscientific Model Development},
author = {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},
month = aug,
year = {2018},
pages = {3299--3312},
}
Could you please tell me what should I do?
Thanks in advance!
148 Dec 28, 2022
8 Sep 02, 2022
[email protected]">
117 Nov 30, 2022
11 Oct 07, 2022
15 Nov 26, 2022
16 Nov 01, 2022
86 Dec 25, 2022
2 Jan 13, 2022
48 Nov 30, 2022
14.8k Jan 03, 2023
12 Dec 08, 2022
6.5k Jan 02, 2023
10 Oct 19, 2022
7 Jul 04, 2022
0 Oct 19, 2021
1.7k Jan 03, 2023
19 Dec 10, 2021
185 Dec 23, 2022
20 Sep 12, 2021
208 Nov 25, 2022