rompy-swan 0.6.0__tar.gz

rompy_swan-0.6.0/AUTHORS.rst

@@ -0,0 +1,13 @@
+=======
+Credits
+=======
+
+Development Lead
+----------------
+
+* Rompy Contributors <developers@rompy.com>
+
+Contributors
+------------
+
+None yet. Why not be the first?

rompy_swan-0.6.0/HISTORY.rst

@@ -0,0 +1,131 @@
+=======
+History
+=======
+
+Relocatable Ocean Modelling in PYthon (rompy) is a modular Python library that
+aims to streamline the setup, configuration, execution, and analysis of coastal
+ocean models. Rompy combines templated model configuration with xarray-based
+data handling and pydantic validation, enabling users to efficiently generate
+model control files and input datasets for a variety of ocean and wave models.
+The architecture centers on high-level execution control (`ModelRun`) and
+flexible configuration objects, supporting both persistent scientific model
+state and runtime backend selection. Rompy provides unified interfaces for
+grids, data sources, boundary conditions, and spectra, with extensible plugin
+support for new models and execution environments. Comprehensive documentation,
+example Jupyter notebooks, and a robust logging/formatting framework make rompy
+accessible for both research and operational workflows. Current model support
+includes SWAN and SCHISM, with ongoing development for additional models and
+cloud/HPC backends.
+
+Key Features: - Modular architecture with clear separation of configuration and
+execution logic - Templated, reproducible model configuration using pydantic
+and xarray - Unified interfaces for grids, data, boundaries, and spectra -
+Extensible plugin system for models, data sources, backends, and postprocessors
+- Robust logging and formatting for consistent output and diagnostics - Example
+  notebooks and comprehensive documentation for rapid onboarding - Support for
+  local, Docker, and HPC execution backends
+
+rompy is under active development—features, model support, and documentation
+are continually evolving. Contributions and feedback are welcome!
+
+
+********
+Releases
+********
+
+0.5.0 (2025-07-13)
+___________________
+
+New Features
+------------
+* Improved logging for SCHISM model components.
+* Added string formatting methods for SCHISM components.
+* Added backend testing and execution scripts.
+* Added backend config examples and quickstart test script.
+* Added backend demo notebook and documentation.
+* Added support for multiple include_modules in docker.
+* Added docker backend test and setup.
+
+Bug Fixes
+---------
+* Fixed backend demo notebook.
+* Fixed merge issues and improved PyLibs import handling.
+* Fixed mounting workspace in docker.
+* Fixed issues from merge and removed redundant code.
+
+Internal Changes
+----------------
+* Refactored backend approach using strong typing.
+* Improved backend docs and tutorial.
+* Consolidated documentation and removed legacy sections.
+* Improved INPUT file diagnostics in Docker container.
+
+
+0.4.0 (2025-07-10)
+___________________
+
+New Features
+------------
+* Refactored SCHISM boundary conditions, unified SCHISMDataTides and SCHISMDataOcean into SCHISMDataBoundaryConditions.
+* Added support for pyTMD for tidal forcing.
+* Added tidal database and updated yaml of tidal runs.
+* Added boundary condition examples and documentation.
+* Added plotting utilities and improved grid plotting.
+* Added support for v5.12 vegetation model.
+* Added MDT specification for TidalDataset for Z0.
+
+Bug Fixes
+---------
+* Fixed duplicated subfolder for oceanum-atlas in database.json.
+* Fixed test cases for pyTMD compatibility.
+* Fixed decorators and case handling for tidal API.
+* Fixed missing station.in file for tidal examples.
+* Fixed case test with new tidal API.
+
+Internal Changes
+----------------
+* Restructured SCHISM boundary condition naming.
+* Overwrote pre-refactor config files with post-refactor versions.
+* Cleaned up code and tests.
+* Updated enum types and documentation.
+
+
+
+0.3.0 (2023-03-29)
+___________________
+
+Major refactor: redefinition of the entire codebase using pydantic models.
+Separation of concerns between runtime information and model configuration.
+Added model_type field and pydantic basegrid.
+Added methods to store and dump original inputs to RompyBaseModel.
+Added json support to CLI.
+Added iso timedelta for JSON serialization.
+Added DataPoint object and timeseries-based sources.
+Added validator for hotfiles against timestep.
+
+Bug Fixes
+---------
+Fixed issue with create_model in older versions of pydantic.
+Fixed validator of IDLA to fix serialization issue.
+Fixed path definition in new test.
+Fixed schism serialization issues.
+Fixed bug in string output of regular grid for SWAN.
+
+Internal Changes
+----------------
+Removed convenience imports from core.
+Promoted appdirs dependency from schism to main list.
+Reordered imports.
+Refactored intake source to prevent recursion with dask.
+Cleaned up debug messages and removed redundant code.
+
+0.1.0 (2023-MM-DD)
+___________________
+
+Initial release of rompy with basic functionality for coastal ocean model configuration and execution.
+Provided example Jupyter notebooks for setup, evaluation, and visualization.
+Basic support for SWAN and SCHISM models.
+
+
+.. _`CSIRO`: https://www.csiro.au/en/
+.. _`Oceanum`: https://oceanum.science/

