Wrap HySwash

A python wrap for SWASH numerical model.

Table of contents

1. Description
2. Main Contents
3. Documentation
4. Schemes
5. Install
   1. Install from sources
   2. Install SWASH numerical model
6. Examples
7. Contributors
8. License

Description

Main contents

hyswash: SWASH numerical model wrapper

• notebooks statistical_toolkit
• bluemathtk
  • MDA
  • PCA
  • RBF wrap_swash: SWASH numerical model wrapper
• wswash
  • io: SWASH numerical model input/output operations
  • plots: plotting module
  • postprocessor: SWASH output postprocessor module
  • profiles: customized bathymetry profiles library
  • spectra: spectral analysis for output postprocessing
  • statistics: statistical analysis for output postprocessing
  • waves: waves series generation library
  • wrap: SWASH numerical model python wrap

Documentation

SWASH numerical model detailed documentation can be found at: http://swash.sourceforge.net/

• SWASH install/compile manual
• SWASH user manual

Schemes

Download Executables

---

The last official SWASH Delft execs: https://sourceforge.net/projects/swash/files/swash/

• Only Windows and Linux executables are available, MacOS users should compile it using the 'tar' file.

Install

---

Source code is currently privately hosted on GitLab at: https://gitlab.com/AlbaRicondo/wrap-hyswash

Install from sources

Install requirements. Navigate to the base root of [wrap-hyswash](./) and execute:

   conda env create -f environment.yml

Install SWASH numerical model

Download and Compile SWASH numerical model:

  # you may need to install a fortran compiler
  - For Linux:
    sudo apt install gfortran

  - For MacOS:
    brew install gcc

  # download and unpack
  wget https://swash.sourceforge.io/download/zip/swash-7.01AB.tar.gz
  tar -zxvf swash-7.01AB.tar.gz

  # compile numerical model
  cd swash/
  make config
  make ser

Copy SWASH binary file to module resources

  # Launch a python interpreter
  $ python

  Python 3.6.9 (default, Apr 18 2020, 01:56:04) 
  [GCC 8.4.0] on linux
  Type "help", "copyright", "credits" or "license" for more information.
  
  >>> import wswash 
  >>> wswash.set_swash_binary_file('swash.exe')

Contributors:

Alba Ricondo Cueva ([email protected])
Fernando Mendez Incera ([email protected])

License

This project is licensed under the MIT License - see the license file for details