add a few more clarifications

boriskaus · boriskaus · commit a6c22337747d · 2024-03-09T19:13:27.000+01:00
diff --git a/docs/make.jl b/docs/make.jl
@@ -14,6 +14,7 @@ GMG_root_dir = dirname(@__DIR__)
 
 license = read(joinpath(GMG_root_dir, "LICENSE.md"), String)
 write(joinpath(@__DIR__, "src", "man", "license.md"), license)
+
 # Copy list of authors to not need to synchronize it manually
 authors_text = read(joinpath(GMG_root_dir, "AUTHORS.md"), String)
 # authors_text = replace(authors_text, "in the [LICENSE.md](LICENSE.md) file" => "under [License](@ref)")
@@ -113,7 +114,7 @@ makedocs(;
             "Tools" => "man/tools.md",
             "Visualisation" => "man/visualise.md",
             "Gravity code" => "man/gravity_code.md",
-            "Geodynamic setups" => "man/geodynamic_setups.md",
+            "Numerical model setups" => "man/geodynamic_setups.md",
             "LaMEM" => "man/lamem.md",
             "Profile Processing" => "man/profile_processing.md",
             "Movies" => "man/movies.md"
diff --git a/docs/src/man/geodynamic_setups.md b/docs/src/man/geodynamic_setups.md
@@ -1,9 +1,12 @@
 # Geodynamic model setups
 
-In order to generate geodynamic simulations from setups created with `GeophysicalModelGenerator.jl`, we provide a few routines that directly create setups 
+In order to generate numerical 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
+- Add various geometries (spheres, cuylinders, ellipsoids)
+- Add lithospheric structure
+- Add various 1D thermal structures (and possibilities to combine them)
 
 ```@docs
 GeophysicalModelGenerator.AddBox!
diff --git a/docs/src/man/paraview_output.md b/docs/src/man/paraview_output.md
@@ -1,9 +1,10 @@
 # Paraview output
 
-We have one main routine to generate Paraview output for data that is either stored in a `GeoData` structure (that has lat/lon info), or `ParaviewData` (Cartesian).
+We have one main routine to generate Paraview output for data that is either stored in a `GeoData` structure (that has lat/lon info), or `ParaviewData`, `CartData` (Cartesian).
 If `GeoData` is supplied it is internally automatically converted to the right format. Vectors, such as velocity, are also converted accordingly.
-You can also visualize time-dependent data.
+You can also visualize time-dependent data, or combine existing paraview files into a `*.pvd` paraview collection (that can be used to show a movie)
 ```@docs
-GeophysicalModelGenerator.Write_Paraview
-GeophysicalModelGenerator.Movie_Paraview
+Write_Paraview
+Movie_Paraview
+make_paraview_collection
 ```
diff --git a/docs/src/man/profile_processing.md b/docs/src/man/profile_processing.md
@@ -1,20 +1,21 @@
 # Profile processing
 
-We have number of routines that makes it easier to read various datasets into GMG & create profiles through that data
+We have number of routines that makes it easier to read various datasets into `GMG` & create profiles through that data
 The routines provided here have the following functionality:
 - Read datasets (remote or local) that contains volumetric, surface, point, topograpy or screenshot data
 - Define a profile (horizontal, vertical) with space for (projected) data
 - Project earthquake (point) data onto the profile or intersect surfaces with a vertical profile (e.g., Moho data)
 
 ```@docs
-GeophysicalModelGenerator.load_GMG
-GeophysicalModelGenerator.save_GMG
-GeophysicalModelGenerator.ProfileData
-GeophysicalModelGenerator.ExtractProfileData
-GeophysicalModelGenerator.CreateProfileData
-GeophysicalModelGenerator.GMG_Dataset
-GeophysicalModelGenerator.Load_Dataset_file
-GeophysicalModelGenerator.combine_VolData
-GeophysicalModelGenerator.ExtractProfileData!
-GeophysicalModelGenerator.ReadPickedProfiles
+load_GMG
+save_GMG
+CrossSection
+ProfileData
+ExtractProfileData
+CreateProfileData
+GMG_Dataset
+Load_Dataset_file
+combine_VolData
+ExtractProfileData!
+ReadPickedProfiles
 ```
diff --git a/docs/src/man/tools.md b/docs/src/man/tools.md
@@ -3,22 +3,22 @@
 We have a number of functions with which we can extract sub-data from a 2D or 3D `GeoData` structure.
 
 ```@docs
-GeophysicalModelGenerator.CrossSection
-GeophysicalModelGenerator.ExtractSubvolume
-GeophysicalModelGenerator.InterpolateDataFields
-GeophysicalModelGenerator.VoteMap
-GeophysicalModelGenerator.SubtractHorizontalMean
-GeophysicalModelGenerator.aboveSurface
-GeophysicalModelGenerator.belowSurface
-GeophysicalModelGenerator.interpolateDataOnSurface
-GeophysicalModelGenerator.InterpolateTopographyOnPlane
-GeophysicalModelGenerator.ParseColumns_CSV_File
-GeophysicalModelGenerator.RotateTranslateScale!
-GeophysicalModelGenerator.PointData2NearestGrid
-GeophysicalModelGenerator.Convert2UTMzone
-GeophysicalModelGenerator.Convert2CartData
-GeophysicalModelGenerator.ProjectCartData
-GeophysicalModelGenerator.drape_on_topo
-GeophysicalModelGenerator.LithostaticPressure!
-GeophysicalModelGenerator.CountMap
+CrossSection
+ExtractSubvolume
+InterpolateDataFields
+VoteMap
+SubtractHorizontalMean
+aboveSurface
+belowSurface
+interpolateDataOnSurface
+InterpolateTopographyOnPlane
+ParseColumns_CSV_File
+RotateTranslateScale!
+PointData2NearestGrid
+Convert2UTMzone
+Convert2CartData
+ProjectCartData
+drape_on_topo
+LithostaticPressure!
+CountMap
 ```
diff --git a/ext/GLMakie_Visualisation.jl b/ext/GLMakie_Visualisation.jl
@@ -2,7 +2,8 @@ module GLMakie_Visualisation
 # This contains visualisation widgets which are optionally made available when GLMakie is loaded along with GMG
 
 using Statistics
-using GeophysicalModelGenerator: LonLatDepthGrid, GeoData, CartData, km
+using GeophysicalModelGenerator: LonLatDepthGrid, GeoData, CartData, km, AbstractGeneralGrid
+import GeophysicalModelGenerator: Visualise
 
 # We do not check `isdefined(Base, :get_extension)` as recommended since
 # Julia v1.9.0 does not load package extensions when their dependency is
@@ -26,7 +27,7 @@ All fields in the dataset can be explored, and if the optional parameter `Topogr
 Note that this requires orthogonal grids, so it will work with a `GeoData` set, or with an orthogonal `CartData` set.
 Note that you may have to use `ProjectCartData` to project it to orthogonal cartesian coordinates.
 """
-function Visualise(Data; Topography=nothing, Topo_range=nothing)
+function Visualise(Data::AbstractGeneralGrid; Topography=nothing, Topo_range=nothing)
 
 
     axis_equal = false;  # in case we use x/y/z data in km, this is useful 