rompy_swan-0.6.0/LICENSE

@@ -0,0 +1,177 @@
+
+                                 Apache License
+                           Version 2.0, January 2004
+                        http://www.apache.org/licenses/
+
+   TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+   1. Definitions.
+
+      "License" shall mean the terms and conditions for use, reproduction,
+      and distribution as defined by Sections 1 through 9 of this document.
+
+      "Licensor" shall mean the copyright owner or entity authorized by
+      the copyright owner that is granting the License.
+
+      "Legal Entity" shall mean the union of the acting entity and all
+      other entities that control, are controlled by, or are under common
+      control with that entity. For the purposes of this definition,
+      "control" means (i) the power, direct or indirect, to cause the
+      direction or management of such entity, whether by contract or
+      otherwise, or (ii) ownership of fifty percent (50%) or more of the
+      outstanding shares, or (iii) beneficial ownership of such entity.
+
+      "You" (or "Your") shall mean an individual or Legal Entity
+      exercising permissions granted by this License.
+
+      "Source" form shall mean the preferred form for making modifications,
+      including but not limited to software source code, documentation
+      source, and configuration files.
+
+      "Object" form shall mean any form resulting from mechanical
+      transformation or translation of a Source form, including but
+      not limited to compiled object code, generated documentation,
+      and conversions to other media types.
+
+      "Work" shall mean the work of authorship, whether in Source or
+      Object form, made available under the License, as indicated by a
+      copyright notice that is included in or attached to the work
+      (an example is provided in the Appendix below).
+
+      "Derivative Works" shall mean any work, whether in Source or Object
+      form, that is based on (or derived from) the Work and for which the
+      editorial revisions, annotations, elaborations, or other modifications
+      represent, as a whole, an original work of authorship. For the purposes
+      of this License, Derivative Works shall not include works that remain
+      separable from, or merely link (or bind by name) to the interfaces of,
+      the Work and Derivative Works thereof.
+
+      "Contribution" shall mean any work of authorship, including
+      the original version of the Work and any modifications or additions
+      to that Work or Derivative Works thereof, that is intentionally
+      submitted to Licensor for inclusion in the Work by the copyright owner
+      or by an individual or Legal Entity authorized to submit on behalf of
+      the copyright owner. For the purposes of this definition, "submitted"
+      means any form of electronic, verbal, or written communication sent
+      to the Licensor or its representatives, including but not limited to
+      communication on electronic mailing lists, source code control systems,
+      and issue tracking systems that are managed by, or on behalf of, the
+      Licensor for the purpose of discussing and improving the Work, but
+      excluding communication that is conspicuously marked or otherwise
+      designated in writing by the copyright owner as "Not a Contribution."
+
+      "Contributor" shall mean Licensor and any individual or Legal Entity
+      on behalf of whom a Contribution has been received by Licensor and
+      subsequently incorporated within the Work.
+
+   2. Grant of Copyright License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      copyright license to reproduce, prepare Derivative Works of,
+      publicly display, publicly perform, sublicense, and distribute the
+      Work and such Derivative Works in Source or Object form.
+
+   3. Grant of Patent License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      (except as stated in this section) patent license to make, have made,
+      use, offer to sell, sell, import, and otherwise transfer the Work,
+      where such license applies only to those patent claims licensable
+      by such Contributor that are necessarily infringed by their
+      Contribution(s) alone or by combination of their Contribution(s)
+      with the Work to which such Contribution(s) was submitted. If You
+      institute patent litigation against any entity (including a
+      cross-claim or counterclaim in a lawsuit) alleging that the Work
+      or a Contribution incorporated within the Work constitutes direct
+      or contributory patent infringement, then any patent licenses
+      granted to You under this License for that Work shall terminate
+      as of the date such litigation is filed.
+
+   4. Redistribution. You may reproduce and distribute copies of the
+      Work or Derivative Works thereof in any medium, with or without
+      modifications, and in Source or Object form, provided that You
+      meet the following conditions:
+
+      (a) You must give any other recipients of the Work or
+          Derivative Works a copy of this License; and
+
+      (b) You must cause any modified files to carry prominent notices
+          stating that You changed the files; and
+
+      (c) You must retain, in the Source form of any Derivative Works
+          that You distribute, all copyright, patent, trademark, and
+          attribution notices from the Source form of the Work,
+          excluding those notices that do not pertain to any part of
+          the Derivative Works; and
+
+      (d) If the Work includes a "NOTICE" text file as part of its
+          distribution, then any Derivative Works that You distribute must
+          include a readable copy of the attribution notices contained
+          within such NOTICE file, excluding those notices that do not
+          pertain to any part of the Derivative Works, in at least one
+          of the following places: within a NOTICE text file distributed
+          as part of the Derivative Works; within the Source form or
+          documentation, if provided along with the Derivative Works; or,
+          within a display generated by the Derivative Works, if and
+          wherever such third-party notices normally appear. The contents
+          of the NOTICE file are for informational purposes only and
+          do not modify the License. You may add Your own attribution
+          notices within Derivative Works that You distribute, alongside
+          or as an addendum to the NOTICE text from the Work, provided
+          that such additional attribution notices cannot be construed
+          as modifying the License.
+
+      You may add Your own copyright statement to Your modifications and
+      may provide additional or different license terms and conditions
+      for use, reproduction, or distribution of Your modifications, or
+      for any such Derivative Works as a whole, provided Your use,
+      reproduction, and distribution of the Work otherwise complies with
+      the conditions stated in this License.
+
+   5. Submission of Contributions. Unless You explicitly state otherwise,
+      any Contribution intentionally submitted for inclusion in the Work
+      by You to the Licensor shall be under the terms and conditions of
+      this License, without any additional terms or conditions.
+      Notwithstanding the above, nothing herein shall supersede or modify
+      the terms of any separate license agreement you may have executed
+      with Licensor regarding such Contributions.
+
+   6. Trademarks. This License does not grant permission to use the trade
+      names, trademarks, service marks, or product names of the Licensor,
+      except as required for reasonable and customary use in describing the
+      origin of the Work and reproducing the content of the NOTICE file.
+
+   7. Disclaimer of Warranty. Unless required by applicable law or
+      agreed to in writing, Licensor provides the Work (and each
+      Contributor provides its Contributions) on an "AS IS" BASIS,
+      WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+      implied, including, without limitation, any warranties or conditions
+      of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+      PARTICULAR PURPOSE. You are solely responsible for determining the
+      appropriateness of using or redistributing the Work and assume any
+      risks associated with Your exercise of permissions under this License.
+
+   8. Limitation of Liability. In no event and under no legal theory,
+      whether in tort (including negligence), contract, or otherwise,
+      unless required by applicable law (such as deliberate and grossly
+      negligent acts) or agreed to in writing, shall any Contributor be
+      liable to You for damages, including any direct, indirect, special,
+      incidental, or consequential damages of any character arising as a
+      result of this License or out of the use or inability to use the
+      Work (including but not limited to damages for loss of goodwill,
+      work stoppage, computer failure or malfunction, or any and all
+      other commercial damages or losses), even if such Contributor
+      has been advised of the possibility of such damages.
+
+   9. Accepting Warranty or Additional Liability. While redistributing
+      the Work or Derivative Works thereof, You may choose to offer,
+      and charge a fee for, acceptance of support, warranty, indemnity,
+      or other liability obligations and/or rights consistent with this
+      License. However, in accepting such obligations, You may act only
+      on Your own behalf and on Your sole responsibility, not on behalf
+      of any other Contributor, and only if You agree to indemnify,
+      defend, and hold each Contributor harmless for any liability
+      incurred by, or claims asserted against, such Contributor by reason
+      of your accepting any such warranty or additional liability.
+
+   END OF TERMS AND CONDITIONS

