FASTWATER

What is FASTWATER?

The FASTWATER platform will provide a set of core model data sets, development and processing software, and methodologies that support the transfer of academic knowledge and skills across to the ORE sector with the aim of improving and accelerating the development of robust, calibrated and validated regional hydrodynamic and wave models for the Scottish waters, that capture the key physical processes which impact ORE development.

Full source code is available from the GitLab repository held at The University of Edinburgh.

While FASTWATER is still under development, users should pull the newest code from the GitLab repository regularly. If you have installed the package using the instructions below, you should not need to re-install after pulling new code.

FASTWATER is still under development and is intended to be a research tool, not production-level code. Please submit questions as GitLab issues if you encounter unexpected behaviour or need help using FASTWATER.

Installation

First, pull down the current source code from GitLab either by downloading a zip file or using git clone.

From the command line, while in the main FASTWATER directory, use the following command to install FASTWATER:

pip install -e .

The -e flag signals developer mode, meaning that if you update the code from Gitlab, your installation will automatically take those changes into account without requiring re-installation. Some other essential packages used in FASTWATER may be installed if they do not exist in your system or environment.

If you encounter problems with the above install method, you may try to install dependencies manually before installing FASTWATER. First, ensure you have a recent version of Python (greater than 3.5). Then, install packages numpy, scipy, matplotlib, netCDF4, meshio, metpy, pytides, utm, pytictoc, and scikit-learn.

FASTWATER Platform

• About FASTWATER
  • Licence
• FASTWATER Background
  • What is a Regional Tidal Model?​
  • What are observational measurements?
  • Physical Processes
  • Calibration and Validation
• Mesh Design
  • Meshing Tools
  • Basic Mesh Structure
  • Mesh Refinement
• Cal/Val Methodology
  • Overview
  • Simplfied Process Models
  • Input Parameters and Cal/Val Metrics
  • Gaussian Process Model - Fast Simulation
  • Bayesian Cal/Val
• Base Model
  • Specification
  • Domain Defintion
  • Mesh Generation
  • OpenTelemac Construct
• Case Studies
  • EMEC Tidal Energy Test Site, Falls of Warness, Orkney Islands
  • SIMEC-Atlantis MeyGen Site - Inner Sound, Pentland Firth
• Software Tools
  • FASTWATER Modules
  • Processing Scripts
• Open Data Sets
  • Overview

FASTWATER Package Content

• fastwater.general package
  • Submodules
    • fastwater.general.fileTools module
    • fastwater.general.geometry module
    • fastwater.general.meshTools module
    • fastwater.general.physics module
    • fastwater.general.similitude module
    • fastwater.general.spectral module
    • fastwater.general.statsTools module
    • fastwater.general.substrates module
    • fastwater.general.timeFuncs module
• fastwater.analysis package
  • Submodules
    • fastwater.analysis.dataReaders module
    • fastwater.analysis.flowChar module
    • fastwater.analysis.graphics module
    • fastwater.analysis.tecSpecs module
    • fastwater.analysis.tidal module
    • fastwater.analysis.validation module
    • fastwater.analysis.xtrackReader module
• fastwater.telemac package
  • Submodules
    • fastwater.telemac.dynamics module
    • fastwater.telemac.extraction module
    • fastwater.telemac.tidalAnalysis module
    • fastwater.telemac.vectorfield module
• fastwater.qmesh package
  • Submodules
    • fastwater.qmesh.gmshtools module
    • fastwater.qmesh.gradraster module
    • fastwater.qmesh.otm_bcfile module
• fastwater.otm_gpl package
  • Submodules
    • fastwater.otm_gpl.exceptions module
    • fastwater.otm_gpl.files module
    • fastwater.otm_gpl.geometry module
    • fastwater.otm_gpl.parser_gmsh module
    • fastwater.otm_gpl.parser_kenue module
    • fastwater.otm_gpl.parser_selafin module
    • fastwater.otm_gpl.progressbar module
    • fastwater.otm_gpl.selafin module

Indices and tables

• Index

• Module Index

• Search Page