Skip to content

Add preliminary documentation of CHIC integration section to installa… #813

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 2 commits into from
Jan 23, 2025
Merged

Add preliminary documentation of CHIC integration section to installa… #813

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
ed9c69a
Add preliminary documentation of CHIC integration section to installa…
olihen Jan 22, 2025
1896963
Update doc/sphinx/user_manual/installation/installation_methods.md
olihen Jan 23, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
12 changes: 12 additions & 0 deletions doc/sphinx/user_manual/installation/installation_methods.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -147,5 +147,17 @@ If you already cloned ASPECT, use the command `git submodule update -init -recur
```

When ASPECT has been successfully compiled with the World Builder, set the ASPECT global input parameter `World builder file` to the World Builder file location.
:::::

:::::{tab-item} CHIC
The Geodynamic World Builder is integrated into the convection code CHIC (Noack et al., 2015). For this purpose, the Fortran wrapper, found in `source/world_builder/wrapper_fortran.f90`, was included in the CHIC `src/`-directory (see `examples/fortran/example.f90` for an Example). In order to enable the use of the Fortran wrapper module, the static library of the Geodynamic World Builder is linked during the compilation of CHIC. With this addition, the Fortran wrapper module can be used to interface the World Builder in CHIC.

```{important}
As an additional input file, the user has to provide a file in the `.wb` format, the specifics of which are outlined in {ref}`part:user_manual:chap:basic_starter_tutorial:sec:index`. The resulting temperature and compositonal fields are read-in and used as initial fields for a CHIC simulation run.
```

(In the future, you will be able to find more information on CHIC [here](https://www.geo.fu-berlin.de/en/geol/fachrichtungen/planet/projects_noack/Convection-Code/index.html))


:::::
::::::
Loading