Skip to main content

Framework for Sea Level Hydrodynamic simulations

Project description

Framework for Sea Level Hydrodynamic simulations

Documentation Status GitHub release (latest by date) CI CI CI Binder

This is a development project utilising multiple solvers (currently DELFT3D & SCHISM) for simulating sea level height (currently only storm surge). The purpose is to create a simple, portable and transparent way of setting up, running and analysing hydrodynamic computations through python scripts and Jupyter Notebooks (http://jupyter.org). See Notebooks in Tutorial/ for relevant prototypes.

Installation

conda install -c gbrey pyposeidon

Afterwards, for now, one needs to install gmsh manually with

pip install gmsh

Note: Due to an upstream issue, pydap needs to be installed manually. See environment.yml for info.

Prerequisities

DELFT3D needs to be compiled for your system. You can download it from http://oss.deltares.nl/web/delft3d/source-code. See Wiki for more details.

SCHISM needs to be compiled for your system. You can download it from http://columbia.vims.edu/schism/tags/. See http://ccrm.vims.edu/schismweb/ for more info.

You can also install the solvers easily with conda

conda install -c gbrey pschism delft3d4

Tests

There are several sets of tests. You can run pyPoseidon unitests with

pytest

In order to test also the solver integration use

pytest --runschism

or

python --rundelft

if you are using a local installation of the solvers please specify the PATH to the executables in your system such as

export D3D = '/path_to_folder_bin/lnx64/flow2d3d/'

export LD3D = '/path_to_folder_bin/lnx64/flow2d3d/'

export SCHISM = '/path_to_schism_executable'

docs

mkdocs build
mkdocs serve

License

  • The project is released under the EUPL v1.2 license.

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

pyposeidon-0.5.2.tar.gz (153.1 kB view hashes)

Uploaded Source

Built Distribution

pyposeidon-0.5.2-py3-none-any.whl (170.1 kB view hashes)

Uploaded Python 3

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page