.. HOS-Ocean documentation master file, created by sphinx-quickstart on Thu May 30 14:43:42 2024. You can adapt this file completely to your liking, but it should at least contain the root `toctree` directive. Home ==== Overview -------- HOS-Ocean is a numerical model dedicated to the propagation of non-linear wave fields in open ocean with arbitrary constant depth. It is based on the High-Order Spectral (HOS) method which enables the simulation of highly non-linear wavefields. It has been developed at Ecole Centrale de Nantes since 2005 and is used in several research projects. .. figure:: figures/HOS_Ocean_1.png :figwidth: 43% :align: left Free surface elevation at a specific instant for a large-scale HOS-ocean simulation .. figure:: figures/HOS_Ocean_2.png :figwidth: 49% :align: right Zoom on a freak wave appearing during a HOS-ocean simulation | | .. figure:: figures/HOS_Ocean_3.png :figwidth: 45% :align: left Time evolution of the wave spectrum during a HOS-ocean simulation .. note:: A Numerical Wave Tank based on the HOS method, namely HOS-NWT, is also available `here `__. It is dedicated to the generation and propagation of highly non-linear wave fields in wave basins. The proposed model reproduces all features of an ocean wave basin: directional wavemaker, reflective walls and absorbing beach. This documentation details the procedure to download and install HOS-ocean. It also provides the main explanations on how to use the code. HOS-ocean is available to download as a single program to compile and execute. This is written in Fortran language. Citing this work ---------------- **Any publication or report using HOS-Ocean has to refer to the following publications** :cite:p:`bonnefoy2010,ducrozet2016`: .. bibliography:: :style: unsrt :list: bullet :filter: False bonnefoy2010 ducrozet2016 For the use of **HOS-ocean with varying bathymetry**, the following publications should be referenced :cite:p:`gouin2016development,gouin2017propagation,ducrozet2017influence` .. bibliography:: :style: unsrt :list: bullet :filter: False gouin2016development gouin2017propagation ducrozet2017influence For the use of **HOS-ocean with varying current**, the following publication should be referenced :cite:p:`ducrozet2021predicting` .. bibliography:: :style: unsrt :list: bullet :filter: False ducrozet2021predicting 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-ocean 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-ocean 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-ocean in your program and distribute it, your program must also be free software (with GPL or compatible license). .. note:: HOS-ocean may be released under another license for specific commercial softwares. Contact us for details. Download -------- Download of latest release version is available on `the Releases page `__. Developers are welcome to contribute, cloning is available from `HOS-Ocean's official repository `__. .. toctree:: :maxdepth: 2 :caption: Contents: getting-started running-HOS-Ocean choice-numerical-parameters post-processing theory-and-references