netsse.base.SeaState
====================

.. toctree::
   :hidden:

   /api/netsse/base/SeaState.set_params

.. py:class:: netsse.base.SeaState(Hs=0, Tp=0, timestamp=datetime.now(), lat=0, lon=0, depth=0, duration=30 * 60)

   Initialises the sea state at a given time and geographical position in the ocean.

   :param Hs: Significant wave height [m].
   :type Hs: float, default 0
   :param Tp: Peak wave period [s].
   :type Tp: float, default 0
   :param timestamp: Timestamp at which the sea state applies.
   :type timestamp: datetime object, default datetime.now()
   :param lat: Latitude [degrees North].
   :type lat: float, default 0
   :param lon: Longitude [degrees East].
   :type lon: float, default 0
   :param depth: Water depth [m] at the studied location.
   :type depth: float, default 0
   :param duration: Time duration of the sea state [s], by default 30*60 = 1800 s.
   :type duration: float, optional

   .. rubric:: Examples

   >>> seastate = SeaState(Hs,Tp,timestamp,lat,lon,depth,duration)

Methods
-------

.. autoapisummary::

   netsse.base.SeaState.set_params