Skip to content

Figure.coast: Improve documentation #3325

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

Merged
merged 5 commits into from
Jul 16, 2024
Merged

Figure.coast: Improve documentation #3325

Changes from all commits
Commits
Show all changes
5 commits
Select commit Hold shift + click to select a range
5f8ddc2
Use bullet point lists | Remove dumping and clipping options
yvonnefroehlich Jul 10, 2024
fd49464
Remove '+l|L' from 'dcw'
yvonnefroehlich Jul 10, 2024
3b55ff7
Add highlighting
yvonnefroehlich Jul 15, 2024
0042f64
More improvements
yvonnefroehlich Jul 15, 2024
3a78788
Merge branch 'main' into update-docs-coast-E
yvonnefroehlich Jul 16, 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
129 changes: 51 additions & 78 deletions pygmt/src/coast.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -41,19 +41,17 @@ def coast(self, **kwargs):
r"""
Plot continents, shorelines, rivers, and borders on maps.

Plots grayshaded, colored, or textured land-masses [or water-masses] on
Plots grayshaded, colored, or textured land masses [or water masses] on
maps and [optionally] draws coastlines, rivers, and political
boundaries. Alternatively, it can (1) issue clip paths that will
contain all land or all water areas, or (2) dump the data to an ASCII
table. The data files come in 5 different resolutions: (**f**)ull,
boundaries. The data files come in 5 different resolutions: (**f**)ull,
(**h**)igh, (**i**)ntermediate, (**l**)ow, and (**c**)rude. The full
resolution files amount to more than 55 Mb of data and provide great
detail; for maps of larger geographical extent it is more economical to
use one of the other resolutions. If the user selects to paint the
land-areas and does not specify fill of water-areas then the latter
land areas and does not specify fill of water areas then the latter
will be transparent (i.e., earlier graphics drawn in those areas will
not be overwritten). Likewise, if the water-areas are painted and no
land fill is set then the land-areas will be transparent.
not be overwritten). Likewise, if the water areas are painted and no
land fill is set then the land areas will be transparent.

A map projection must be supplied.

Expand All @@ -71,63 +69,47 @@ def coast(self, **kwargs):
lakes : str or list
*fill*\ [**+l**\|\ **+r**].
Set the shade, color, or pattern for lakes and river-lakes. The
default is the fill chosen for wet areas set by the ``water``
default is the fill chosen for "wet" areas set by the ``water``
parameter. Optionally, specify separate fills by appending
**+l** for lakes or **+r** for river-lakes, and passing multiple
strings in a list.
resolution : str
**f**\|\ **h**\|\ **i**\|\ **l**\|\ **c**.
Select the resolution of the data set to: (**f**\ )ull,
(**h**\ )igh, (**i**\ )ntermediate, (**l**\ )ow,
and (**c**\ )rude.
Select the resolution of the data set to: (**f**\ )ull, (**h**\ )igh,
(**i**\ )ntermediate, (**l**\ )ow, and (**c**\ )rude.
land : str
Select filling or clipping of "dry" areas.
Select filling of "dry" areas.
rivers : int, str, or list
*river*\ [/*pen*].
Draw rivers. Specify the type of rivers and [optionally] append
pen attributes [Default is ``"0.25p,black,solid"``].

Choose from the list of river types below; pass a list to
``rivers`` to use multiple arguments.

0 = Double-lined rivers (river-lakes)

1 = Permanent major rivers

2 = Additional major rivers

3 = Additional rivers

4 = Minor rivers

5 = Intermittent rivers - major

6 = Intermittent rivers - additional

7 = Intermittent rivers - minor

8 = Major canals

9 = Minor canals

10 = Irrigation canals
Choose from the list of river types below; pass a list to ``rivers``
to use multiple arguments.

- ``0``: Double-lined rivers (river-lakes)
- ``1``: Permanent major rivers
- ``2``: Additional major rivers
- ``3``: Additional rivers
- ``4``: Minor rivers
- ``5``: Intermittent rivers - major
- ``6``: Intermittent rivers - additional
- ``7``: Intermittent rivers - minor
- ``8``: Major canals
- ``9``: Minor canals
- ``10``: Irrigation canals

You can also choose from several preconfigured river groups:

a = All rivers and canals (0-10)

A = All rivers and canals except river-lakes (1-10)

r = All permanent rivers (0-4)
- ``"a"``: All rivers and canals (0-10)
- ``"A"``: All rivers and canals except river-lakes (1-10)
- ``"r"``: All permanent rivers (0-4)
- ``"R"``: All permanent rivers except river-lakes (1-4)
- ``"i"``: All intermittent rivers (5-7)
- ``"c"``: All canals (8-10)

R = All permanent rivers except river-lakes (1-4)

i = All intermittent rivers (5-7)

c = All canals (8-10)
map_scale : str
[**g**\|\ **j**\|\ **J**\|\ **n**\|\ **x**]\ *refpoint*\
**+w**\ *length*.
[**g**\|\ **j**\|\ **J**\|\ **n**\|\ **x**]\ *refpoint*\ **+w**\ *length*.
Draw a simple map scale centered on the reference point specified.
box : bool or str
[**+c**\ *clearances*][**+g**\ *fill*][**+i**\ [[*gap*/]\ *pen*]]\
Expand All @@ -150,48 +132,39 @@ def coast(self, **kwargs):
borders : int, str, or list
*border*\ [/*pen*].
Draw political boundaries. Specify the type of boundary and
[optionally] append pen attributes
[Default is ``"0.25p,black,solid"``].

Choose from the list of boundaries below. Pass a list to
``borders`` to use multiple arguments.

1 = National boundaries
[optionally] append pen attributes [Default is ``"0.25p,black,solid"``].

2 = State boundaries within the Americas
Choose from the list of boundaries below. Pass a list to ``borders`` to
use multiple arguments.

3 = Marine boundaries
- ``1``: National boundaries
- ``2``: State boundaries within the Americas
- ``3``: Marine boundaries
- ``"a"``: All boundaries (1-3)

a = All boundaries (1-3)
water : str
Select filling or clipping of "wet" areas.
Select filling "wet" areas.
shorelines : int, str, or list
[*level*\ /]\ *pen*.
Draw shorelines [Default is no shorelines]. Append pen attributes
[Default is ``"0.25p,black,solid"``] which
apply to all four levels. To set the pen for a single level,
pass a string with *level*\ /*pen*\ , where level is
1-4 and represent coastline, lakeshore, island-in-lake shore, and
lake-in-island-in-lake shore. Pass a list of *level*\ /*pen*
[Default is ``"0.25p,black,solid"``] which apply to all four levels.
To set the pen for a single level, pass a string with *level*\ /*pen*\ ,
where level is 1-4 and represent coastline, lakeshore, island-in-lake shore,
and lake-in-island-in-lake shore. Pass a list of *level*\ /*pen*
strings to ``shorelines`` to set multiple levels. When specific
level pens are set, those not listed will not be drawn.
dcw : str or list
*code1,code2,…*\ [**+l**\|\ **L**\ ][**+g**\ *fill*\ ]
[**+p**\ *pen*\ ][**+z**].
Select painting or dumping country polygons from the
`Digital Chart of the World
*code1,code2,…*\ [**+g**\ *fill*\ ][**+p**\ *pen*\ ][**+z**].
Select painting country polygons from the `Digital Chart of the World
<https://en.wikipedia.org/wiki/Digital_Chart_of_the_World>`__.
Append one or more comma-separated countries using the 2-character
`ISO 3166-1 alpha-2 convention
<https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2>`__.
To select a state of a country (if available), append
.\ *state*, (e.g, US.TX for Texas). To specify a whole continent,
prepend **=** to any of the continent codes (e.g. =EU for Europe).
Append **+p**\ *pen* to draw polygon outlines
[Default is no outline] and **+g**\ *fill* to fill them
[Default is no fill]. Append **+l**\|\ **+L** to =\ *continent* to
only list countries in that continent; repeat if more than one
continent is requested.
To select a state of a country (if available), append .\ *state*,
(e.g, ``"US.TX"`` for Texas). To specify a whole continent, prepend **=**
to any of the continent codes (e.g. ``"=EU"`` for Europe). Append
**+p**\ *pen* to draw polygon outlines [Default is no outline] and
**+g**\ *fill* to fill them [Default is no fill].
{panel}
{perspective}
{transparency}
Expand All @@ -204,11 +177,11 @@ def coast(self, **kwargs):
>>> fig = pygmt.Figure()
>>> # Call the coast method for the plot
>>> fig.coast(
... # Set the projection to Mercator, and plot size to 10 cm
... # Set the projection to Mercator, and the plot width to 10 centimeters
... projection="M10c",
... # Set the region of the plot
... region=[-10, 30, 30, 60],
... # Set the frame of the plot
... # Set the frame of the plot, here annotations and major ticks
... frame="a",
... # Set the color of the land to "darkgreen"
... land="darkgreen",
Expand Down
Loading