OpenEurOtop
Implémentation Python des méthodes de calcul du guide EurOtop pour l'évaluation du franchissement de vagues sur les ouvrages côtiers.
🎉 Version 1.0.0 - Première version stable de production !
Description
Ce package fournit une implémentation complète des formules et méthodes décrites dans le manuel EurOtop (2018) pour le calcul :
- Du débit de franchissement moyen (mean wave overtopping discharge)
- Des facteurs de réduction pour différentes caractéristiques de structures
- Des paramètres de vagues et conditions hydrauliques
Installation
Installation stable depuis PyPI
pip install openeurotop
Installation avec fonctionnalités Machine Learning
pip install openeurotop[ml]
Installation pour développement
git clone https://github.com/Pavlishenku/OpenEurOtop.git
cd OpenEurOtop
pip install -e .[dev]
Utilisation
Calcul du franchissement pour une digue lisse
from openeurotop import overtopping
# Paramètres
Hm0 = 2.5 # Hauteur significative des vagues (m)
Tm_10 = 6.0 # Période moyenne (s)
h = 10.0 # Profondeur d'eau (m)
Rc = 3.0 # Revanche (m)
alpha = 30.0 # Pente du talus (degrés)
gamma_b = 1.0 # Facteur de berme
gamma_f = 1.0 # Facteur de rugosité
gamma_beta = 1.0 # Facteur d'obliquité
# Calcul
q = overtopping.digue_talus(
Hm0=Hm0,
Tm_10=Tm_10,
h=h,
Rc=Rc,
alpha_deg=alpha,
gamma_b=gamma_b,
gamma_f=gamma_f,
gamma_beta=gamma_beta
)
print(f"Débit de franchissement : {q:.6f} m³/s/m")
Calcul pour un mur vertical
from openeurotop import overtopping
q = overtopping.mur_vertical(
Hm0=2.5,
Tm_10=6.0,
h=10.0,
Rc=3.0,
h_structure=12.0
)
Modules
openeurotop.overtopping: Calculs de franchissement pour différents types de structuresopeneurotop.wave_parameters: Calcul des paramètres de vaguesopeneurotop.reduction_factors: Facteurs de réduction (rugosité, berme, obliquité, etc.)openeurotop.constants: Constantes physiques et coefficients
Références
EurOtop (2018). Manual on wave overtopping of sea defences and related structures. An overtopping manual largely based on European research, but for worldwide application. Van der Meer, J.W., Allsop, N.W.H., Bruce, T., De Rouck, J., Kortenhaus, A., Pullen, T., Schüttrumpf, H., Troch, P. and Zanuttigh, B. www.overtopping-manual.com
Fonctionnalités
- ✅ Implémentation complète des formules EurOtop 2018
- ✅ Support digues à talus (lisses, rugueuses, avec bermes)
- ✅ Support murs verticaux et structures composites
- ✅ Modèles de Machine Learning (Neural Networks, XGBoost)
- ✅ Analyses probabilistes et statistiques
- ✅ >100 tests unitaires avec >95% de couverture
- ✅ Documentation complète avec exemples
- ✅ Notebooks Jupyter interactifs
Documentation
- 📚 Documentation complète
- 📖 Guide utilisateur
- 🔧 Guide de contribution
- 📝 Changelog
- 💻 Exemples et notebooks
Contribution
Les contributions sont les bienvenues ! Consultez le guide de contribution pour plus d'informations.
Développeurs
Pour configurer l'environnement de développement :
git clone https://github.com/Pavlishenku/OpenEurOtop.git
cd OpenEurOtop
pip install -e .[dev]
pytest # Exécuter les tests
Citation
Si vous utilisez OpenEurOtop dans vos recherches, veuillez citer :
@software{openeurotop2025,
title = {OpenEurOtop: Python Implementation of EurOtop Wave Overtopping Manual},
author = {OpenEurOtop Contributors},
year = {2025},
url = {https://github.com/Pavlishenku/OpenEurOtop},
version = {1.0.0}
}
Liens
- 🐍 PyPI
- 📦 GitHub
- 📚 Documentation
- 🐛 Issues
Licence
MIT License
Release files for openeurotop 1.0.0
For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.
Source distribution (sdist)
| File | Size | Uploaded | |
|---|---|---|---|
| openeurotop-1.0.0.tar.gz | 2.7 MB | Details |
Built distribution (wheel)
| File | Interpreter | ABI | Platform | Reset |
|---|---|---|---|---|
| openeurotop-1.0.0-py3-none-any.whl | Python 3 | none | any | Details |
Total release size: 2.8 MB
Release files / openeurotop-1.0.0.tar.gz
| Download URL | openeurotop-1.0.0.tar.gz |
|---|---|
| Size | 2.7 MB |
| Tags | Source |
|
SHA-256 checksum How to use checksums |
05eff0a94f52d41bafe4e74fe26a55247472a623419815df4e546f3391595339
|
|
BLAKE2b-256 checksum How to use checksums |
425c543c8e1176255e542059d321c628aa734f086e7572b1465526c05021b135
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
twine/6.2.0 CPython/3.13.5
|
Release files / openeurotop-1.0.0-py3-none-any.whl
| Download URL | openeurotop-1.0.0-py3-none-any.whl |
|---|---|
| Size | 47.8 kB |
| Tags | Python 3 |
|
SHA-256 checksum How to use checksums |
aa0766763522ce8fd87a6888f6a119bff46ab679515e475e354839a521ebec11
|
|
BLAKE2b-256 checksum How to use checksums |
f384e4b7a49ce041fd35ddeca352b7a07102a3b1261657d9d2aa383840f630aa
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
twine/6.2.0 CPython/3.13.5
|