added two notebooks, ready for release

agilescientific · Apr 6, 2022 · 71a5397 · 71a5397
1 parent aee9cbf
commit 71a5397
Show file tree

Hide file tree

Showing 7 changed files with 704 additions and 7 deletions.
diff --git a/CHANGES.md b/CHANGES.md
@@ -1,10 +1,12 @@
 # Changelog
 
-## 0.5.4 — coming soon
+## 0.5.4 — 6 April 2022
 
 - Fixed small issue with the Klauder wavelet not working when `autocorrelation` was `False`.
 - Changed the names of the `convolve` arguments to `arr` and `v` to better match NumPy.
 - The version number is now correctly stored in the `__version__` attribute.
+- Added a User Guide notebook on [making wavelets](https://code.agilescientific.com/bruges/userguide/Making_wavelets.html).
+- Added a User Guide notebook on [seismic attributes](https://code.agilescientific.com/bruges/userguide/Seismic_attributes.html).
 
 ## 0.5.3 — 21 February 2022
 

diff --git a/docs/_userguide/Making_wavelets.ipynb b/docs/_userguide/Making_wavelets.ipynb
@@ -322,7 +322,7 @@
     "\n",
     "You need to specify four frequencies when defining an Ormsby wavelet: the low-cut, the low-pass, the high-pass, and the high-cut. Together, these define a trapezoidal spectrum. \n",
     "\n",
-    "Here's an example:"
+    "Here's an example: "
    ]
   },
   {

diff --git a/docs/_userguide/Seismic_attributes.ipynb b/docs/_userguide/Seismic_attributes.ipynb
diff --git a/docs/_userguide/Wedge_models.ipynb b/docs/_userguide/Wedge_models.ipynb
diff --git a/docs/conf.py b/docs/conf.py
@@ -58,6 +58,10 @@ def setup(app):
 
 myst_enable_extensions = ["dollarmath", "amsmath"]
 
+# MyST notebook execution
+jupyter_execute_notebooks = 'force'
+execution_timeout = 120
+
 # Apidoc automation
 # https://pypi.org/project/sphinxcontrib-apidoc/
 # The apidoc extension and this code automatically update apidoc.

diff --git a/docs/data/F3_seismic.npy b/docs/data/F3_seismic.npy
diff --git a/docs/index.rst b/docs/index.rst
@@ -56,6 +56,7 @@ User guide
     userguide/Quick_start_wedge.ipynb
     userguide/Making_wavelets.ipynb
     userguide/Wedge_models.ipynb
+    userguide/Seismic_attributes.ipynb
 
 
 API reference