Metadata-Version: 2.4
Name: rompy
Version: 0.3.1
Summary: Relocatable Ocean Modelling in PYthon (rompy)
Author-email: CSIRO <paul.branson@csiro.au>
Maintainer-email: Paul Branson <paul.branson@csiro.au>, Tom Durrant <t.durrant@oceanum.science>, Rafael Guedes <r.guedes@oceanum.science>
License: BSD 3-Clause License
        
        Copyright (c) 2021, rompy
        All rights reserved.
        
        Redistribution and use in source and binary forms, with or without
        modification, are permitted provided that the following conditions are met:
        
        1. Redistributions of source code must retain the above copyright notice, this
           list of conditions and the following disclaimer.
        
        2. Redistributions in binary form must reproduce the above copyright notice,
           this list of conditions and the following disclaimer in the documentation
           and/or other materials provided with the distribution.
        
        3. Neither the name of the copyright holder nor the names of its
           contributors may be used to endorse or promote products derived from
           this software without specific prior written permission.
        
        THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
        AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
        IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
        DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE
        FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
        DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
        SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER
        CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
        OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
        OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
        
Project-URL: Documentation, https://oceanum.github.io/rompy/index.html
Project-URL: Source, https://github.com/rom-py/rompy
Project-URL: Tracker, https://github.com/rom-py/rompy/issues
Project-URL: Changelog, https://github.com/rom-py/rompy/blob/main/HISTORY.rst
Keywords: relocatable,ocean,modelling,python,csiro
Classifier: Development Status :: 3 - Alpha
Classifier: Intended Audience :: Science/Research
Classifier: License :: OSI Approved :: BSD License
Classifier: Natural Language :: English
Classifier: Operating System :: OS Independent
Classifier: Topic :: Scientific/Engineering
Classifier: Topic :: Scientific/Engineering :: Physics
Classifier: Topic :: Scientific/Engineering :: Visualization
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3.10
Classifier: Programming Language :: Python :: 3.11
Classifier: Programming Language :: Python :: 3.12
Requires-Python: >=3.10
Description-Content-Type: text/markdown
License-File: LICENSE
Requires-Dist: cartopy
Requires-Dist: click
Requires-Dist: cloudpathlib
Requires-Dist: cookiecutter>=2.6
Requires-Dist: dask
Requires-Dist: fsspec
Requires-Dist: geopandas
Requires-Dist: h5py
Requires-Dist: intake
Requires-Dist: intake-xarray
Requires-Dist: intake-geopandas
Requires-Dist: matplotlib
Requires-Dist: netcdf4
Requires-Dist: numpy
Requires-Dist: oceanum
Requires-Dist: owslib
Requires-Dist: pandas
Requires-Dist: pydantic>=2.11.4
Requires-Dist: pydantic_numpy
Requires-Dist: scipy
Requires-Dist: tqdm
Requires-Dist: xarray
Requires-Dist: wavespectra
Requires-Dist: isodate
Requires-Dist: appdirs
Provides-Extra: test
Requires-Dist: pytest; extra == "test"
Requires-Dist: envyaml; extra == "test"
Provides-Extra: extra
Requires-Dist: gcsfs; extra == "extra"
Requires-Dist: zarr; extra == "extra"
Provides-Extra: schism
Requires-Dist: tqdm_logging_wrapper; extra == "schism"
Requires-Dist: seawater; extra == "schism"
Requires-Dist: xmltodict; extra == "schism"
Provides-Extra: docs
Requires-Dist: autodoc_pydantic; extra == "docs"
Requires-Dist: ipython; extra == "docs"
Requires-Dist: nbsphinx; extra == "docs"
Requires-Dist: pydata_sphinx_theme; extra == "docs"
Requires-Dist: sphinx<7.3.6; extra == "docs"
Requires-Dist: sphinx-collections; extra == "docs"
Dynamic: license-file

---
title: "Relocatable Ocean Modelling in PYthon (rompy)"
---

[![DOI](https://zenodo.org/badge/DOI/10.5281/zenodo.15093426.svg)](https://doi.org/10.5281/zenodo.15093426)
[![GitHub Pages](https://github.com/rom-py/rompy/actions/workflows/sphinx_docs_to_gh_pages.yaml/badge.svg)](https://rom-py.github.io/rompy/)
[![PyPI version](https://img.shields.io/pypi/v/rompy.svg)](https://pypi.org/project/rompy/)
[![GitHub Workflow Status (with event)](https://img.shields.io/github/actions/workflow/status/rom-py/rompy/python-publish.yml)](https://github.com/rom-py/rompy/actions)
[![PyPI - Downloads](https://img.shields.io/pypi/dm/rompy)](https://pypistats.org/packages/rompy)
[![Code style: black](https://img.shields.io/badge/code%20style-black-000000.svg)](https://github.com/python/black)
[![PyPI - Python Version](https://img.shields.io/pypi/pyversions/rompy)](https://pypi.org/project/rompy/)

# Introduction

Relocatable Ocean Modelling in PYthon (rompy) combines templated cookie-cutter model configuration with various `xarray` extensions to assist in the setup and evaluation of coastal ocean models, and is intended to simplify their configuration, execution and analysis. This repository also includes [Jupyter notebooks](./notebooks) that provide examples to illustrate the use of `rompy` code, create visualisations and provide inline documentation. Currently `rompy` implements one model class for the [SWAN wave model](https://swanmodel.sourceforge.io/) developed by Delft University of Technology. Work is underway on a lightweight wrapper for SCHISM and XBeach.

# Documentation

See https://rom-py.github.io/rompy/
