Skip to content

Commit 0d83eea

Browse files
committed
LaMEM_io.jl and GMG.jl
1 parent 9e1b092 commit 0d83eea

21 files changed

+102
-102
lines changed

docs/src/man/Tutorial_AlpineData.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -26,10 +26,10 @@ and load both `GMG` and `GMT` with:
2626
using GeophysicalModelGenerator, GMT
2727
```
2828

29-
When loading both packages, several `GMT` routines within `GMG` will be loaded. One of these routines is the function `importTopo`, where one simply has to provide the region for which to download the topographic data and the data source.
29+
When loading both packages, several `GMT` routines within `GMG` will be loaded. One of these routines is the function `import_topo`, where one simply has to provide the region for which to download the topographic data and the data source.
3030

3131
```julia
32-
Topo = importTopo([4,20,37,50], file="@earth_relief_01m.grd")
32+
Topo = import_topo([4,20,37,50], file="@earth_relief_01m.grd")
3333
```
3434

3535
The data is available in different resolutions; see [here](http://gmt.soest.hawaii.edu/doc/latest/grdimage.html) for an overview. Generally, it is advisable to not use the largest resolution if you have a large area, as the files become very large.

docs/src/man/Tutorial_Jura.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -18,7 +18,7 @@ using GeophysicalModelGenerator, GMT
1818
Download the topography with:
1919

2020
```julia
21-
Topo = importTopo(lat=[45.5,47.7], lon=[5, 8.1], file="@earth_relief_03s.grd")
21+
Topo = import_topo(lat=[45.5,47.7], lon=[5, 8.1], file="@earth_relief_03s.grd")
2222
```
2323

2424
Next, we drape the geological map on top of the geological map.
@@ -73,7 +73,7 @@ download_data("https://zenodo.org/records/10726801/files/BMes_Spline_longlat.tif
7373
Now, import the GeoTIFF as:
7474

7575
```julia
76-
Basement = importGeoTIFF("BMes_Spline_longlat.tif", fieldname=:Basement, removeNaN_z=true)
76+
Basement = import_GeoTIFF("BMes_Spline_longlat.tif", fieldname=:Basement, removeNaN_z=true)
7777
```
7878

7979
the `removeNaN_z` option removes `NaN` values from the dataset and instead uses the z-value of the nearest point.

docs/src/man/Tutorial_LaPalma.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -23,7 +23,7 @@ using GeophysicalModelGenerator, GMT, DelimitedFiles
2323
We will use GMT to download the topography with:
2424

2525
```julia
26-
Topo = importTopo(lon = [-18.2, -17.5], lat=[28.4, 29.0], file="@earth_relief_15s.grd")
26+
Topo = import_topo(lon = [-18.2, -17.5], lat=[28.4, 29.0], file="@earth_relief_15s.grd")
2727
```
2828

2929
Next, lets load the seismicity. The earthquake data is available on [https://www.ign.es/web/ign/portal/vlc-catalogo](https://www.ign.es/web/ign/portal/vlc-catalogo).

docs/src/man/dataimport.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -6,6 +6,6 @@ We have a number of ways to import data, besides using any of the additional pac
66
GeophysicalModelGenerator.screenshot_to_GeoData
77
GeophysicalModelGenerator.screenshot_to_CartData
88
GeophysicalModelGenerator.screenshot_to_UTMData
9-
GeophysicalModelGenerator.importTopo
10-
GeophysicalModelGenerator.importGeoTIFF
9+
GeophysicalModelGenerator.import_topo
10+
GeophysicalModelGenerator.import_GeoTIFF
1111
```

docs/src/man/lamem.md

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -10,11 +10,11 @@ The routines provided here have the following functionality:
1010
- Read a LaMEM timestep
1111

