ZSF documentation

This is the documentation for the ZSF, a Deltares tool to calculate salt intrusion through shipping locks. The documentation covers:

• How to get the ZSF running on your computer. For end-users this means downloading either the Excel workbook, or installing the Python package.

• Making your own calculations, by means of several illustrative examples for both the Excel workbook and Python package.

• The theory on which the ZSF is based, serving as background information on the inner workings of the libzsf core.

• An overview of the C and Python API, e.g. to embed the ZSF in other software.

Note

ZSF is an abbreviation for “Zeesluisformulering”, which would translate to Sea Lock Formulation.

Contents:

• Getting Started
  • Excel workbook
  • Python package
  • C library
  • Fortran interface
  • From Source
• Examples
  • Excel Examples
  • Python Examples
• Theory
  • 1. Introduction
  • 2. Processes and definitions
  • 3. Equations per locking phase
  • 4. Cycle-averaged flows and salinities
  • 5. Numerical approach cycle-averaged values
• API
  • C API
  • Python API
• Support

Indices and tables

• Index

• Module Index

• Search Page