Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

DOC/projections: Simplify links in the projection table to use directly the titles of the examples #3407

Open
wants to merge 19 commits into
base: main
Choose a base branch
from
+88 −88
Open

DOC/projections: Simplify links in the projection table to use directly the titles of the examples #3407

Show file tree
Hide file tree
Changes from 4 commits
Commits
Show all changes
19 commits
Select commit Hold shift + click to select a range
ec201af
Fix link to projection 'A'
yvonnefroehlich Aug 21, 2024
f931743
Use example title in table
yvonnefroehlich Aug 21, 2024
c8c05be
Make titles of examples consistent | Use lower case
yvonnefroehlich Aug 21, 2024
81e1619
Fix link for Polar
yvonnefroehlich Aug 21, 2024
6d9fb05
Shorten names for Cartesian
yvonnefroehlich Aug 21, 2024
08630a7
Merge branch 'main' into improve-proj-table
yvonnefroehlich Aug 31, 2024
ce665c3
Merge branch 'main' into improve-proj-table
yvonnefroehlich Sep 4, 2024
fb2e904
Revert projetion name changes
yvonnefroehlich Sep 4, 2024
46b37b7
Use consistently lower-case | Remove 'projection'
yvonnefroehlich Sep 4, 2024
27d39c4
Merge branch 'main' into improve-proj-table
yvonnefroehlich Sep 4, 2024
9ddeb06
Revert ALL projection name changes
yvonnefroehlich Sep 5, 2024
2f812d3
Revert "Revert ALL projection name changes"
yvonnefroehlich Sep 5, 2024
f928824
Merge branch 'main' into improve-proj-table
yvonnefroehlich Sep 5, 2024
eb21169
Add term 'projection' consistently for all projections in headings
yvonnefroehlich Sep 12, 2024
76cfeb8
Merge branch 'main' into improve-proj-table
yvonnefroehlich Sep 12, 2024
3c2c30b
Remove trailing white space
yvonnefroehlich Sep 12, 2024
314ce7f
Merge branch 'main' into improve-proj-table
yvonnefroehlich Sep 21, 2024
013381e
Make projection names consistent with headings of the GMT documentation
yvonnefroehlich Sep 23, 2024
8a03fe4
Merge branch 'main' into improve-proj-table
yvonnefroehlich Sep 23, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
62 changes: 31 additions & 31 deletions doc/techref/projections.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -16,34 +16,34 @@ The table below shows the projection codes for the 31 GMT map projections:

