diff --git a/.gitignore b/.gitignore index 4ddc01ec0c674f4ae207f022a8305ba4f7c7f286..4add678523bb06a8bb389aa73ff9badf358898ec 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 5d13704e94527b0b33e6d5d0e025c8d319993ab3..f3a2d6431f83ca2cea58de6de88b4b5887c2b78e 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 8f7283fc8605cf4ce9201be869eac1c090ce2132..260c6706697b9a239ddc10b16ec8c5842312d208 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 0000000000000000000000000000000000000000..6405cb0d34fc94e143381e97fe21a9c6e29677f5 --- /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 395baacf1b66a5f4e2b9397d2a4b7a54f85de289..05510df0f7e32f40937625f70598e599ed304c4a 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