create docs for geodynamic setups

JuliaGeodynamics · Mar 2, 2024 · 3601204 · 3601204
1 parent ff6e5a3
commit 3601204
Show file tree

Hide file tree

Showing 3 changed files with 26 additions and 16 deletions.
diff --git a/docs/make.jl b/docs/make.jl
@@ -110,6 +110,7 @@ makedocs(;
             "Tools" => "man/tools.md",
             "Visualisation" => "man/visualise.md",
             "Gravity code" => "man/gravity_code.md",
+            "Geodynamic setups" => "man/geodynamic_setups.md",
             "LaMEM" => "man/lamem.md",
             "Profile Processing" => "man/profile_processing.md"
         ],

diff --git a/docs/src/man/geodynamic_setups.md b/docs/src/man/geodynamic_setups.md
@@ -0,0 +1,23 @@
+# Geodynamic model setups
+
+In order to generate geodynamic simulations from setups created with `GeophysicalModelGenerator.jl`, we provide a few routines that directly create setups 
+
+The routines provided here have the following functionality:
+- Add lithospheric boxes to a setup, that may have a layered structure and various thermal structures
+
+```@docs
+GeophysicalModelGenerator.AddBox!
+GeophysicalModelGenerator.AddLayer!
+GeophysicalModelGenerator.AddSphere!
+GeophysicalModelGenerator.AddEllipsoid!
+GeophysicalModelGenerator.AddCylinder!
+GeophysicalModelGenerator.makeVolcTopo
+GeophysicalModelGenerator.ConstantTemp
+GeophysicalModelGenerator.LinearTemp
+GeophysicalModelGenerator.HalfspaceCoolingTemp
+GeophysicalModelGenerator.SpreadingRateTemp
+GeophysicalModelGenerator.LithosphericTemp
+GeophysicalModelGenerator.ConstantPhase
+GeophysicalModelGenerator.Compute_Phase
+GeophysicalModelGenerator.LithosphericPhases
+```
diff --git a/docs/src/man/lamem.md b/docs/src/man/lamem.md
@@ -1,12 +1,11 @@
 # LaMEM
 
-In order to generate geodynamic simulations from setups created with `GeophysicalModelGenerator.jl`, we provide a few routines that directly create marker input files for the 3D geodynamic modelling software [LaMEM](https://bitbucket.org/bkaus/lamem), which is an open-source cartesian code that is well-suited to perform crustal and lithospheric-scale simulations. 
-If you want to learn how to run LaMEM simulations, please have a look at the [wiki page](https://bitbucket.org/bkaus/lamem/wiki/Home). 
+In order to generate geodynamic simulations from setups created with `GeophysicalModelGenerator.jl`, we provide a few routines that directly create marker input files for the 3D geodynamic modelling software [LaMEM](https://github.com/UniMainzGeo/LaMEM), which is an open-source cartesian code to perform crustal and lithospheric-scale simulations. 
+If you want to learn how to run LaMEM simulations, the easiest way to get started is by looking at [LaMEM.jl](https://github.com/JuliaGeodynamics/LaMEM.jl) which is integrated with `GMG`
 
 The routines provided here have the following functionality:
 - Read LaMEM *.dat files (to get the size of the domain)
 - Read LaMEM processor partitioning file
-- Add lithospheric boxes to a setup, that may have a layered structure and various thermal structures
 - Save LaMEM marker files in serial or in parallel
 - Read a LaMEM timestep
 
@@ -16,19 +15,6 @@ GeophysicalModelGenerator.GetProcessorPartitioning
 GeophysicalModelGenerator.Save_LaMEMTopography
 GeophysicalModelGenerator.Save_LaMEMMarkersParallel
 GeophysicalModelGenerator.ReadData_PVTR
-GeophysicalModelGenerator.AddBox!
-GeophysicalModelGenerator.AddSphere!
-GeophysicalModelGenerator.AddEllipsoid!
-GeophysicalModelGenerator.AddCylinder!
-GeophysicalModelGenerator.makeVolcTopo
-GeophysicalModelGenerator.ConstantTemp
-GeophysicalModelGenerator.LinearTemp
-GeophysicalModelGenerator.HalfspaceCoolingTemp
-GeophysicalModelGenerator.SpreadingRateTemp
-GeophysicalModelGenerator.LithosphericTemp
-GeophysicalModelGenerator.ConstantPhase
-GeophysicalModelGenerator.Compute_Phase
-GeophysicalModelGenerator.LithosphericPhases
 GeophysicalModelGenerator.LaMEM_grid
 GeophysicalModelGenerator.CreatePartitioningFile
 ```