PyFVCOM2
========

PyFVCOM2 is a Python package for working with FVCOM (Finite Volume Community
Ocean Model) data. It provides tools for reading FVCOM meshes and outputs,
building forcing files, interpolating oceanographic data, analysing tides, and
preparing common FVCOM inputs.

PyFVCOM2 is the successor to PyFVCOM. It keeps the focus on practical FVCOM
pre- and post-processing while modernising the package structure and
documentation.

Where to Start
--------------

* :doc:`installation`
  Install PyFVCOM2 and its scientific Python dependencies.
* :doc:`getting_started`
  Learn the basic workflow and find the first examples to run.
* :doc:`api`
  Browse the generated API reference for modules, classes, and functions.
* :doc:`cookbook/index`
  Follow worked examples for tides, interpolation, restart files, nesting, and
  bathymetry smoothing.

.. toctree::
   :maxdepth: 1
   :caption: Contents

   installation
   getting_started
   cookbook/index
   api
   contributing
   license
   acknowledgements