Skip to content

Commit

Permalink
Merge pull request #558 from gassmoeller/add_cookbooks_to_docs
Browse files Browse the repository at this point in the history
Add cookbooks to docs
  • Loading branch information
gassmoeller authored Feb 14, 2024
2 parents ceb6a89 + 8ddab11 commit 3c5e302
Show file tree
Hide file tree
Showing 5 changed files with 37 additions and 14 deletions.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
24 changes: 24 additions & 0 deletions cookbooks/3d_cartesian_rift/doc/README.md
Original file line number Diff line number Diff line change
@@ -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.
:::
12 changes: 12 additions & 0 deletions cookbooks/index.md
Original file line number Diff line number Diff line change
@@ -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
```
1 change: 1 addition & 0 deletions doc/sphinx/user_manual/cookbooks
14 changes: 0 additions & 14 deletions doc/sphinx/user_manual/cookbooks/index.md

This file was deleted.

0 comments on commit 3c5e302

Please sign in to comment.