.. HOS-NWT documentation master file, created by
   sphinx-quickstart on Tue Apr 30 18:06:48 2024.
   You can adapt this file completely to your liking, but it should at least
   contain the root `toctree` directive.

Home
====

Overview
--------

HOS-NWT is a Numerical Wave Tank based on the High-Order Spectral (HOS) method. It is dedicated to the generation and propagation of highly non-linear wave fields in wave basins with arbitrary constant depth. The proposed model reproduce all features of an ocean wave basin: directional wavemaker, reflective walls and absorbing beach. HOS-NWT takes into account free surface nonlinearities as well as wavemaker ones. It has been developed at Ecole Centrale de Nantes since 2003 and is used in several research projects.

.. figure:: figures/HOS_NWT_3.png

   3D focused wave

.. note:: A numerical model based on the HOS method and dedicated to the propagation of non-linear wave fields in open ocean, namely HOS-Ocean, is also available `here <https://gitlab.com/lheea/HOS-ocean>`__.

This wiki details the procedure to download and use HOS-NWT as well as the documentation of the current installation.

HOS-NWT is available to download as a single program to compile and execute. It is written in Fortran language.


Citing this work
----------------

**Any publication or report using HOS-NWT has to refer to the following publications** :cite:p:`bonnefoy2010,ducrozet2012`:

.. bibliography::
   :style: unsrt
   :list: bullet
   :filter: False

   ducrozet2012
   bonnefoy2010

License
-------

This program is free software: you can redistribute it and/or modify it under the terms of the GNU General Public License as published by the Free Software Foundation, either version 3 of the License, or (at your option) any later version.

**Main points** one has to remind **about this license**:

-  HOS-NWT is a free software. This means:

   -  the freedom to use it for any purpose,
   -  the freedom to change it to suit your needs,
   -  the freedom to share it with your friends and neighbors, and
   -  the freedom to share the changes you make.

-  GPL license uses concept of copyleft

   -  HOS-NWT stay a free software, no matter who changes or distributes the program
   -  if you release a modified version to the public in some way, the GPL requires you to make the modified source code available to the program's users, under the GPL.
   -  if you want to include HOS-NWT in your program and distribute it, your program must also be free software (with GPL or compatible license).

-  HOS-NWT may be released under another license for specific commercial softwares. Contact us for details

Download
---------

Download of the latest release version is available `here <https://gitlab.com/lheea/HOS-NWT/-/releases>`__.

Developers are welcome to contribute, cloning is available from the main GitLab page for HOS-NWT: `here <https://gitlab.com/lheea/HOS-NWT>`__.

.. toctree::
   :maxdepth: 2
   :caption: Contents:

   getting-started
   running-HOS-NWT
   wavemaker-motion-files
   choice-numerical-parameters
   post-processing
   benchmark-cases
   theory-and-references