effluent.roms
=============

.. py:module:: effluent.roms

.. autoapi-nested-parse::

   The module contains functions for working with ROMS datasets



Functions
---------

.. autoapisummary::

   effluent.roms.compute_azimuthal_vel
   effluent.roms.compute_dens
   effluent.roms.compute_zrho
   effluent.roms.compute_zrho_star
   effluent.roms.load_location
   effluent.roms.select_xy


Module Contents
---------------

.. py:function:: compute_azimuthal_vel(dset, az)

   Compute directional current velocity

   :param dset: ROMS dataset
   :param az: The direction in which to measure the current
   :return: An xarray.DataArray representing the current velocity


.. py:function:: compute_dens(dset)

   Compute variable ``dens`` from a ROMS dataset

   :param dset: ROMS dataset
   :return: Density variable


.. py:function:: compute_zrho(dset)

   Compute z_rho variable from a ROMS dataset

   The z_rho variable is negative depth, with tidal variation

   :param dset: ROMS dataset
   :return: The z_rho variable


.. py:function:: compute_zrho_star(dset)

   Compute z_rho_star variable from a ROMS dataset

   The z_rho_star variable is negative depth, without tidal variation

   :param dset: ROMS dataset
   :return: The z_rho_star variable


.. py:function:: load_location(file, lat, lon, az)

   Load ROMS dataset at specific location

   The output coordinates are 'time' and 'depth'. Fields are interpolated to the
   desired position, and the depth of each vertical level is computed. Current
   velocities are rotated according to the specified azimuthal orientation.

   :param file: Name of ROMS file(s), or wildcard pattern
   :param lat: Latitude of location
   :param lon: Longitude of location
   :param az: Azimuthal orientation of u velocity (0 is north, 90 is east)
   :return: An xarray.Dataset object


.. py:function:: select_xy(dset, x, y)

   Select a single x, y point within ROMS dataset

   The function interpolates u, v variables to midpoint values

   :param dset: ROMS dataset
   :param x: The dataset x coordinate
   :param y: The dataset y coordinate
   :return: Single-point dataset