Paraview_output.jl

Author: boriskaus

README.md

@@ -33,7 +33,7 @@ Some of the key features are:
 - Create initial model setups for the 3D geodynamic code [LaMEM](https://github.com/UniMainzGeo/LaMEM).
 - Import LaMEM timesteps.
 
-All data is transformed into either a `GeoData` or a `UTMData`  structure which contains info about `longitude/latitude/depth`, `ew/ns/depth` coordinates along with an arbitrary number of scalar/vector datasets, respectively. All data can be exported to Paraview with the `Write_Paraview` routine, which transfers the data to a `ParaviewData` structure (that contains Cartesian Earth-Centered-Earth-Fixed (ECEF) `x/y/z` coordinates, used for plotting)
+All data is transformed into either a `GeoData` or a `UTMData`  structure which contains info about `longitude/latitude/depth`, `ew/ns/depth` coordinates along with an arbitrary number of scalar/vector datasets, respectively. All data can be exported to Paraview with the `write_Paraview` routine, which transfers the data to a `ParaviewData` structure (that contains Cartesian Earth-Centered-Earth-Fixed (ECEF) `x/y/z` coordinates, used for plotting)
 
 ## Usage
 The best way to learn how to use this is to install the package (see below) and look at the tutorials in the [manual](https://juliageodynamics.github.io/GeophysicalModelGenerator.jl/dev/).

docs/src/man/Tutorial_AlpineData.md

@@ -36,10 +36,10 @@ The data is available in different resolutions; see [here](http://gmt.soest.hawa
 
 If you have issues with loading the topography with `GMT`, there is also the alternative to download the data yourself and import it using `Rasters.jl`.
 
-We can now export this data to a `VTK` format so that we can visualize it with `Paraview`. To do so, `GMG` provides the function `Write_Paraview`:
+We can now export this data to a `VTK` format so that we can visualize it with `Paraview`. To do so, `GMG` provides the function `write_Paraview`:
 
 ```julia
-Write_Paraview(Topo, "Topography_Alps")
+write_Paraview(Topo, "Topography_Alps")
 ```
 
 Also, if you want to save this data for later use in julia, you can save it as `*.jld2` file using the function `save_GMG`:
@@ -156,7 +156,7 @@ for iunit = 1:length(units)
     #for later checking, we can now save the original point data as a VTK file:
     data_Moho = GeophysicalModelGenerator.GeoData(lon_tmp,lat_tmp,depth_tmp,(MohoDepth=depth_tmp*km,))
     filename = "Mroczek_Moho_" * units[iunit]
-    Write_Paraview(data_Moho, filename, PointsData=true)
+    write_Paraview(data_Moho, filename, PointsData=true)
 
     #Now we create a KDTree for an effective nearest neighbor determination;
     kdtree = KDTree([lon_tmp';lat_tmp']; leafsize = 10)
@@ -187,7 +187,7 @@ for iunit = 1:length(units)
     #Finally, we can now export that data to VTK and save a `jld2` file using the `save_GMG` routine
     Data_Moho = GeophysicalModelGenerator.GeoData(Lon, Lat, Depth, (MohoDepth=Depth,PointDist=Dist),Data_attribs)
     filename = "Mrozek_Moho_Grid_" * units[iunit]
-    Write_Paraview(Data_Moho, filename)
+    write_Paraview(Data_Moho, filename)
     save_GMG(filename,Topo)
 
 end
@@ -218,7 +218,7 @@ nothing #hide
 As before, we can export this dataset to `VTK` and also save it as a `jld2` file (as we are now exporting point data, we have to use the option `PointsData=true`):
 
 ```julia
-Write_Paraview(Data_ISC, "EQ_ISC", PointsData=true);
+write_Paraview(Data_ISC, "EQ_ISC", PointsData=true);
 save_GMG("EQ_ISC",Data_ISC)
 ```
 
@@ -380,7 +380,7 @@ Data_GPS_Sanchez = GeoData(Lon,Lat,topo_v,(Velocity_mm_year=(Ve,Vn,Vz),V_north=V
 And as always, we'll save everything in `VTK` format and in `jld2` format
 
 ```julia
-Write_Paraview(Data_GPS_Sanchez, "GPS_Sanchez")
+write_Paraview(Data_GPS_Sanchez, "GPS_Sanchez")
 save_GMG("GPS_Sanchez",Data_GPS_Sanchez)
 ```
 
@@ -445,7 +445,7 @@ nothing #hide
 And then we save it again.
 
 ```julia
-Write_Paraview(Data, "Rappisi2022")
+write_Paraview(Data, "Rappisi2022")
 save_GMG("Rappisi2022",Data)
 ```
 

docs/src/man/Tutorial_Basic.md

@@ -34,7 +34,7 @@ This is a so-called `GeoData` object, which is a 3D grid of seismic velocities a
 We can save this in `VTK` format, which is a widely used format that can for exampke be read by the 3D open-source visualization tool [Paraview](https://www.paraview.org/):
 
 ```julia
-Write_Paraview(Tomo_Alps_full,"Tomo_Alps_full")
+write_Paraview(Tomo_Alps_full,"Tomo_Alps_full")
 ```
 
 ````
@@ -62,7 +62,7 @@ Different than the 3D tomographic model, the topography has size 1 for the last
 We can write this to disk as well
 
 ```julia
-Write_Paraview(Topo_Alps,"Topo_Alps")
+write_Paraview(Topo_Alps,"Topo_Alps")
 ```
 
 ````
@@ -81,7 +81,7 @@ It is thus advantageous to cut out a piece of the dataset that we are interested
 ```julia
 Tomo_Alps = ExtractSubvolume(Tomo_Alps_full,Lon_level=(4,20),Lat_level=(36,50), Depth_level=(-600,-10))
 
-Write_Paraview(Tomo_Alps,"Tomo_Alps");
+write_Paraview(Tomo_Alps,"Tomo_Alps");
 ```
 
 ````
@@ -188,8 +188,8 @@ GeoData
 And write them to paraview:
 
 ```julia
-Write_Paraview(Cross_vert,"Cross_vert");
-Write_Paraview(data_200km,"data_200km");
+write_Paraview(Cross_vert,"Cross_vert");
+write_Paraview(data_200km,"data_200km");
 ```
 
 ````
@@ -241,8 +241,8 @@ CartData
 Save:
 
 ```julia
-Write_Paraview(Tomo_cart,"Tomo_cart");
-Write_Paraview(Topo_cart,"Topo_cart");
+write_Paraview(Tomo_cart,"Tomo_cart");
+write_Paraview(Topo_cart,"Topo_cart");
 ```
 
 ````
@@ -298,8 +298,8 @@ CartData
 Save it:
 
 ```julia
-Write_Paraview(Tomo_rect,"Tomo_rect");
-Write_Paraview(Topo_rect,"Topo_rect");
+write_Paraview(Tomo_rect,"Tomo_rect");
+write_Paraview(Topo_rect,"Topo_rect");
 ```
 
 ````

docs/src/man/Tutorial_Jura.md

@@ -194,9 +194,9 @@ Note that we transfer the boolean to an integer
 Let's have a look at this in Paraview:
 
 ```julia
-Write_Paraview(Basement_cart,"Basement_cart")
-Write_Paraview(TopoGeology_cart,"TopoGeology_cart")
-Write_Paraview(CrossSection_1_cart,"CrossSection_1_cart")
+write_Paraview(Basement_cart,"Basement_cart")
+write_Paraview(TopoGeology_cart,"TopoGeology_cart")
+write_Paraview(CrossSection_1_cart,"CrossSection_1_cart")
 ```
 
 The result looks like:
@@ -261,10 +261,10 @@ ComputationalGrid = RemoveField(ComputationalGrid,"Z")
 Save the surfaces, cross-section and the grid:
 
 ```julia
-Write_Paraview(GeologyTopo_comp_surf,"GeologyTopo_comp_surf")
-Write_Paraview(Basement_comp_surf,   "Basement_comp_surf")
-Write_Paraview(CrossSection_1_cart_rot,"CrossSection_1_cart_rot")
-Write_Paraview(ComputationalGrid,"ComputationalGrid")
+write_Paraview(GeologyTopo_comp_surf,"GeologyTopo_comp_surf")
+write_Paraview(Basement_comp_surf,   "Basement_comp_surf")
+write_Paraview(CrossSection_1_cart_rot,"CrossSection_1_cart_rot")
+write_Paraview(ComputationalGrid,"ComputationalGrid")
 ```
 
 We can visualize this in paraview:

docs/src/man/Tutorial_LaPalma.md

@@ -53,8 +53,8 @@ data_all_EQ = GeoData(lon,lat,depth, (Magnitude=Mag,))
 Next, we can write the data to paraview along with the topography. Note that we have to specify that we have `PointData`:
 
 ```julia
-Write_Paraview(data_all_EQ,"data_all_EQ",PointsData=true)
-Write_Paraview(Topo,"Topo")
+write_Paraview(data_all_EQ,"data_all_EQ",PointsData=true)
+write_Paraview(Topo,"Topo")
 ```
 
 ![LaPalma_EQTopo_GeoData](../assets/img/TopoEQs_LaPalma_GeoData.png)
@@ -93,8 +93,8 @@ Topo_model = projectCartData(Topo_model, Topo, proj)
 Let's have a look at the data:
 
 ```julia
-Write_Paraview(EQ_cart,"EQ_cart",PointsData=true)
-Write_Paraview(Topo_model,"Topo_model")
+write_Paraview(EQ_cart,"EQ_cart",PointsData=true)
+write_Paraview(Topo_model,"Topo_model")
 ```
 
 ## 3. Create a volumetric earthquake plot
@@ -146,7 +146,7 @@ Grid_3D = AddField(Grid_3D,"Phases",Phases)
 We can save this to paraview format
 
 ```julia
-Write_Paraview(Grid_3D,"Grid_3D")
+write_Paraview(Grid_3D,"Grid_3D")
 ```
 
 The paraview statefile `/tutorials/LaPalma.pvsm` can be used to reproduce the following plot:

docs/src/man/Tutorial_MohoTopo_Spada.md

@@ -76,7 +76,7 @@ GeoData
 ```
 
 ```julia
-Write_Paraview(data_Moho1, "Spada_Moho_Europe", PointsData=true)
+write_Paraview(data_Moho1, "Spada_Moho_Europe", PointsData=true)
 ```
 
 And we can do the same with the other two Moho's:
@@ -85,11 +85,11 @@ And we can do the same with the other two Moho's:
 data = readdlm("Moho_Map_Data-WesternAlps-SpadaETAL2013_Moho2.txt",' ',Float64,'\n', skipstart=38,header=false);
 lon, lat, depth        = data[:,1], data[:,2], -data[:,3];
 data_Moho2 = GeoData(lon,lat,depth,(MohoDepth=depth*km,))
-Write_Paraview(data_Moho2, "Spada_Moho_Adria", PointsData=true)
+write_Paraview(data_Moho2, "Spada_Moho_Adria", PointsData=true)
 data =readdlm("Moho_Map_Data-WesternAlps-SpadaETAL2013_Moho3.txt",' ',Float64,'\n', skipstart=38,header=false);
 lon, lat, depth        = data[:,1], data[:,2], -data[:,3];
 data_Moho3 = GeoData(lon,lat,depth,(MohoDepth=depth*km,))
-Write_Paraview(data_Moho3, "Spada_Moho_Tyrrhenia", PointsData=true)
+write_Paraview(data_Moho3, "Spada_Moho_Tyrrhenia", PointsData=true)
 ```
 
 If we plot this in paraview, it looks like this:
@@ -123,7 +123,7 @@ Now, we can create a `GeoData` structure with the regular surface and save it to
 
 ```julia
 data_Moho = GeoData(Lon, Lat, Depth, (MohoDepth=Depth,))
-Write_Paraview(data_Moho, "Spada_Moho_combined")
+write_Paraview(data_Moho, "Spada_Moho_combined")
 ```
 
 The result is shown here, where the previous points are colored white and are a bit smaller. Obviously, the datasets coincide well.

docs/src/man/Tutorial_Votemaps.md

@@ -78,7 +78,7 @@ GeoData
 And from this, we can generate profiles, visualize 3D features in Paraview etc. etc.
 
 ```julia
-Write_Paraview(Data_VoteMap, "VoteMap_Alps")
+write_Paraview(Data_VoteMap, "VoteMap_Alps")
 ```
 
 In paraview, this gives

docs/src/man/movies.md

@@ -6,7 +6,7 @@ The first one takes `*.png` images generated with the `Save Animation` option in
 movie_from_images
 ```
 
-The other one creates `*.pvd` files that can be saved with the `pvd=...` optional option in `Write_Paraview`, such that you can animate temporal data in paraview (yif you're happy you can save the result as images and use `movies_from_pics`). See the corresponding tutorial on how to generate `*.pvd` files.
+The other one creates `*.pvd` files that can be saved with the `pvd=...` optional option in `write_Paraview`, such that you can animate temporal data in paraview (yif you're happy you can save the result as images and use `movies_from_pics`). See the corresponding tutorial on how to generate `*.pvd` files.
 ```@docs
-Write_Paraview
+write_Paraview
 ```

docs/src/man/paraview_output.md

@@ -4,7 +4,7 @@ We have one main routine to generate Paraview output for data that is either sto
 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, or combine existing paraview files into a `*.pvd` paraview collection (that can be used to show a movie)
 ```@docs
-Write_Paraview
-Movie_Paraview
+write_Paraview
+movie_Paraview
 make_paraview_collection
 ```

docs/src/man/projection.md

@@ -19,7 +19,7 @@ GeoData
   lat   ϵ [ 25.0 : 49.666666666666664]
   depth ϵ [ -4.9855 km : 3.123 km]
   fields: (:Topography,)
-julia> Write_Paraview(Topo,"Topo")
+julia> write_Paraview(Topo,"Topo")
 Saved file: Topo.vts
 ```
 The result is shown on the globe as: 
@@ -94,7 +94,7 @@ CartData
     y      ϵ [ -1000.0 km : 1000.0 km]
     z      ϵ [ -4.485650671162607 km : 2.5909655318121865 km]
     fields : (:Topography,)
-julia> Write_Paraview(Topo_Cart_orth,"Topo_Cart_orth");    
+julia> write_Paraview(Topo_Cart_orth,"Topo_Cart_orth");    
 ```
 ![Topo_Europe_CartData_Proj](../assets/img/Topo_Europe_CartData_Proj.png)
 So this interpolates the topographic data from the `GeoData` to the orthogonal cartesian grid (which can be used with LaMEM, for example).