Skip to main content

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.

Metadata

Release files for pyposeidon 0.5.2

For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.

Source distribution (sdist)

Source distribution for pyposeidon 0.5.2
File Size Uploaded
pyposeidon-0.5.2.tar.gz 153.1 kB Details

Built distribution (wheel)

Table of built distributions (wheels) for pyposeidon 0.5.2
File Interpreter ABI Platform
pyposeidon-0.5.2-py3-none-any.whl Python 3 none any Details

Total release size: 323.2 kB

Release files / pyposeidon-0.5.2.tar.gz

Download URL pyposeidon-0.5.2.tar.gz
Size 153.1 kB
Tags Source
SHA-256 checksum
How to use checksums
2829101cf72eadb8270b7b2b57bcef590815c2ae707f871bd89d176c0974672c
BLAKE2b-256 checksum
How to use checksums
7ee49db5ff1db51873bee11790a0daec3337fba9fbd809e43974e01535e89bff
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via poetry/1.1.4 CPython/3.9.2 Darwin/19.6.0

Release files / pyposeidon-0.5.2-py3-none-any.whl

Download URL pyposeidon-0.5.2-py3-none-any.whl
Size 170.1 kB
Tags Python 3
SHA-256 checksum
How to use checksums
a82d20bc780236cee8943c5222c2282513861229ef7de808ade25293f8f09409
BLAKE2b-256 checksum
How to use checksums
fcc92f55e2599d28f682bab69a44cf78d8c717114ddcb12f7a94c04f9a60988c
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via poetry/1.1.4 CPython/3.9.2 Darwin/19.6.0

Release history Release notifications | RSS feed

This release

0.5.2 This release

2 release files

Anthropic, PBC Visionary sponsor Bloomberg Visionary sponsor Hudson River Trading Visionary sponsor Meta Visionary sponsor NVIDIA Visionary sponsor Microsoft Sustainability sponsor Depot Continuous Integration AWS Cloud computing and Security Sponsor Datadog Monitoring Fastly CDN Google Download Analytics Sentry Error logging StatusPage Status page