diff --git a/cookbooks/3d_cartesian_rift/doc/1000K_temperature_contour.png b/cookbooks/3d_cartesian_rift/doc/1000K_temperature_contour.png new file mode 100644 index 000000000..e73c8f132 Binary files /dev/null and b/cookbooks/3d_cartesian_rift/doc/1000K_temperature_contour.png differ diff --git a/cookbooks/3d_cartesian_rift/doc/README.md b/cookbooks/3d_cartesian_rift/doc/README.md new file mode 100644 index 000000000..7ce500a09 --- /dev/null +++ b/cookbooks/3d_cartesian_rift/doc/README.md @@ -0,0 +1,24 @@ +(part:user_manual:chap:cookbooks:sec:3d_cartesian_rift)= +3D Cartesian Rift +====================== + +A simple setup of a rift in a Cartesian box, in which two plates are spreading at a constant spreading rate. +The files can be found [here](https://github.com/GeodynamicWorldBuilder/WorldBuilder/tree/main/cookbooks/3d_cartesian_rift). + +The relevant part of the World Builder file looks like this: + +:::{literalinclude} ../3d_cartesian_rift.wb +:language: json +:lineno-start: 1 +::: + +And the generated output model looks like this: + +:::{figure} 1000K_temperature_contour.png +:name: 3D_cartesian_rift_temperature_contour +:alt: 3D Cartesian Rift cookbook temperature contour. +:align: center + +The 1000 K temperature isosurface of the 3D Cartesian rift cookbook. Colors represent the depth of the isosurface in meters and the +black box represents the boundaries of the model setup. +::: diff --git a/cookbooks/index.md b/cookbooks/index.md new file mode 100644 index 000000000..2e6f53e5f --- /dev/null +++ b/cookbooks/index.md @@ -0,0 +1,12 @@ +(part:user_manual:chap:cookbooks:sec:index)= +Cookbooks +====================== + +This section contains self-contained cookbooks on how to design different geodynamic setups. Cookbook folders contain World Builder parameter files, grid output files, and optionally a documentation folder called `doc`. The documentation folder contains markdown files and figures, which are incorporated into the online documentation and explain particular features about the cookbook. + + +```{toctree} +: hidden: + +3d_cartesian_rift/doc/README +``` diff --git a/doc/sphinx/user_manual/cookbooks b/doc/sphinx/user_manual/cookbooks new file mode 120000 index 000000000..c677ad91d --- /dev/null +++ b/doc/sphinx/user_manual/cookbooks @@ -0,0 +1 @@ +../../../cookbooks \ No newline at end of file diff --git a/doc/sphinx/user_manual/cookbooks/index.md b/doc/sphinx/user_manual/cookbooks/index.md deleted file mode 100644 index cd2b0a47d..000000000 --- a/doc/sphinx/user_manual/cookbooks/index.md +++ /dev/null @@ -1,14 +0,0 @@ -(part:user_manual:chap:cookbooks:sec:index)= -Cookbooks -====================== - -```{todo} -This section contains self contained cookbooks on how to design different geodynamic setups. - -Examples of cookbooks could be how to setup a (more) realistic 2D or 3D subduction zone, how to use topography, how to use slab2 datasets, adding world fault databases, etc. -``` - -```{toctree} -:hidden: - -``` \ No newline at end of file