diff --git a/README.md b/README.md index 9d01a47..40f64d9 100644 --- a/README.md +++ b/README.md @@ -1,4 +1,4 @@ -# IHSetDean +# IHSetBernabeu Dean (1991) have proposed the concept of an equilibrium beach profile. Dean (1991) derived the equilibrium beach profile model with the wave energy dissipation similar to other previous works (e.g., Bruun, 1954). The equilibrium beach profile equation is very simple, but has been used by many researchers for coastal engineering. @@ -8,18 +8,18 @@ Dean (1991) have proposed the concept of an equilibrium beach profile. Dean (199 To install this module use: ```sh -pip install https://github.com/IHCantabria/IHSetDean/archive/refs/tags/latest.zip +pip install https://github.com/IHCantabria/IHSetBernabeu/archive/refs/tags/latest.zip ``` Run tests to validate: ```sh -ihsetdean-tests +ihsetbernabeu-tests ``` ## Documentation -Documentation is available at https://ihcantabria.github.io/IHSetDean +Documentation is available at https://ihcantabria.github.io/IHSetBernabeu ## Credits diff --git a/docs/conf.py b/docs/conf.py index 251d597..2f1a39f 100644 --- a/docs/conf.py +++ b/docs/conf.py @@ -5,10 +5,10 @@ # -- Project information ----------------------------------------------------- # https://www.sphinx-doc.org/en/master/usage/configuration.html#project-information -from IHSetDean.__init__ import __version__ +# from IHSetBernabeu.__init__ import __version__ - -project = "IHSetDean" +__version__ = "0.1.0" +project = "IHSetBernabeu" copyright = "2024, Lim, Changbin" author = "Lim, Changbin" version = release = __version__ @@ -16,7 +16,7 @@ html_context = { "display_github": True, # Integrate GitHub "github_user": "ihcantabria", # Username - "github_repo": "IHSetDean", # Repo name + "github_repo": "IHSetBernabeu", # Repo name "github_version": "main", # Version "conf_py_path": "/docs/", } diff --git a/docs/index.md b/docs/index.md index 2c203b6..1ca4ba5 100644 --- a/docs/index.md +++ b/docs/index.md @@ -1,4 +1,4 @@ -# IHSetDean +# IHSetBernabeu ## Summary @@ -6,12 +6,16 @@ Dean (1991) have proposed the concept of an equilibrium beach profile. Dean (199 ## Model formula -Dean (1991) suggested an equilibrium beach profile model based on the wave energy dissipation as follows: +Dean (1991) suggested a simple equilibrium beach profile equation based on the wave energy dissipation as follows: ```text h=Ay^(2/3) h : the water depth -y : the offshore distance -A : the beach scale factor -``` \ No newline at end of file +y : the seaward distance +A : the Dean parameter +``` + +![Definition sketch of equilibrium beach profile model](_static/images/Imagen1.png) + +Fig. Definition sketch of equilibrium beach profile model (Dean, 1991).