-
Notifications
You must be signed in to change notification settings - Fork 33
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Merge pull request #558 from gassmoeller/add_cookbooks_to_docs
Add cookbooks to docs
- Loading branch information
Showing
5 changed files
with
37 additions
and
14 deletions.
There are no files selected for viewing
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
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. | ||
::: |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
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 | ||
``` |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1 @@ | ||
../../../cookbooks |
This file was deleted.
Oops, something went wrong.