rompy_swan-0.6.0/MANIFEST.in

@@ -0,0 +1,16 @@
+include README.md
+include LICENSE
+include HISTORY.rst
+include pyproject.toml
+include setup.cfg
+recursive-include src *.py
+recursive-include tests *.py
+recursive-include src/rompy_swan/templates *
+recursive-include docs *.rst *.py *.bat Makefile
+recursive-exclude * __pycache__
+recursive-exclude * *.py[co]
+prune .git
+prune .pytest_cache
+prune .mypy_cache
+prune build
+prune dist

rompy_swan-0.6.0/NOTICE

@@ -0,0 +1,24 @@
+NOTICE
+
+This product includes software developed by CSIRO and other contributors.
+
+Copyright 2021-2025 CSIRO
+Copyright 2022-2025 Oceanum Ltd (NZ)
+
+Licensed under the Apache License, Version 2.0 (the "License");
+you may not use this file except in compliance with the License.
+You may obtain a copy of the License at:
+
+    http://www.apache.org/licenses/LICENSE-2.0
+
+Unless required by applicable law or agreed to in writing, software
+distributed under the License is distributed on an "AS IS" BASIS,
+WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+See the License for the specific language governing permissions and
+limitations under the License.
+
+This NOTICE file is part of the distribution of rompy.
+It includes attribution for third-party components and contributors
+as required by their respective licenses.
+
+For a full list of contributors, see the CONTRIBUTORS file.

