Skip to content

Commit 7e9e7b6

Browse files
authoredDec 6, 2024··
Overall fixes (typos, links, emojis, consistency, etc.) (#33)
1 parent 7b1dd66 commit 7e9e7b6

7 files changed

+42
-49
lines changed
 

‎book/intro.md

+3-3
Original file line numberDiff line numberDiff line change
@@ -93,7 +93,7 @@ and [Yvonne Fröhlich](https://orcid.org/0000-0002-8566-0619)
9393
::::{grid} 1 1 1 1
9494
:gutter: 1
9595

96-
:::{grid-item-card} Tutorial 5 - 3-D Topography (Planetary / Antarctic maps)
96+
:::{grid-item-card} Tutorial 5 - 3-D Topography (Planetary / Antarctic maps) 🏔️
9797
:img-top: \_images/0a6fc097b1fcaa99eff8632dab714787757564ed60e07f20825101c6a8e045ae.png
9898
:link: ./tut05_topography.html
9999
by [Wei Ji Leong](https://orcid.org/0000-0003-2354-1988)
@@ -107,7 +107,7 @@ and [André Belém](https://orcid.org/0000-0002-8865-6180)
107107
{bdg-success-line}`DEM`
108108
:::
109109

110-
:::{grid-item-card} Tutorial 6 - Animations with GMT
110+
:::{grid-item-card} Tutorial 6 - Animations with GMT 🎦
111111
:img-top: \_images/5847818951ca8fbc9b86a6f2c67389b6.png
112112
:link: ./tut06_animation.html
113113
by [Federico Esteban](https://orcid.org/0000-0002-0641-7371)
@@ -192,7 +192,7 @@ Here's the instructions to install the `agu24workshop` environment:
192192

193193
This should open up a page in your default browser. If not, you can click and open
194194
the 🔗 link that says `http://localhost:8888/lab?token=...` in your command-line
195-
terminal and this will will take you to the Jupyter Lab page.
195+
terminal and this will take you to the Jupyter Lab page.
196196

197197
6. Download the Jupyter notebook(s) you want to run (e.g.
198198
https://www.generic-mapping-tools.org/agu24workshop/tut01_firstfigure.html) using

‎book/tut01_firstfigure.ipynb

+4-13
Original file line numberDiff line numberDiff line change
@@ -142,7 +142,7 @@
142142
"1. `region`: Controlling the geographic or Cartesian extent of the figure. Regions are specified as lists of `[xmin, xmax, ymin, ymax]`. Another shortcut, `region=\"g\"`, which specifies a **global** domain.\n",
143143
"2. `projection`: Controlling the map projection. GMT (and therefore PyGMT) supports 31 different map projections, from basic Cartesian axes to [arbitrary vertical perspectives](https://docs.generic-mapping-tools.org/6.5/gallery/ex26.html).\n",
144144
"\n",
145-
"> Determining the size of your images `10c`, the size will affect how large of your following fontsize and markersize\n",
145+
"> Determining the size of your images `10c`, the size will affect how large of your following font size and marker size\n",
146146
">> **length unit** `c`: centimeter (default)\n",
147147
"\n",
148148
"> More projections please click https://www.pygmt.org/v0.13.0/projections/index.html"
@@ -453,7 +453,7 @@
453453
" )\n",
454454
"\n",
455455
" fig.colorbar(\n",
456-
" position=\"JBC+w6c/0.3c+mc+h\", frame=\"a40f20+lSeafloor crustal asge (Ma)\"\n",
456+
" position=\"JBC+w6c/0.3c+mc+h\", frame=\"a40f20+lSeafloor crustal age (Ma)\"\n",
457457
" )\n",
458458
"\n",
459459
"fig.show()"
@@ -465,7 +465,7 @@
465465
"id": "25aeb001-48ed-417b-94dc-637c3fad15c1",
466466
"metadata": {},
467467
"source": [
468-
"## 5️⃣ Basic projection types: \n",
468+
"## 5️⃣ Basic projection types\n",
469469
"\n",
470470
"<img src=\"_static/tut01_projection.jpg\" alt=\"position\" />\n",
471471
"By default, PyGMT will use an equidistant cylindrical projection if the region seems to be geographic longitude and latitude.\n",
@@ -483,17 +483,8 @@
483483
"3. Azimuthal Projection -- projecting the Earth onto a plane, preserving directions from a central point.\n",
484484
" \n",
485485
"* Use Case: Suitable for mapping polar regions or any area where direction from a central point is essential.\n",
486-
"* GMT Command: **E[lon]/[lat]**, with lon and lat defining the central point.\n",
487-
"\n"
486+
"* GMT Command: **E[lon]/[lat]**, with lon and lat defining the central point."
488487
]
489-
},
490-
{
491-
"cell_type": "code",
492-
"execution_count": null,
493-
"id": "00558ccf-06c9-43d5-9e76-5edd36c6fc35",
494-
"metadata": {},
495-
"outputs": [],
496-
"source": []
497488
}
498489
],
499490
"metadata": {

‎book/tut02_spe_pd_gpd.ipynb

+4-4
Original file line numberDiff line numberDiff line change
@@ -183,7 +183,7 @@
183183
"source": [
184184
"### 1.3 Create a geographical map showing the epicenters (scatter plot)\n",
185185
"\n",
186-
"Now it's time to create a geographical map showing the earthquakes. You can start with using [`pygmt.Figure.basemap`](https://www.pygmt.org/v0.13.0/api/generated/pygmt.Figure.basemap.html) and [`pygmt.Figure.coast`](https://www.pygmt.org/v0.13.0/api/generated/pygmt.Figure.coast.html) to set up the map. To create a scatter plot we can pass appropriate columns of the `pandas.DataFrame` to the `x`, `y`, `size`, and `fill` parameters of [`pygmt.Figure.plot`](https://www.pygmt.org/v0.13.0/api/generated/pygmt.Figure.plot.html). This allows use to plot the epicenters as size (moment magnitude) and color (hypocentral depth) coded circles on top of the map. For details you can have a look at [**Plotting data points**](https://www.pygmt.org/v0.13.0/tutorials/basics/plot.html)."
186+
"Now it's time to create a geographical map showing the earthquakes. You can start with using [`pygmt.Figure.basemap`](https://www.pygmt.org/v0.13.0/api/generated/pygmt.Figure.basemap.html) and [`pygmt.Figure.coast`](https://www.pygmt.org/v0.13.0/api/generated/pygmt.Figure.coast.html) to set up the map. To create a scatter plot we can pass appropriate columns of a `pandas.DataFrame` to the `x`, `y`, `size`, and `fill` parameters of [`pygmt.Figure.plot`](https://www.pygmt.org/v0.13.0/api/generated/pygmt.Figure.plot.html). This allows us to plot the epicenters as size (moment magnitude) and color (hypocentral depth) coded circles on top of the map. For details you can have a look at [**Plotting data points**](https://www.pygmt.org/v0.13.0/tutorials/basics/plot.html)."
187187
]
188188
},
189189
{
@@ -229,7 +229,7 @@
229229
"source": [
230230
"### 2.1 Line geometry\n",
231231
"\n",
232-
"Features which can be represented as a **line geometry** are for example rivers, roads, national boundaries, shorlines, and any kind of profiles."
232+
"Features which can be represented as a **line geometry** are for example rivers, roads, national boundaries, shorelines, and any kind of profiles."
233233
]
234234
},
235235
{
@@ -397,7 +397,7 @@
397397
"source": [
398398
"#### 2.2.1 Spatial Data - `geopandas.GeoDataFrame` with polygon geometry\n",
399399
"\n",
400-
"Again we download some data into in a [`geopandas.GeoDataFrame`](https://geopandas.org/en/stable/docs/reference/api/geopandas.GeoDataFrame.html). This dataset contains information regarding airbnb rentals, socioeconomics, and crime in Chicagos.\n",
400+
"Again we download some data into in a [`geopandas.GeoDataFrame`](https://geopandas.org/en/stable/docs/reference/api/geopandas.GeoDataFrame.html). This dataset contains information regarding airbnb rentals, socioeconomics, and crime in Chicago.\n",
401401
"This time we are lucky and the data is directly provided in the geographic coordinate reference system (longitude/latitude) and no coordinate transformation is needed."
402402
]
403403
},
@@ -476,7 +476,7 @@
476476
"Some helpful and interesting aspects:\n",
477477
"\n",
478478
"- Use suitable colormaps for your data: [**Scientific colourmaps by Fabio Crameri**](https://www.fabiocrameri.ch/colourmaps/), see also the publications [Crameri et al. 2024](https://doi.org/10.1002/cpz1.1126) and [Crameri et al. 2020](https://doi.org/10.1038/s41467-020-19160-7)\n",
479-
"- Datasets provided by `GeoPandas`: Checkout the [**geodatasets**](https://geodatasets.readthedocs.io) libaray\n",
479+
"- Datasets provided by `GeoPandas`: Checkout the [**geodatasets**](https://geodatasets.readthedocs.io) library\n",
480480
"- Convert other objects to `pandas` or `GeoPandas` objects to make them usable in `PyGMT`: For example, convert [**OSMnx**](https://osmnx.readthedocs.io)'s `MultiDiGraph` to a `geopandas.DataFrame`\n",
481481
"- Create more complex geometries: Combine `GeoPandas` with [**shapely**](https://shapely.readthedocs.io) (i.e., `from shapely.geometry import Polygon`)\n",
482482
"- Support of OGR formats: Use [`geopandas.read_file`](https://geopandas.org/en/v1.0.1/docs/reference/api/geopandas.read_file.html) to load data provided as shapefile (.shp), GeoJSON (.geojson), geopackage (.gpkg), etc."

‎book/tut04_geophysics.ipynb

+1-1
Original file line numberDiff line numberDiff line change
@@ -279,7 +279,7 @@
279279
"source": [
280280
"### 3.2 [`pygmt.project`](https://www.pygmt.org/v0.13.0/api/generated/pygmt.project.html)\n",
281281
"\n",
282-
"[`pygmt.project`](https://www.pygmt.org/v0.13.0/api/generated/pygmt.project.html) is designed to sample points along a great circle, a straight line, or across specified distance. In our case, we will create a profile point-to-point. Therefore you need to define: \n",
282+
"[`pygmt.project`](https://www.pygmt.org/v0.13.0/api/generated/pygmt.project.html) is designed to sample points along a great circle, a straight line, or across specified distance. In our case, we will create a profile point-to-point. Therefore, you need to define: \n",
283283
"\n",
284284
"1. `center` and `endpoint`: Specify the start and end coordinates of the profile.\n",
285285
"2. `generate`: Distance interval of each point, e.g., `10` means points are generated every 10 degrees along the profile. \n",

‎book/tut05_topography.ipynb

+3-3
Original file line numberDiff line numberDiff line change
@@ -28,7 +28,7 @@
2828
"- Created: November-December 2024\n",
2929
"- Recommended versions: [PyGMT v0.13.0](https://www.pygmt.org/v0.13.0) with [GMT 6.5.0](https://docs.generic-mapping-tools.org/6.5)\n",
3030
"\n",
31-
"🔖 References\n",
31+
"References\n",
3232
"- https://www.generic-mapping-tools.org/remote-datasets/mars-relief.html\n",
3333
"- https://github.com/andrebelem/PlanetaryMaps\n",
3434
"- {cite:t}`NeumannMarsOrbiterLaser2003`\n",
@@ -380,7 +380,7 @@
380380
"## 3️⃣ Draping RGB image on 3-D topography\n",
381381
"\n",
382382
"We have our RGB imagery from Sentinel-2, and a DEM from REMA, and now we can learn how\n",
383-
"to render the colour image on top of the 3-D topography! Once again, we will be using\n",
383+
"to render the color image on top of the 3-D topography! Once again, we will be using\n",
384384
"[`grdview`](https://www.pygmt.org/v0.13.0/api/generated/pygmt.Figure.grdview.html), but\n",
385385
"pass in some extra arguments:\n",
386386
"\n",
@@ -403,7 +403,7 @@
403403
"This is how the code will look like. We'll also use\n",
404404
"[`pygmt.config`](https://www.pygmt.org/v0.13.0/api/generated/pygmt.config.html) to set\n",
405405
"[`PS_PAGE_COLOR`](https://docs.generic-mapping-tools.org/6.5/gmt.conf.html#term-PS_PAGE_COLOR)\n",
406-
"(the background colour) to an off-white colour instead of the default black to better\n",
406+
"(the background color) to an off-white color instead of the default black to better\n",
407407
"match the polar landscape."
408408
]
409409
},

‎book/tut06_animation.rst

+17-16
Original file line numberDiff line numberDiff line change
@@ -1,10 +1,11 @@
1-
**Tutorial 6** - Animations with GMT
2-
------------------------------------
1+
**Tutorial 6** - Animations with GMT 🎦
2+
---------------------------------------
33

44
Content
5-
- This tutorial explains the basic aspect of doing animations with GMT.
6-
- It serves as a guide to help beginners understand and troubleshoot potential issues.
7-
- It explains the basic aspect of the :gmt-module:`movie` and :gmt-module:`events` modules.
5+
6+
* This tutorial explains the basic aspect of doing animations with GMT.
7+
* It serves as a guide to help beginners understand and troubleshoot potential issues.
8+
* It explains the basic aspect of the :gmt-module:`movie` and :gmt-module:`events` modules.
89

910
.. note::
1011
This tutorial is part of the AGU24 annual meeting GMT/PyGMT pre-conference workshop (PREWS9) **Mastering Geospatial Visualizations with GMT/PyGMT**
@@ -22,8 +23,8 @@ Content
2223
Fee free to play around with these code examples 🚀. In case you found any kind of error, just report it by `opening an issue <https://github.com/GenericMappingTools/agu24workshop/issues>`_ or `provide a fix via a pull request <https://github.com/GenericMappingTools/agu24workshop/pulls>`_. Please use the `GMT forum <https://forum.generic-mapping-tools.org/>`_ to ask questions.
2324

2425

25-
1. Introduction
26-
~~~~~~~~~~~~~~~
26+
1️⃣. Introduction
27+
~~~~~~~~~~~~~~~~~
2728

2829
Prior to GMT 6.0, ambitious movie makers had to write complicated scripts where the advancement of frames was explicitly done by a shell loop.
2930
At the end of the script, you would have to convert your PostScript plot to a raster image with a name that is lexically increasing,
@@ -80,8 +81,9 @@ For the purposes of this tutorial, I define two types of animations that can be
8081
- GMT version 6.5 or later.
8182
- Bash scripting environment: The examples in this tutorial are written in Bash and may not work correctly in other shell environments (e.g., zsh, fish, or Windows cmd).
8283

83-
2. Tutorial 1. Earth spinning
84-
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
84+
85+
2️⃣. Tutorial 1. Earth spinning
86+
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
8587

8688
Here I explain how to make an animation of a moving object which only requires the :gmt-module:`movie` module.
8789

@@ -496,17 +498,16 @@ In the step, I increase:
496498
Also you could use `-x <https://docs.generic-mapping-tools.org/6.5/gmt.html#core-full>`_ to specify the number of active cores to be used.
497499
498500
499-
3. Tutorial 2. Earthquakes
500-
~~~~~~~~~~~~~~~~~~~~~~~~~~
501+
3️⃣. Tutorial 2. Earthquakes
502+
~~~~~~~~~~~~~~~~~~~~~~~~~~~~
501503
502504
Check the extended section to see the tutorial 2 about appearing objects.
503505
That type of animation is more complex and requires the use :gmt-module:`events` and :gmt-module:`movie` modules.
504506
In that tutorial, I create an animation showing the occurrences of earthquakes during the year 2018 (with one frame per day).
505507
506508
507-
508-
4. See also
509-
~~~~~~~~~~~
509+
4️⃣. See also
510+
~~~~~~~~~~~~~
510511
511512
- The paper about animations which include explanation and examples (`Wessel et al. 2024 <https://doi.org/10.1029/2024GC011545>`_).
512513
@@ -515,8 +516,8 @@ In that tutorial, I create an animation showing the occurrences of earthquakes d
515516
- See the `GMT animation gallery <https://docs.generic-mapping-tools.org/6.5/animations.html>`_ for more examples.
516517
517518
518-
5. References
519-
~~~~~~~~~~~~~
519+
5️. References
520+
~~~~~~~~~~~~~~~
520521
521522
- Wessel, P., Luis, J. F., Uieda, L., Scharroo, R., Wobbe, F., Smith, W. H. F., & Tian, D. (2019). The Generic Mapping Tools Version 6. Geochemistry, Geophysics, Geosystems, 20(11), 5556–5564. https://doi.org/10.1029/2019GC008515
522523
- Wessel, P., Esteban, F., & Delaviel-Anger, G. (2024). The Generic Mapping Tools and animations for the masses. Geochemistry, Geophysics, Geosystems, 25, e2024GC011545. https://doi.org/10.1029/2024GC011545.

‎book/tut06_animation_extended.rst

+10-9
Original file line numberDiff line numberDiff line change
@@ -1,8 +1,9 @@
1-
**Tutorial 6** - Animations with GMT (extended)
2-
-----------------------------------------------
1+
**Tutorial 6** - Animations with GMT 🎦 (extended)
2+
--------------------------------------------------
33

44
Content
5-
- Extension of "Tutorial 6 - Animations with GMT"
5+
6+
* Extension of "Tutorial 6 - Animations with GMT"
67

78
.. note::
89
This tutorial is part of the AGU24 annual meeting GMT/PyGMT pre-conference workshop (PREWS9) **Mastering Geospatial Visualizations with GMT/PyGMT**
@@ -21,8 +22,8 @@ Content
2122

2223
Fee free to play around with these code examples 🚀. In case you found any kind of error, just report it by `opening an issue <https://github.com/GenericMappingTools/agu24workshop/issues>`_ or `provide a fix via a pull request <https://github.com/GenericMappingTools/agu24workshop/pulls>`_. Please use the `GMT forum <https://forum.generic-mapping-tools.org/>`_ to ask questions.
2324

24-
3. Tutorial 2. Earthquakes
25-
~~~~~~~~~~~~~~~~~~~~~~~~~~
25+
3️. Tutorial 2. Earthquakes
26+
~~~~~~~~~~~~~~~~~~~~~~~~~~~~
2627

2728
Here I explain how to make an animation with appearing objects.
2829
This is more complex and requires the use :gmt-module:`events` and :gmt-module:`movie` modules.
@@ -419,8 +420,8 @@ The plateau phase is not used.
419420
- -Mi1+c0: modify the intensity of the color. It gets lighter during the rise phase and then returns to its original color in the coda phase.
420421
421422
422-
4. See also
423-
~~~~~~~~~~~
423+
4️⃣. See also
424+
~~~~~~~~~~~~~
424425
425426
- The paper about animations which include explanation and examples (`Wessel et al. 2024 <https://doi.org/10.1029/2024GC011545>`_).
426427
@@ -429,8 +430,8 @@ The plateau phase is not used.
429430
- See the `GMT animation gallery <https://docs.generic-mapping-tools.org/6.5/animations.html>`_ for more examples.
430431
431432
432-
5. References
433-
~~~~~~~~~~~~~
433+
5️⃣. References
434+
~~~~~~~~~~~~~~~
434435
435436
- Wessel, P., Luis, J. F., Uieda, L., Scharroo, R., Wobbe, F., Smith, W. H. F., & Tian, D. (2019). The Generic Mapping Tools Version 6. Geochemistry, Geophysics, Geosystems, 20(11), 5556–5564. https://doi.org/10.1029/2019GC008515
436437
- Wessel, P., Esteban, F., & Delaviel-Anger, G. (2024). The Generic Mapping Tools and animations for the masses. Geochemistry, Geophysics, Geosystems, 25, e2024GC011545. https://doi.org/10.1029/2024GC011545.

0 commit comments

Comments
 (0)
Please sign in to comment.