{ "info": { "author": "Dion H\u00e4fner (NBI Copenhagen)", "author_email": "dion.haefner@nbi.ku.dk", "bugtrack_url": null, "classifiers": [ "Development Status :: 3 - Alpha", "Intended Audience :: Science/Research", "License :: OSI Approved :: MIT License", "Operating System :: MacOS", "Operating System :: Microsoft :: Windows", "Operating System :: POSIX", "Operating System :: Unix", "Programming Language :: Python :: 3", "Programming Language :: Python :: 3.5", "Programming Language :: Python :: 3.6", "Programming Language :: Python :: 3.7", "Programming Language :: Python :: Implementation :: CPython", "Topic :: Scientific/Engineering" ], "description": "

\n\n

\n\n

\n \n \"Documentation\n \n \n \"Build\n \n \n \"Code\n \n \n \"DOI\"\n \n

\n\nVeros, the *versatile ocean simulator*, is just that: A powerful tool\nthat makes high-performance ocean modeling approachable and fun. Since\nit is a pure Python module, the days of struggling with complicated\nmodel setup workflows, ancient programming environments, and obscure\nlegacy code are finally over.\n\nVeros supports both a NumPy backend for small-scale problems and a fully\nparallelized high-performance backend [powered by\nBohrium](https://github.com/bh107/bohrium) using either OpenMP (CPU) or\nOpenCL (GPU), and runs on distributed architectures via MPI.\n\nA good starting point to gain an overview of Veros\\' design,\nperformance, and capabilities are [these slides of a talk on\nVeros](http://slides.com/dionhaefner/veros-ams) held during the 98th\nAnnual Meeting of the American Meteorological Society.\n\nThe underlying numerics are based on\n[pyOM2](https://wiki.cen.uni-hamburg.de/ifm/TO/pyOM2), an ocean model\ndeveloped by Carsten Eden (Institut f\u00fcr Meereskunde, Hamburg\nUniversity). Veros is currently being developed at Niels Bohr Institute,\nCopenhagen University.\n\n#### How about a demonstration?\n\n

\n \n \"0.25\u00d70.25\u00b0\n \n

\n\n

\n(0.25\u00d70.25\u00b0 high-resolution model spin-up, click for better\nquality)\n

\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** to choose from\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 netCDF output)\n- **pre-configured idealized and realistic set-ups** that are ready to\n run and easy to adapt\n- **accessibility, readability, 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[all]\n$ veros copy-setup acc --to /tmp\n$ cd /tmp/acc\n$ python acc.py\n```\n\n## Installation\n\n### Dependencies\n\nVeros only has one external library dependency, `HDF5`. The installation\nprocedure of this library varies between platforms. The easiest way to\ninstall Veros and its dependencies (including Bohrium) is [Anaconda\nPython](https://www.continuum.io/downloads) that ships with a package\nmanager (`conda`).\n\nIf you do not want to use Anaconda, the most convenient way is to use\nyour operating system\\'s package manager. On Debian / Ubuntu, you can\ne.g. use\n\n```bash\n$ sudo apt-get install libhdf5-dev\n```\n\nSimilar package managers on OSX are [Homebrew](https://brew.sh/) or\n[MacPorts](https://www.macports.org/), which both provide the required\ndependencies as pre-compiled binaries.\n\n### Installing Veros\n\nAs soon as you have a working environment, installing Veros is simple:\n\n1. Clone the repository to your hard-drive:\n\n ```bash\n $ git clone https://github.com/dionhaefner/veros.git\n ```\n\n2. Install it, preferably with\n\n ```bash\n $ pip install -e veros\n ```\n\n If you use the `-e` flag, any changes you make to the model code are\n immediately reflected without having to re-install.\n\nIn case you want to use the Bohrium backend, you will have to install\n[Bohrium](https://github.com/bh107/bohrium), e.g. through `conda` or\n`apt-get`, or by building it from source.\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`Veros` base class in a *setup script* that is written in Python. You\nshould have a look at the pre-implemented model setups in the\nrepository\\'s `setup` folder, or use the `veros copy-setup` command to\ncopy one into your current folder. A good place to start is the [ACC\nmodel](https://github.com/dionhaefner/veros/blob/master/setup/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 as scripts, e.g. through\n\n```bash\n$ python 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](http://veros.readthedocs.io), wrote a\nnice setup, fixed a bug, or even extended Veros\\' core mechanics. There\nare two ways to contribute:\n\n- If you want to report a bug or request a missing feature, please\n [open an issue](https://github.com/dionhaefner/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).\n- 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/dionhaefner/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).", "description_content_type": "text/markdown", "docs_url": null, "download_url": "", "downloads": { "last_day": -1, "last_month": -1, "last_week": -1 }, "home_page": "https://veros.readthedocs.io", "keywords": "oceanography python parallel numpy multi-core geophysics ocean-model bohrium mpi4py", "license": "MIT", "maintainer": "", "maintainer_email": "", "name": "veros", "package_url": "https://pypi.org/project/veros/", "platform": "", "project_url": "https://pypi.org/project/veros/", "project_urls": { "Homepage": "https://veros.readthedocs.io" }, "release_url": "https://pypi.org/project/veros/0.2.0/", "requires_dist": null, "requires_python": ">3.5.2", "summary": "The versatile ocean simulator, in pure Python, powered by Bohrium.", "version": "0.2.0" }, "last_serial": 5304199, "releases": { "0.1.1": [ { "comment_text": "", "digests": { "md5": "3c5cd6df17b4eed4cbcc680defac77b2", "sha256": "0be5659cdc27c8274e51ce18f18e5dcf524e8da6e29bdd25e53b8ea2c849a871" }, "downloads": -1, "filename": "veros-0.1.1-py2-none-any.whl", "has_sig": false, "md5_digest": "3c5cd6df17b4eed4cbcc680defac77b2", "packagetype": "bdist_wheel", "python_version": "py2", "requires_python": null, "size": 299971, "upload_time": "2018-01-25T07:32:59", "url": "https://files.pythonhosted.org/packages/c5/aa/d04dae4de3eadf758fe69c0757ed05217a3607d873ca02805f5520249032/veros-0.1.1-py2-none-any.whl" }, { "comment_text": "", "digests": { "md5": "16e8c62cba3db322ec45d897e09a9ba7", "sha256": "9470fc2da6abcf817e41b041d05d0278bbeb82066a6ce19164c9faf1bfcd1591" }, "downloads": -1, "filename": "veros-0.1.1-py3-none-any.whl", "has_sig": false, "md5_digest": "16e8c62cba3db322ec45d897e09a9ba7", "packagetype": "bdist_wheel", "python_version": "py3", "requires_python": null, "size": 299971, "upload_time": "2018-01-25T07:33:03", "url": "https://files.pythonhosted.org/packages/04/49/d9c5a3d5c9acd388f252eff7c3d94067c4c77ceeaf70d29e740693448edf/veros-0.1.1-py3-none-any.whl" }, { "comment_text": "", "digests": { "md5": "b85a62fd6e61d32f67ae349751140bc1", "sha256": "b9ca807932403b138f5e5c8cd8c26267afb7eb04179de190d1cc63c03d19c077" }, "downloads": -1, "filename": "veros-0.1.1.tar.gz", "has_sig": false, "md5_digest": "b85a62fd6e61d32f67ae349751140bc1", "packagetype": "sdist", "python_version": "source", "requires_python": null, "size": 288960, "upload_time": "2018-01-25T07:33:07", "url": "https://files.pythonhosted.org/packages/30/85/e45cf4c8710ea38b964102487c9dbbecd10a1f251d177d55c8a84bb2f6d7/veros-0.1.1.tar.gz" } ], "0.2.0": [ { "comment_text": "", "digests": { "md5": "538d56ab6a1a919ffa063cbdf32e220e", "sha256": "52f183b80896ba8a03c6d4d3e033a96ea27b7b6d21c9682991785b6876bd6cf8" }, "downloads": -1, "filename": "veros-0.2.0.tar.gz", "has_sig": false, "md5_digest": "538d56ab6a1a919ffa063cbdf32e220e", "packagetype": "sdist", "python_version": "source", "requires_python": ">3.5.2", "size": 304327, "upload_time": "2019-05-22T19:22:04", "url": "https://files.pythonhosted.org/packages/57/a5/e31208ce0fa6c5d2b22fafd292cc32315c78d597cd50cde0eeab48dd50e5/veros-0.2.0.tar.gz" } ] }, "urls": [ { "comment_text": "", "digests": { "md5": "538d56ab6a1a919ffa063cbdf32e220e", "sha256": "52f183b80896ba8a03c6d4d3e033a96ea27b7b6d21c9682991785b6876bd6cf8" }, "downloads": -1, "filename": "veros-0.2.0.tar.gz", "has_sig": false, "md5_digest": "538d56ab6a1a919ffa063cbdf32e220e", "packagetype": "sdist", "python_version": "source", "requires_python": ">3.5.2", "size": 304327, "upload_time": "2019-05-22T19:22:04", "url": "https://files.pythonhosted.org/packages/57/a5/e31208ce0fa6c5d2b22fafd292cc32315c78d597cd50cde0eeab48dd50e5/veros-0.2.0.tar.gz" } ] }