Add files via upload

CHANGELOG.md

@@ -1,3 +1,3 @@
-# 2024.02.23
-
-- Features: Implements Dean article
+# 2024.02.23
+
+- Features: Implements Dean article

README.md

@@ -1,26 +1,26 @@
-# IHSetDean
-
-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.
-
-
-## Installation and use
-
-To install this module use:
-
-```sh
-pip install https://github.com/IHCantabria/IHSetDean/archive/refs/tags/latest.zip
-```
-
-Run tests to validate:
-
-```sh
-ihsetdean-tests
-```
-
-## Documentation
-
-Documentation is available at https://ihcantabria.github.io/IHSetDean
-
-## Credits
-
-Developed and maintained by Lim, Changbin @ IHCantabria.
+# IHSetDean
+
+Miller and Dean (2004) proposed a simple model for shoreline evolution using several field datasets. The model is developed based on the observation that shoreline positions change as a function of an equilibrium position. The model includes three adjustable parameters that represent the baseline conditions under which shoreline displacement is calculated to minimize the error. This model is very efficient because it only represents the shoreline response to the process and only requires input of readily available storm surge and water level data.
+
+
+## Installation and use
+
+To install this module use:
+
+```sh
+pip install https://github.com/IHCantabria/IHSetDean/archive/refs/tags/latest.zip
+```
+
+Run tests to validate:
+
+```sh
+ihsetdean-tests
+```
+
+## Documentation
+
+Documentation is available at https://ihcantabria.github.io/IHSetDean
+
+## Credits
+
+Developed and maintained by Lim, Changbin @ IHCantabria.

docs/Makefile

@@ -1,20 +1,20 @@
-# Minimal makefile for Sphinx documentation
-#
-
-# You can set these variables from the command line, and also
-# from the environment for the first two.
-SPHINXOPTS    ?=
-SPHINXBUILD   ?= sphinx-build
-SOURCEDIR     = .
-BUILDDIR      = _build
-
-# Put it first so that "make" without argument is like "make help".
-help:
-	@$(SPHINXBUILD) -M help "$(SOURCEDIR)" "$(BUILDDIR)" $(SPHINXOPTS) $(O)
-
-.PHONY: help Makefile
-
-# Catch-all target: route all unknown targets to Sphinx using the new
-# "make mode" option.  $(O) is meant as a shortcut for $(SPHINXOPTS).
-%: Makefile
+# Minimal makefile for Sphinx documentation
+#
+
+# You can set these variables from the command line, and also
+# from the environment for the first two.
+SPHINXOPTS    ?=
+SPHINXBUILD   ?= sphinx-build
+SOURCEDIR     = .
+BUILDDIR      = _build
+
+# Put it first so that "make" without argument is like "make help".
+help:
+	@$(SPHINXBUILD) -M help "$(SOURCEDIR)" "$(BUILDDIR)" $(SPHINXOPTS) $(O)
+
+.PHONY: help Makefile
+
+# Catch-all target: route all unknown targets to Sphinx using the new
+# "make mode" option.  $(O) is meant as a shortcut for $(SPHINXOPTS).
+%: Makefile
 	@$(SPHINXBUILD) -M $@ "$(SOURCEDIR)" "$(BUILDDIR)" $(SPHINXOPTS) $(O)

docs/conf.py

@@ -1,52 +1,52 @@
-# Configuration file for the Sphinx documentation builder.
-#
-# For the full list of built-in configuration values, see the documentation:
-# https://www.sphinx-doc.org/en/master/usage/configuration.html
-
-# -- Project information -----------------------------------------------------
-# https://www.sphinx-doc.org/en/master/usage/configuration.html#project-information
-from IHSetDean.__init__ import __version__
-
-
-project = "IHSetDean"
-copyright = "2024, Lim, Changbin"
-author = "Lim, Changbin"
-version = release = __version__
-
-html_context = {
-    "display_github": True,  # Integrate GitHub
-    "github_user": "ihcantabria",  # Username
-    "github_repo": "IHSetDean",  # Repo name
-    "github_version": "main",  # Version
-    "conf_py_path": "/docs/",
-}
-
-# -- General configuration ---------------------------------------------------
-# https://www.sphinx-doc.org/en/master/usage/configuration.html#general-configuration
-
-extensions = [
-    "sphinx.ext.autodoc",
-    "sphinx.ext.napoleon",
-    "sphinx_rtd_theme",
-    "myst_nb",
-    # 'sphinxcontrib.autodoc_pydantic',
-    "sphinx.ext.autosummary",
-]
-templates_path = ["_templates"]
-exclude_patterns = ["_build", "Thumbs.db", ".DS_Store"]
-
-
-# -- Options for HTML output -------------------------------------------------
-# https://www.sphinx-doc.org/en/master/usage/configuration.html#options-for-html-output
-
-html_theme = "sphinx_rtd_theme"
-html_theme_options = {
-    "display_version": True,
-    "style_external_links": False,
-}
-# html_theme = 'furo'
-# html_theme = 'sphinx_book_theme'
-
-html_static_path = ["_static"]
-html_logo = ""
-html_title = " v" + release
+# Configuration file for the Sphinx documentation builder.
+#
+# For the full list of built-in configuration values, see the documentation:
+# https://www.sphinx-doc.org/en/master/usage/configuration.html
+
+# -- Project information -----------------------------------------------------
+# https://www.sphinx-doc.org/en/master/usage/configuration.html#project-information
+from IHSetDean.__init__ import __version__
+
+
+project = "IHSetDean"
+copyright = "2024, Lim, Changbin"
+author = "Lim, Changbin"
+version = release = __version__
+
+html_context = {
+    "display_github": True,  # Integrate GitHub
+    "github_user": "ihcantabria",  # Username
+    "github_repo": "IHSetDean",  # Repo name
+    "github_version": "main",  # Version
+    "conf_py_path": "/docs/",
+}
+
+# -- General configuration ---------------------------------------------------
+# https://www.sphinx-doc.org/en/master/usage/configuration.html#general-configuration
+
+extensions = [
+    "sphinx.ext.autodoc",
+    "sphinx.ext.napoleon",
+    "sphinx_rtd_theme",
+    "myst_nb",
+    # 'sphinxcontrib.autodoc_pydantic',
+    "sphinx.ext.autosummary",
+]
+templates_path = ["_templates"]
+exclude_patterns = ["_build", "Thumbs.db", ".DS_Store"]
+
+
+# -- Options for HTML output -------------------------------------------------
+# https://www.sphinx-doc.org/en/master/usage/configuration.html#options-for-html-output
+
+html_theme = "sphinx_rtd_theme"
+html_theme_options = {
+    "display_version": True,
+    "style_external_links": False,
+}
+# html_theme = 'furo'
+# html_theme = 'sphinx_book_theme'
+
+html_static_path = ["_static"]
+html_logo = ""
+html_title = " v" + release