| PyGMT Projection Argument | Projection Name |
| --- | --- |
| **A**{{ lon0 }}/{{ lat0 }}[/*horizon*]/*width* | {doc}`Lambert azimuthal equal area </projections/azim/azim_equidistant>` |
| **B**{{ lon0 }}/{{ lat0 }}/{{ lat1 }}/{{ lat2 }}/*width* | {doc}`Albers conic equal area </projections/conic/conic_albers>` |
| **C**{{ lon0 }}/{{ lat0 }}/*width* | {doc}`Cassini cylindrical </projections/cyl/cyl_cassini>` |
| **Cyl_stere**/[{{ lon0 }}/[{{ lat0 }}/]]*width* | {doc}`Cylindrical stereographic </projections/cyl/cyl_stereographic>` |
| **D**{{ lon0 }}/{{ lat0 }}/{{ lat1 }}/{{ lat2 }}/*width* | {doc}`Equidistant conic </projections/conic/conic_equidistant>` |
| **E**{{ lon0 }}/{{ lat0 }}[/*horizon*]/*width* | {doc}`Azimuthal equidistant </projections/azim/azim_equidistant>` |
| **F**{{ lon0 }}/{{ lat0 }}[/*horizon*]/*width* | {doc}`Azimuthal gnomonic </projections/azim/azim_gnomonic>` |
| **G**{{ lon0 }}/{{ lat0 }}[/*horizon*]/*width* | {doc}`Azimuthal orthographic </projections/azim/azim_orthographic>` |
| **G**{{ lon0 }}/{{ lat0 }}/*width*[**+a***azimuth*][**+t***tilt*][**+v***vwidth*/*vheight*][**+w***twist*][**+z***altitude*] | {doc}`General perspective </projections/azim/azim_general_perspective>` |
| **H**[{{ lon0 }}/]*width* | {doc}`Hammer equal area </projections/misc/misc_hammer>` |
| **I**[{{ lon0 }}/]*width* | {doc}`Sinusoidal equal area </projections/misc/misc_sinusoidal>` |
| **J**[{{ lon0 }}/]*width* | {doc}`Miller cylindrical </projections/cyl/cyl_miller>` |
| **Kf**[{{ lon0 }}/]*width* | {doc}`Eckert IV equal area </projections/misc/misc_eckertIV>` |
| **Ks**[{{ lon0 }}/]*width* | {doc}`Eckert VI equal area </projections/misc/misc_eckertVI>` |
| **L**{{ lon0 }}/{{ lat0 }}/{{ lat1 }}/{{ lat2 }}/*width* | {doc}`Lambert conic conformal </projections/conic/conic_lambert>` |
| **M**[{{ lon0 }}/[{{ lat0 }}/]]*width* | {doc}`Mercator cylindrical </projections/cyl/cyl_mercator>` |
| **N**[{{ lon0 }}/]*width* | {doc}`Robinson </projections/misc/misc_robinson>` |
| **Oa**{{ lon0 }}/{{ lat0 }}/*azimuth*/*width*[**+v**] | {doc}`Oblique Mercator, 1: origin and azimuth </projections/cyl/cyl_oblique_mercator_1>` |
| **Ob**{{ lon0 }}/{{ lat0 }}/{{ lon1 }}/{{ lat1 }}/*width*[**+v**] | {doc}`Oblique Mercator, 2: two points </projections/cyl/cyl_oblique_mercator_2>` |
| **Oc**{{ lon0 }}/{{ lat0 }}/{{ lonp }}/{{ latp }}/*width*[**+v**] | {doc}`Oblique Mercator, 3: origin and pole </projections/cyl/cyl_oblique_mercator_3>` |
| **P***width*[**+a**][**+f**[**e**\|**p**\|*radius*]][**+r***offset*][**+t***origin*][**+z**[**p**\|*radius*]] | {doc}`Polar </projections/nongeo/polar>` [azimuthal] ({math}`\theta, r`) (or cylindrical) |
| **Poly**/[{{ lon0 }}/[{{ lat0 }}/]]*width* | {doc}`Polyconic </projections/conic/polyconic>` |
| **Q**[{{ lon0 }}/[{{ lat0 }}/]]*width* | {doc}`Equidistant cylindrica </projections/cyl/cyl_equidistant>` |
| **R**[{{ lon0 }}/]*width* | {doc}`Winkel Tripel </projections/misc/misc_winkel_tripel>` |
| **S**{{ lon0 }}/{{ lat0 }}[/*horizon*]/*width* | {doc}`General stereographic </projections/azim/azim_general_stereographic>` |
| **T**{{ lon0 }}[/{{ lat0 }}]/*width* | {doc}`Transverse Mercator </projections/cyl/cyl_transverse_mercator>` |
| **U***zone*/*width* | {doc}`Universal Transverse Mercator (UTM) </projections/cyl/cyl_universal_transverse_mercator>` |
| **V**[{{ lon0 }}/]*width* | {doc}`Van der Grinten </projections/misc/misc_van_der_grinten>` |
| **W**[{{ lon0 }}/]*width* | {doc}`Mollweide </projections/misc/misc_mollweide>` |
| **X***width*[**l**\|**p***exp*\|**T**\|**t**][/*height*[**l**\|**p***exp*\|**T**\|**t**]][**d**] | {doc}`Linear </projections/nongeo/cartesian_linear>`, {doc}`logarithmic </projections/nongeo/cartesian_logarithmic>`, {doc}`power </projections/nongeo/cartesian_power>`, and time |
| **Y**{{ lon0 }}/{{ lat0 }}/*width* | {doc}`Cylindrical equal area </projections/cyl/cyl_equal_area>` |
| **A**{{ lon0 }}/{{ lat0 }}[/*horizon*]/*width* | {doc}`/projections/azim/azim_lambert` |
| **B**{{ lon0 }}/{{ lat0 }}/{{ lat1 }}/{{ lat2 }}/*width* | {doc}`/projections/conic/conic_albers` |
| **C**{{ lon0 }}/{{ lat0 }}/*width* | {doc}`/projections/cyl/cyl_cassini` |
| **Cyl_stere**/[{{ lon0 }}/[{{ lat0 }}/]]*width* | {doc}`/projections/cyl/cyl_stereographic` |
| **D**{{ lon0 }}/{{ lat0 }}/{{ lat1 }}/{{ lat2 }}/*width* | {doc}`/projections/conic/conic_equidistant` |
| **E**{{ lon0 }}/{{ lat0 }}[/*horizon*]/*width* | {doc}`/projections/azim/azim_equidistant` |
| **F**{{ lon0 }}/{{ lat0 }}[/*horizon*]/*width* | {doc}`/projections/azim/azim_gnomonic` |
| **G**{{ lon0 }}/{{ lat0 }}[/*horizon*]/*width* | {doc}`/projections/azim/azim_orthographic` |
| **G**{{ lon0 }}/{{ lat0 }}/*width*[**+a***azimuth*][**+t***tilt*][**+v***vwidth*/*vheight*][**+w***twist*][**+z***altitude*] | {doc}`/projections/azim/azim_general_perspective` |
| **H**[{{ lon0 }}/]*width* | {doc}`/projections/misc/misc_hammer` |
| **I**[{{ lon0 }}/]*width* | {doc}`/projections/misc/misc_sinusoidal` |
| **J**[{{ lon0 }}/]*width* | {doc}`/projections/cyl/cyl_miller` |
| **Kf**[{{ lon0 }}/]*width* | {doc}`/projections/misc/misc_eckertIV` |
| **Ks**[{{ lon0 }}/]*width* | {doc}`/projections/misc/misc_eckertVI` |
| **L**{{ lon0 }}/{{ lat0 }}/{{ lat1 }}/{{ lat2 }}/*width* | {doc}`/projections/conic/conic_lambert` |
| **M**[{{ lon0 }}/[{{ lat0 }}/]]*width* | {doc}`/projections/cyl/cyl_mercator` |
| **N**[{{ lon0 }}/]*width* | {doc}`/projections/misc/misc_robinson` |
| **Oa**{{ lon0 }}/{{ lat0 }}/*azimuth*/*width*[**+v**] | {doc}`/projections/cyl/cyl_oblique_mercator_1` |
| **Ob**{{ lon0 }}/{{ lat0 }}/{{ lon1 }}/{{ lat1 }}/*width*[**+v**] | {doc}`/projections/cyl/cyl_oblique_mercator_2` |
| **Oc**{{ lon0 }}/{{ lat0 }}/{{ lonp }}/{{ latp }}/*width*[**+v**] | {doc}`/projections/cyl/cyl_oblique_mercator_3` |
| **P***width*[**+a**][**+f**[**e**\|**p**\|*radius*]][**+r***offset*][**+t***origin*][**+z**[**p**\|*radius*]] | {doc}`/projections/nongeo/polar` [azimuthal] ({math}`\theta, r`) (or cylindrical) |
| **Poly**/[{{ lon0 }}/[{{ lat0 }}/]]*width* | {doc}`/projections/conic/polyconic` |
| **Q**[{{ lon0 }}/[{{ lat0 }}/]]*width* | {doc}`/projections/cyl/cyl_equidistant` |
| **R**[{{ lon0 }}/]*width* | {doc}`/projections/misc/misc_winkel_tripel` |
| **S**{{ lon0 }}/{{ lat0 }}[/*horizon*]/*width* | {doc}`/projections/azim/azim_general_stereographic` |
| **T**{{ lon0 }}[/{{ lat0 }}]/*width* | {doc}`/projections/cyl/cyl_transverse_mercator` |
| **U***zone*/*width* | {doc}`/projections/cyl/cyl_universal_transverse_mercator` |
| **V**[{{ lon0 }}/]*width* | {doc}`/projections/misc/misc_van_der_grinten` |
| **W**[{{ lon0 }}/]*width* | {doc}`/projections/misc/misc_mollweide` |
| **X***width*[**l**\|**p***exp*\|**T**\|**t**][/*height*[**l**\|**p***exp*\|**T**\|**t**]][**d**] | {doc}`/projections/nongeo/cartesian_linear`, {doc}`/projections/nongeo/cartesian_logarithmic`, {doc}`/projections/nongeo/cartesian_power`, and time |
yvonnefroehlich marked this conversation as resolved.
Show resolved Hide resolved
| **Y**{{ lon0 }}/{{ lat0 }}/*width* | {doc}`/projections/cyl/cyl_equal_area` |
2 changes: 1 addition & 1 deletion examples/projections/azim/azim_equidistant.py
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
r"""
Azimuthal Equidistant
Azimuthal equidistant
=====================

The main advantage of this projection is that distances from the projection
Expand Down
2 changes: 1 addition & 1 deletion examples/projections/azim/azim_general_perspective.py
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
r"""
General Perspective
General perspective
===================

The general perspective projection imitates the view of the Earth from a finite
Expand Down
2 changes: 1 addition & 1 deletion examples/projections/azim/azim_general_stereographic.py
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
r"""
General Stereographic
General stereographic
=====================

This map projection is a conformal, azimuthal projection. It is mainly used
Expand Down
4 changes: 2 additions & 2 deletions examples/projections/azim/azim_gnomonic.py
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
r"""
Gnomonic
========
Azimuthal gnomonic
==================

The point of perspective of the gnomonic projection lies at the center of the
Earth. As a consequence great circles (orthodromes) on the surface of the Earth
Expand Down
2 changes: 1 addition & 1 deletion examples/projections/azim/azim_lambert.py
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
r"""
Lambert Azimuthal Equal Area
Lambert azimuthal equal-area
============================

This projection was developed by Johann Heinrich Lambert in 1772 and is
Expand Down
4 changes: 2 additions & 2 deletions examples/projections/azim/azim_orthographic.py
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
r"""
Orthographic
============
Azimuthal orthographic
======================

This is a perspective projection like the general perspective, but with the
difference that the point of perspective lies in infinite distance.
Expand Down
2 changes: 1 addition & 1 deletion examples/projections/conic/conic_albers.py
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
r"""
Albers Conic Equal Area
Albers conic equal-area
=======================

This projection, developed by Heinrich C. Albers in 1805, is predominantly used
Expand Down
4 changes: 2 additions & 2 deletions examples/projections/conic/conic_lambert.py
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
r"""
Lambert Conic Conformal Projection
==================================
Lambert conic conformal
=======================

This conic projection was designed by the Alsatian mathematician Johann
Heinrich Lambert (1772) and has been used extensively for mapping of regions
Expand Down
2 changes: 1 addition & 1 deletion examples/projections/conic/polyconic.py
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
r"""
Polyconic Projection
(American) polyconic
====================

The polyconic projection, in Europe usually referred to as the American
Expand Down
4 changes: 2 additions & 2 deletions examples/projections/cyl/cyl_cassini.py
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
r"""
Cassini Cylindrical
============================
Cassini cylindrical
===================

This cylindrical projection was developed in 1745 by César-François Cassini de
Thury for the survey of France. It is occasionally called Cassini-Soldner since
Expand Down
4 changes: 2 additions & 2 deletions examples/projections/cyl/cyl_mercator.py
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
r"""
Mercator
========
Mercator cylindrical
====================

The Mercator projection takes its name from the Flemish cartographer Gheert
Cremer, better known as Gerardus Mercator, who presented it in 1569. The
Expand Down
2 changes: 1 addition & 1 deletion examples/projections/cyl/cyl_stereographic.py
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
r"""
Cylindrical Stereographic
Cylindrical stereographic
=========================

The cylindrical stereographic projections are certainly not as notable as other
Expand Down
4 changes: 2 additions & 2 deletions examples/projections/misc/misc_eckertIV.py
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
r"""
Eckert IV
=========
Eckert IV equal-area
====================

The Eckert IV projection, presented by the German cartographer Max
Eckert-Greiffendorff in 1906, is a pseudo-cylindrical equal-area projection.
Expand Down
4 changes: 2 additions & 2 deletions examples/projections/misc/misc_eckertVI.py
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
r"""
Eckert VI
=========
Eckert VI equal-area
====================

The Eckert VI projections, presented by the German cartographer Max
Eckert-Greiffendorff in 1906, is a pseudo-cylindrical equal-area projection.
Expand Down
4 changes: 2 additions & 2 deletions examples/projections/misc/misc_hammer.py
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
r"""
Hammer
======
Hammer equal-area
=================

The equal-area Hammer projection, first presented by the German mathematician
Ernst von Hammer in 1892, is also known as Hammer-Aitoff (the Aitoff projection
Expand Down
4 changes: 2 additions & 2 deletions examples/projections/misc/misc_mollweide.py
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
r"""
Mollweide
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I'm unsure about changes like this. According to https://en.wikipedia.org/wiki/List_of_map_projections, the official name for this projection should be "Mollweide" rather than "Mollweide equal-area". "equal-area" is just a property of this projection, not its name.

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Yes, I was unsure about this change. I used the upstream GMT table as an orientation. I fell it would be good, if both tables use the identical name for the projections. Maybe it is better to remove the "equal-area" and update the GMT table?

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Let's wait for the upstream change first.

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

So the GMT-related PR is merged. Let's continue here.
Do we want to make the projection names consistent with GMT or consistent between the overview table and the examples? For the later one, do we want to use the name from the GMT projection table or form the headings of the GMTdocumentation page?

Copy link
Member

@seisman seisman Sep 22, 2024 •
edited
Loading

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I think we should make the projection names consistent with headings of the GMT documentation.

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I have made a few adjustments in commit 013381e.

=========
Mollweide equal-area
====================
This pseudo-cylindrical, equal-area projection was developed by the German
mathematician and astronomer Karl Brandan Mollweide in 1805. Parallels are
Expand Down
4 changes: 2 additions & 2 deletions examples/projections/misc/misc_sinusoidal.py
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
r"""
Sinusoidal
==========
Sinusoidal equal-area
=====================

The sinusoidal projection is one of the oldest known projections, is
equal-area, and has been used since the mid-16th century. It has also been
Expand Down