rompy_swan-0.6.0/PKG-INFO

@@ -0,0 +1,115 @@
+Metadata-Version: 2.4
+Name: rompy-swan
+Version: 0.6.0
+Summary: SWAN wave model plugin for rompy
+Author-email: Rompy Contributors <developers@rompy.com>
+Maintainer-email: Rompy Contributors <developers@rompy.com>
+License: Apache Software License 2.0
+Project-URL: bugs, https://github.com/rom-py/rompy-swan/issues
+Project-URL: changelog, https://github.com/rom-py/rompy-swan/blob/master/changelog.md
+Project-URL: homepage, https://github.com/rom-py/rompy-swan
+Classifier: Development Status :: 3 - Alpha
+Classifier: Intended Audience :: Science/Research
+Classifier: License :: OSI Approved :: Apache Software License
+Classifier: Natural Language :: English
+Classifier: Operating System :: OS Independent
+Classifier: Topic :: Scientific/Engineering
+Classifier: Topic :: Scientific/Engineering :: Physics
+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
+License-File: NOTICE
+License-File: AUTHORS.rst
+Requires-Dist: rompy>=0.6
+Requires-Dist: pydantic>2
+Provides-Extra: dev
+Requires-Dist: coverage; extra == "dev"
+Requires-Dist: mypy; extra == "dev"
+Requires-Dist: pytest; extra == "dev"
+Requires-Dist: ruff; extra == "dev"
+Requires-Dist: requests; extra == "dev"
+Requires-Dist: envyaml; extra == "dev"
+Provides-Extra: test
+Requires-Dist: pytest; extra == "test"
+Requires-Dist: coverage; extra == "test"
+Requires-Dist: requests; extra == "test"
+Requires-Dist: envyaml; extra == "test"
+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) is a modular Python library that aims to streamline the setup, configuration, execution, and analysis of coastal ocean models. Rompy combines templated model configuration with powerful xarray-based data handling and pydantic validation, enabling users to efficiently generate model control files and input datasets for a variety of ocean and wave models. The architecture centers on high-level execution control (`ModelRun`) and flexible configuration objects, supporting both persistent scientific model state and runtime backend selection. Rompy provides unified interfaces for grids, data sources, boundary conditions, and spectra, with extensible plugin support for new models and execution environments. Comprehensive documentation, example Jupyter notebooks, and a robust logging/formatting framework make rompy accessible for both research and operational workflows. Current model support includes SWAN and SCHISM, with ongoing development for additional models and cloud/HPC backends.
+
+Key Features:
+- Modular architecture with clear separation of configuration and execution logic
+- Templated, reproducible model configuration using pydantic and xarray
+- Unified interfaces for grids, data, boundaries, and spectra
+- Extensible plugin system for models, data sources, backends, and postprocessors
+- Robust logging and formatting for consistent output and diagnostics
+- Example notebooks and comprehensive documentation for rapid onboarding
+- Support for local, Docker, and HPC execution backends
+
+rompy is under active development—features, model support, and documentation are continually evolving. Contributions and feedback are welcome!
+
+# Documentation
+
+See https://rom-py.github.io/rompy/
+
+# Code Formatting and Pre-commit Hooks
+
+This repository enforces Python code formatting using [black](https://github.com/psf/black) via the pre-commit framework.
+
+To set up pre-commit hooks locally (required for all contributors)::
+
+    pip install pre-commit
+    pre-commit install
+
+This will automatically check code formatting before each commit. To format your code manually, run::
+
+    pre-commit run --all-files
+
+All code must pass black formatting before it can be committed or merged.
+
+# Versioning and Release
+
+This project uses [tbump](https://github.com/dmerejkowsky/tbump) for version management.
+
+To bump the version, run::
+
+    tbump <new_version>
+
+This will update the version in `src/rompy/__init__.py`, commit the change, and optionally create a git tag.
+
+tbump is included in the development requirements (`requirements_dev.txt`).
+
+For more advanced configuration, see `tbump.toml` in the project root.
+
+# Relevant packages
+
+> - [rompy](https://github.com/rom-py/rompy)
+> - [rompy-swan](https://github.com/rom-py/rompy-swan)
+> - [rompy-schism](https://github.com/rom-py/rompy-schism)
+> - [rompy-notebooks](https://github.com/rom-py/rompy-notebooks)

rompy_swan-0.6.0/README.md

@@ -0,0 +1,66 @@
+---
+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) is a modular Python library that aims to streamline the setup, configuration, execution, and analysis of coastal ocean models. Rompy combines templated model configuration with powerful xarray-based data handling and pydantic validation, enabling users to efficiently generate model control files and input datasets for a variety of ocean and wave models. The architecture centers on high-level execution control (`ModelRun`) and flexible configuration objects, supporting both persistent scientific model state and runtime backend selection. Rompy provides unified interfaces for grids, data sources, boundary conditions, and spectra, with extensible plugin support for new models and execution environments. Comprehensive documentation, example Jupyter notebooks, and a robust logging/formatting framework make rompy accessible for both research and operational workflows. Current model support includes SWAN and SCHISM, with ongoing development for additional models and cloud/HPC backends.
+
+Key Features:
+- Modular architecture with clear separation of configuration and execution logic
+- Templated, reproducible model configuration using pydantic and xarray
+- Unified interfaces for grids, data, boundaries, and spectra
+- Extensible plugin system for models, data sources, backends, and postprocessors
+- Robust logging and formatting for consistent output and diagnostics
+- Example notebooks and comprehensive documentation for rapid onboarding
+- Support for local, Docker, and HPC execution backends
+
+rompy is under active development—features, model support, and documentation are continually evolving. Contributions and feedback are welcome!
+
+# Documentation
+
+See https://rom-py.github.io/rompy/
+
+# Code Formatting and Pre-commit Hooks
+
+This repository enforces Python code formatting using [black](https://github.com/psf/black) via the pre-commit framework.
+
+To set up pre-commit hooks locally (required for all contributors)::
+
+    pip install pre-commit
+    pre-commit install
+
+This will automatically check code formatting before each commit. To format your code manually, run::
+
+    pre-commit run --all-files
+
+All code must pass black formatting before it can be committed or merged.
+
+# Versioning and Release
+
+This project uses [tbump](https://github.com/dmerejkowsky/tbump) for version management.
+
+To bump the version, run::
+
+    tbump <new_version>
+
+This will update the version in `src/rompy/__init__.py`, commit the change, and optionally create a git tag.
+
+tbump is included in the development requirements (`requirements_dev.txt`).
+
+For more advanced configuration, see `tbump.toml` in the project root.
+
+# Relevant packages
+
+> - [rompy](https://github.com/rom-py/rompy)
+> - [rompy-swan](https://github.com/rom-py/rompy-swan)
+> - [rompy-schism](https://github.com/rom-py/rompy-schism)
+> - [rompy-notebooks](https://github.com/rom-py/rompy-notebooks)

rompy_swan-0.6.0/README.rst

@@ -0,0 +1,62 @@
+==========
+rompy-swan
+==========
+
+
+.. image:: https://img.shields.io/pypi/v/rompy_swan.svg
+        :target: https://pypi.python.org/pypi/rompy_swan
+
+.. image:: https://img.shields.io/travis/rom-py/rompy_swan.svg
+        :target: https://travis-ci.com/rom-py/rompy_swan
+
+.. image:: https://readthedocs.org/projects/rompy-swan/badge/?version=latest
+        :target: https://rompy-swan.readthedocs.io/en/latest/?version=latest
+        :alt: Documentation Status
+
+
+
+
+SWAN wave model plugin for rompy
+
+
+* Free software: Apache Software License 2.0
+* Documentation: https://rompy-swan.readthedocs.io.
+
+
+Features
+--------
+
+* TODO
+
+
+
+Code Formatting and Pre-commit Hooks
+------------------------------------
+
+This repository enforces Python code formatting using [black](https://github.com/psf/black) via the pre-commit framework.
+
+To set up pre-commit hooks locally (required for all contributors)::
+
+    pip install pre-commit
+    pre-commit install
+
+This will automatically check code formatting before each commit. To format your code manually, run::
+
+    pre-commit run --all-files
+
+All code must pass black formatting before it can be committed or merged.
+
+Versioning and Release
+----------------------
+
+This project uses [tbump](https://github.com/dmerejkowsky/tbump) for version management.
+
+To bump the version, run::
+
+    tbump <new_version>
+
+This will update the version in `src/rompy_swan/__init__.py`, commit the change, and optionally create a git tag.
+
+tbump is included in the development requirements (`requirements_dev.txt`).
+
+For more advanced configuration, see `tbump.toml` in the project root.

rompy_swan-0.6.0/docs/Makefile

@@ -0,0 +1,20 @@
+# Minimal makefile for Sphinx documentation
+#
+
+# You can set these variables from the command line, and also
+# from the environment for the first two.
+SPHINXOPTS    ?=
+SPHINXBUILD   ?= sphinx-build
+SOURCEDIR     = source
+BUILDDIR      = build
+
+# Put it first so that "make" without argument is like "make help".
+help:
+	@$(SPHINXBUILD) -M help "$(SOURCEDIR)" "$(BUILDDIR)" $(SPHINXOPTS) $(O)
+
+.PHONY: help Makefile
+
+# Catch-all target: route all unknown targets to Sphinx using the new
+# "make mode" option.  $(O) is meant as a shortcut for $(SPHINXOPTS).
+%: Makefile
+	@$(SPHINXBUILD) -M $@ "$(SOURCEDIR)" "$(BUILDDIR)" $(SPHINXOPTS) $(O)

rompy_swan-0.6.0/docs/make.bat

@@ -0,0 +1,35 @@
+@ECHO OFF
+
+pushd %~dp0
+
+REM Command file for Sphinx documentation
+
+if "%SPHINXBUILD%" == "" (
+	set SPHINXBUILD=sphinx-build
+)
+set SOURCEDIR=source
+set BUILDDIR=build
+
+if "%1" == "" goto help
+
+%SPHINXBUILD% >NUL 2>NUL
+if errorlevel 9009 (
+	echo.
+	echo.The 'sphinx-build' command was not found. Make sure you have Sphinx
+	echo.installed, then set the SPHINXBUILD environment variable to point
+	echo.to the full path of the 'sphinx-build' executable. Alternatively you
+	echo.may add the Sphinx directory to PATH.
+	echo.
+	echo.If you don't have Sphinx installed, grab it from
+	echo.http://sphinx-doc.org/
+	exit /b 1
+)
+
+%SPHINXBUILD% -M %1 %SOURCEDIR% %BUILDDIR% %SPHINXOPTS% %O%
+goto end
+
+:help
+%SPHINXBUILD% -M help %SOURCEDIR% %BUILDDIR% %SPHINXOPTS% %O%
+
+:end
+popd