1212
```@docs
13-
GeophysicalModelGenerator.readLaMEM_InputFile
14-
GeophysicalModelGenerator.getProcessorPartitioning
15-
GeophysicalModelGenerator.save_LaMEMTopography
16-
GeophysicalModelGenerator.save_LaMEMMarkersParallel
17-
GeophysicalModelGenerator.readData_PVTR
13+
GeophysicalModelGenerator.read_LaMEM_inputfile
14+
GeophysicalModelGenerator.get_processor_partitioning
15+
GeophysicalModelGenerator.save_LaMEM_topography
16+
GeophysicalModelGenerator.save_LaMEM_markers_parallel
17+
GeophysicalModelGenerator.read_data_PVTR
1818
GeophysicalModelGenerator.LaMEM_grid
19-
GeophysicalModelGenerator.createPartitioningFile
19+
GeophysicalModelGenerator.create_partitioning_file
2020
```

docs/src/man/projection.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -12,7 +12,7 @@ Converting from one coordinate system to the other is straightforward. Let's use
1212

1313
```julia
1414
julia> using GeophysicalModelGenerator, GMT
15-
julia> Topo = importTopo(lon = [-10, 45], lat=[25, 50], file="@earth_relief_20m")
15+
julia> Topo = import_topo(lon = [-10, 45], lat=[25, 50], file="@earth_relief_20m")
1616
GeoData
1717
size : (165, 75, 1)
1818
lon ϵ [ -10.0 : 44.666666666666664]

docs/src/man/surfaces.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
# Surfaces
22

33
We have a number of functions to deal with horizontal surfaces, which are defined as `GeoData` or `CartData` structures that have 3 dimensional `flat` coordinate array. Flat implies that the resolution is `n` by `m` by `1`, which is required to correctly display them in paraview.
4-
The most straightforward surface is the topography (which you can obtain with `importTopo`).
4+
The most straightforward surface is the topography (which you can obtain with `import_topo`).
55
Surfaces can be added and subtracted.
66

77
```@docs

docs/src/man/tutorial_GMT_Topography.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -11,11 +11,11 @@ In many cases, we want to add topographic data as well to our visualization. Thi
1111

1212
#### 1. Download topographic data of the Alpine region
1313

14-
The nice thing about GMT is that it automatically downloads data for you for a certain region and with a certain resolution. As this is a routine that you may use often in your daily workflow, we added the function `importTopo` that simplifies this. Note that this function only is available once `GMT` is loaded.
14+
The nice thing about GMT is that it automatically downloads data for you for a certain region and with a certain resolution. As this is a routine that you may use often in your daily workflow, we added the function `import_topo` that simplifies this. Note that this function only is available once `GMT` is loaded.
1515

1616
```julia
1717
julia> using GeophysicalModelGenerator, GMT
18-
julia> Topo = importTopo([4,20,37,49], file="@earth_relief_01m.grd")
18+
julia> Topo = import_topo([4,20,37,49], file="@earth_relief_01m.grd")
1919
GeoData
2020
size : (960, 720, 1)
2121
lon ϵ [ 4.0 : 19.983333333333334]

docs/src/man/tutorial_GPS.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -160,10 +160,10 @@ and interpolate the elevation on the GPS grid locations
160160
using GMT, Interpolations
161161
```
162162

163-
We use the `importTopo` function to read the topography from a file:
163+
We use the `import_topo` function to read the topography from a file:
164164

165165
```julia
166-
Elevation = importTopo([3,17,42,50], file="@earth_relief_01m.grd");
166+
Elevation = import_topo([3,17,42,50], file="@earth_relief_01m.grd");
167167
nothing #hide
168168
```
169169

docs/src/man/visualise.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -27,7 +27,7 @@ Note that this tends to take a while, the first time you do this (faster afterwa
2727

2828
Let's add topography to the plot as well, which requires us to first load that:
2929
```julia
30-
julia> Topo = importTopo([0,18,38,52], file="@earth_relief_01m.grd");
30+
julia> Topo = import_topo([0,18,38,52], file="@earth_relief_01m.grd");
3131
julia> visualise(Data, Topography=Topo);
3232
```
3333
Which will look like:

0 commit comments

Comments
 (0)