Merge pull request #26 from TchilDill/extras-doc-unit-testing-and-more

v0.7.0
TchilDill · Nov 12, 2023 · be7f5ea · be7f5ea
2 parents 451e8be + cbbf7b1
commit be7f5ea
Show file tree

Hide file tree

Showing 21 changed files with 1,021 additions and 251 deletions.
diff --git a/.vscode/settings.json b/.vscode/settings.json
@@ -4,5 +4,6 @@
     ],
     "python.testing.unittestEnabled": false,
     "python.testing.pytestEnabled": true,
-    "python.formatting.provider": "black"
+    "python.formatting.provider": "black",
+    "editor.inlineSuggest.showToolbar": "onHover"
 }
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -7,6 +7,13 @@ The format is based on [Keep a Changelog](http://keepachangelog.com/)
 and this project adheres to [Semantic Versioning](http://semver.org/),
 and [PEP 440](https://www.python.org/dev/peps/pep-0440/).
 
+## [0.7.0] - 2023-11-12
+
+### Added
+
+- Added soil models:
+  - `openpile.soilmodels.Bothkennar_clay` from the PISA joint-industry project
+
 ## [0.6.0] - 2023-10-23
 
 ### Added 
@@ -19,6 +26,7 @@ and [PEP 440](https://www.python.org/dev/peps/pep-0440/).
   - `openpile.utils.Hb_curves.custom_pisa_sand` and `openpile.utils.Hb_curves.custom_pisa_clay`
   - `openpile.utils.Mb_curves.custom_pisa_sand` and `openpile.utils.Mb_curves.custom_pisa_clay`
 - added soil models:
+  - `openpile.soilmodels.Bothkennar_clay` from the PISA joint-industry project
   - `openpile.soilmodels.Custom_pisa_sand` and `openpile.soilmodels.Custom_pisa_clay`, these models can be used to customise PISA formulations based on external sources, such as an FE model. 
 - new functions to calculate Dunkirk Sand and Cowden Clay normalized parameters, these functions are in the module: `openpile.utils.multipliers` and are the following: `get_cowden_clay_(..)_norm_param()` and `get_dunkirk_sand_(..)_norm_param()`.
 

diff --git a/docs/.DS_Store b/docs/.DS_Store
diff --git a/docs/source/_static/validation/GDSM_D2t.png b/docs/source/_static/validation/GDSM_D2t.png
diff --git a/docs/source/conf.py b/docs/source/conf.py
@@ -31,6 +31,7 @@
     "sphinx.ext.viewcode",
     "sphinx.ext.autodoc",
     "sphinx.ext.todo",
+    "sphinx_copybutton",
     "sphinx.ext.doctest",
     "matplotlib.sphinxext.plot_directive",
 ]
@@ -54,6 +55,15 @@
 templates_path = ["_templates"]
 exclude_patterns = []
 
+# option for the copy button extension
+copybutton_prompt_text = r">>> |\.\.\. "
+copybutton_prompt_is_regexp = True
+
+# option for matplotlib extension
+plot_include_source = True
+plot_html_show_source_link = False
+plot_html_show_formats = False
+
 # -- Options for LaTeX output ------------------------------------------------
 latex_engine = "pdflatex"
 numfig = True

diff --git a/docs/source/introsoilmodels.rst b/docs/source/introsoilmodels.rst
@@ -47,5 +47,9 @@ Please refer to the :ref:`ApplicationProgrammingInterface` for more details and
     Houlsby, G. T., Gavin, K. G., Igoe, D. J. P., Jardine, R. J., Martin, C. M., McAdam, R. A., 
     Pedro, A. M. G. & Potts, D. M. (2020). PISA design model for monopiles for offshore wind 
     turbines: application to a marine sand. Géotechnique, https://doi.org/10.1680/jgeot.18.P.277.
+.. [BABH20] Burd, H. J., Abadie, C. N., Byrne, B. W., Houlsby, G. T., Martin, C. M., McAdam, R. A., 
+    Jardine, R.J., Pedro, A.M., Potts, D.M., Taborda, D.M., Zdravković, L., and Andrade, M.P. 
+    (2020). Application of the PISA Design Model to Monopiles Embedded in Layered Soils. 
+    Géotechnique 70(11): 1-55. https://doi.org/10.1680/jgeot.20.PISA.009
 .. [Rees97] Reese, L.C. (1997), Analysis of Laterally Loaded Piles in Weak Rock, Journal of Geotechnical
     and Geoenvironmental Engineering, ASCE, vol. 123 (11) Nov., ASCE, pp. 1010-1017.