From c2f940f908a5b550943875c98e93a304846e49a1 Mon Sep 17 00:00:00 2001
From: Philipp Arras <parras@mpa-garching.mpg.de>
Date: Fri, 23 Jul 2021 13:59:36 +0200
Subject: [PATCH] Add getting_started_4 to html docs
---
.gitignore | 1 +
demos/getting_started_4_CorrelatedFields.ipynb | 7 +++----
docs/generate.sh | 2 +-
docs/source/user/getting_started_4_CorrelatedFields.ipynb | 1 +
docs/source/user/index.rst | 1 +
5 files changed, 7 insertions(+), 5 deletions(-)
create mode 120000 docs/source/user/getting_started_4_CorrelatedFields.ipynb
diff --git a/.gitignore b/.gitignore
index 4ddc01ec0..4add67852 100644
--- a/.gitignore
+++ b/.gitignore
@@ -3,6 +3,7 @@ git_version.py
docs/source/user/getting_started_0.rst
docs/source/user/custom_nonlinearities.rst
+docs/source/user/getting_started_4_CorrelatedFields.rst
# custom
*.txt
diff --git a/demos/getting_started_4_CorrelatedFields.ipynb b/demos/getting_started_4_CorrelatedFields.ipynb
index 5d13704e9..f3a2d6431 100644
--- a/demos/getting_started_4_CorrelatedFields.ipynb
+++ b/demos/getting_started_4_CorrelatedFields.ipynb
@@ -4,7 +4,7 @@
"cell_type": "markdown",
"metadata": {},
"source": [
- "# Notebook showcasing the NIFTy 6 Correlated Field model\n",
+ "# Showcasing the Correlated Field model\n",
"\n",
"**Skip to `Parameter Showcases` for the meat/veggies ;)**\n",
"\n",
@@ -34,7 +34,6 @@
"plt.rcParams['figure.dpi'] = 100\n",
"plt.style.use(\"seaborn-notebook\")\n",
"import numpy as np\n",
- "ift.random.push_sseq_from_seed(43)\n",
"\n",
"n_pix = 256\n",
"x_space = ift.RGSpace(n_pix)"
@@ -391,7 +390,7 @@
"cell_type": "markdown",
"metadata": {},
"source": [
- "## The `offset_mean` parameter of `CorrelatedFieldMaker.make()`\n",
+ "## The `offset_mean` parameter of `CorrelatedFieldMaker()`\n",
"\n",
"The `offset_mean` parameter defines a global additive offset on the field realizations.\n",
"\n",
@@ -424,7 +423,7 @@
"cell_type": "markdown",
"metadata": {},
"source": [
- "## The `offset_std` parameters of `CorrelatedFieldMaker.make()`\n",
+ "## The `offset_std` parameters of `CorrelatedFieldMaker()`\n",
"\n",
"Variation of the global offset of the field are modelled as being log-normally distributed.\n",
"See `The Moment-Matched Log-Normal Distribution` above for details.\n",
diff --git a/docs/generate.sh b/docs/generate.sh
index 8f7283fc8..260c67066 100755
--- a/docs/generate.sh
+++ b/docs/generate.sh
@@ -1,7 +1,7 @@
set -e
FOLDER=docs/source/user/
-for FILE in ${FOLDER}getting_started_0 ${FOLDER}custom_nonlinearities
+for FILE in ${FOLDER}getting_started_0 ${FOLDER}getting_started_4_CorrelatedFields ${FOLDER}custom_nonlinearities
do
if [ ! -f "${FILE}.rst" ] || [ ${FILE}.ipynb -nt ${FILE}.rst ]; then
jupyter-nbconvert --to rst --execute --ExecutePreprocessor.timeout=None ${FILE}.ipynb
diff --git a/docs/source/user/getting_started_4_CorrelatedFields.ipynb b/docs/source/user/getting_started_4_CorrelatedFields.ipynb
new file mode 120000
index 000000000..6405cb0d3
--- /dev/null
+++ b/docs/source/user/getting_started_4_CorrelatedFields.ipynb
@@ -0,0 +1 @@
+../../../demos/getting_started_4_CorrelatedFields.ipynb
\ No newline at end of file
diff --git a/docs/source/user/index.rst b/docs/source/user/index.rst
index 395baacf1..05510df0f 100644
--- a/docs/source/user/index.rst
+++ b/docs/source/user/index.rst
@@ -16,5 +16,6 @@ are found in the `API reference <../mod/nifty8.html>`_.
volume
code
getting_started_0
+ getting_started_4_CorrelatedFields
custom_nonlinearities
citations
--
GitLab