docs/index.md

@@ -1,21 +1,32 @@
-# IHSetDean
-
-## Summary
-
-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.
-
-## Model formula
-
-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 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).
+# IHSetDean
+
+## Summary
+
+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.
+
+## Model formula
+
+Miller and Dean (2004) suggested a simple shoreline evolution model based on the imbalance of shoreline change between an equilibrium shoreline change and shoreline position as follows:
+
+```text
+(∂S(t))/∂t=k(S_eq (t)-S(t))
+
+S(t) : the shoreline position at time t
+S_eq : the equilibrium shoreline position
+k : the calibration parameter for the rate at which the shoreline approaches equilibrium (k; k=k_a H_b^2; k=k_a H_b^3; k=k_a Ω)
+```
+
+Miller and Dean (2004) proposed an equilibrium shoreline change owing to the change of sea level (Fig. 4 1):
+
+```text
+S_eq=-W^* (t)((0.068H_b+S)/(B+1.28H_b ))
+
+H_b : the breaking wave height
+S : the change in local water level
+B : the berm wave height
+W^* : the width of the active surf zone
+```
+
+![Definition sketch of shoreline evolution](_static/images/Imagen1.png)
+
+Fig. 4 1. Definition sketch of shoreline evolution according the change of water level owing to storm surge and wave setup (Miller and Dean, 2004).

docs/make.bat

@@ -1,35 +1,35 @@
-@ECHO OFF
-
-pushd %~dp0
-
-REM Command file for Sphinx documentation
-
-if "%SPHINXBUILD%" == "" (
-	set SPHINXBUILD=sphinx-build
-)
-set SOURCEDIR=.
-set BUILDDIR=_build
-
-%SPHINXBUILD% >NUL 2>NUL
-if errorlevel 9009 (
-	echo.
-	echo.The 'sphinx-build' command was not found. Make sure you have Sphinx
-	echo.installed, then set the SPHINXBUILD environment variable to point
-	echo.to the full path of the 'sphinx-build' executable. Alternatively you
-	echo.may add the Sphinx directory to PATH.
-	echo.
-	echo.If you don't have Sphinx installed, grab it from
-	echo.https://www.sphinx-doc.org/
-	exit /b 1
-)
-
-if "%1" == "" goto help
-
-%SPHINXBUILD% -M %1 %SOURCEDIR% %BUILDDIR% %SPHINXOPTS% %O%
-goto end
-
-:help
-%SPHINXBUILD% -M help %SOURCEDIR% %BUILDDIR% %SPHINXOPTS% %O%
-
-:end
+@ECHO OFF
+
+pushd %~dp0
+
+REM Command file for Sphinx documentation
+
+if "%SPHINXBUILD%" == "" (
+	set SPHINXBUILD=sphinx-build
+)
+set SOURCEDIR=.
+set BUILDDIR=_build
+
+%SPHINXBUILD% >NUL 2>NUL
+if errorlevel 9009 (
+	echo.
+	echo.The 'sphinx-build' command was not found. Make sure you have Sphinx
+	echo.installed, then set the SPHINXBUILD environment variable to point
+	echo.to the full path of the 'sphinx-build' executable. Alternatively you
+	echo.may add the Sphinx directory to PATH.
+	echo.
+	echo.If you don't have Sphinx installed, grab it from
+	echo.https://www.sphinx-doc.org/
+	exit /b 1
+)
+
+if "%1" == "" goto help
+
+%SPHINXBUILD% -M %1 %SOURCEDIR% %BUILDDIR% %SPHINXOPTS% %O%
+goto end
+
+:help
+%SPHINXBUILD% -M help %SOURCEDIR% %BUILDDIR% %SPHINXOPTS% %O%
+
+:end
 popd