22
22
23
23
## Why PyGMT?
24
24
25
- A beautiful map is worth a thousand words. To truly understand how powerful PyGMT is, play with it online on
26
- [ Binder] ( https://github.com/GenericMappingTools/try-gmt ) ! For a quicker introduction, check out our
27
- [ 3 minute overview] ( https://youtu.be/4iPnITXrxVU ) !
25
+ A beautiful map is worth a thousand words. To truly understand how powerful PyGMT is,
26
+ play with it online on [ Binder] ( https://github.com/GenericMappingTools/try-gmt ) ! For a
27
+ quicker introduction, check out our [ 3 minute overview] ( https://youtu.be/4iPnITXrxVU ) !
28
28
29
- Afterwards, feel free to look at our [ Tutorials] ( https://www.pygmt.org/latest/tutorials ) , visit the
30
- [ Gallery] ( https://www.pygmt.org/latest/gallery ) , and check out some
29
+ Afterwards, feel free to look at our [ Tutorials] ( https://www.pygmt.org/latest/tutorials ) ,
30
+ visit the [ Gallery] ( https://www.pygmt.org/latest/gallery ) , and check out some
31
31
[ external PyGMT examples] ( https://www.pygmt.org/latest/external_resources.html ) !
32
32
33
- ![ Quick Introduction to PyGMT YouTube Video] ( doc/_static/scipy2022-youtube-thumbnail.jpg )
33
+ ![ Quick Introduction to PyGMT YouTube Video] ( https://raw.githubusercontent.com/GenericMappingTools/pygmt/refs/heads/main/ doc/_static/scipy2022-youtube-thumbnail.jpg)
34
34
35
35
## About
36
36
37
- PyGMT is a library for processing geospatial and geophysical data and making publication-quality
38
- maps and figures. It provides a Pythonic interface for the
39
- [ Generic Mapping Tools (GMT)] ( https://github.com/GenericMappingTools/gmt ) , a command-line program
40
- widely used across the Earth, Ocean, and Planetary sciences and beyond.
37
+ PyGMT is a library for processing geospatial and geophysical data and making
38
+ publication-quality maps and figures. It provides a Pythonic interface for the
39
+ [ Generic Mapping Tools (GMT)] ( https://github.com/GenericMappingTools/gmt ) , a command-line
40
+ program widely used across the Earth, Ocean, and Planetary sciences and beyond.
41
41
42
42
## Project goals
43
43
44
44
- Make GMT more accessible to new users.
45
45
- Build a Pythonic API for GMT.
46
46
- Interface with the GMT C API directly using ctypes (no system calls).
47
47
- Support for rich display in the Jupyter notebook.
48
- - Integration with the [ scientific Python ecosystem] ( https://scientific-python.org/ ) : ` numpy.ndarray ` or
49
- ` pandas.DataFrame ` for data tables, ` xarray.DataArray ` for grids, and ` geopandas.GeoDataFrame ` for geographical data.
48
+ - Integration with the [ scientific Python ecosystem] ( https://scientific-python.org/ ) :
49
+ ` numpy.ndarray ` or ` pandas.DataFrame ` for data tables, ` xarray.DataArray ` for grids,
50
+ and ` geopandas.GeoDataFrame ` for geographical data.
50
51
51
52
## Quickstart
52
53
@@ -69,7 +70,8 @@ For other ways to install `pygmt`, see the [full installation instructions](http
69
70
### Getting started
70
71
71
72
As a starting point, you can open a [ Python interpreter] ( https://docs.python.org/3/tutorial/interpreter.html )
72
- or a [ Jupyter notebook] ( https://docs.jupyter.org/en/latest/running.html ) , and try the following example:
73
+ or a [ Jupyter notebook] ( https://docs.jupyter.org/en/latest/running.html ) , and try the
74
+ following example:
73
75
74
76
``` python
75
77
import pygmt
@@ -79,18 +81,18 @@ fig.text(position="MC", text="PyGMT", font="80p,Helvetica-Bold,red@75")
79
81
fig.show()
80
82
```
81
83
82
- You should see a global map with land and water masses colored in tan and lightblue, respectively. On top,
83
- there should be the semi-transparent text "PyGMT". For more examples, please have a look at the
84
- [ Gallery] ( https://www.pygmt.org/latest/gallery/index.html ) and
84
+ You should see a global map with land and water masses colored in tan and lightblue,
85
+ respectively. On top, there should be the semi-transparent text "PyGMT". For more examples,
86
+ please have a look at the [ Gallery] ( https://www.pygmt.org/latest/gallery/index.html ) and
85
87
[ Tutorials] ( https://www.pygmt.org/latest/tutorials/index.html ) .
86
88
87
89
## Contacting us
88
90
89
91
- Most discussion happens [ on GitHub] ( https://github.com/GenericMappingTools/pygmt ) .
90
- Feel free to [ open an issue] ( https://github.com/GenericMappingTools/pygmt/issues/new ) or comment on any open
91
- issue or pull request.
92
- - We have a [ Discourse forum] ( https://forum.generic-mapping-tools.org/c/questions/pygmt-q-a ) where you can ask
93
- questions and leave comments.
92
+ Feel free to [ open an issue] ( https://github.com/GenericMappingTools/pygmt/issues/new )
93
+ or comment on any open issue or pull request.
94
+ - We have a [ Discourse forum] ( https://forum.generic-mapping-tools.org/c/questions/pygmt-q-a )
95
+ where you can ask questions and leave comments.
94
96
95
97
## Contributing
96
98
@@ -109,26 +111,29 @@ to see how you can help and give feedback.
109
111
110
112
** We want your help.** No, really.
111
113
112
- There may be a little voice inside your head that is telling you that you're not ready to be an open source
113
- contributor; that your skills aren't nearly good enough to contribute. What could you possibly offer?
114
+ There may be a little voice inside your head that is telling you that you're not ready
115
+ to be an open source contributor; that your skills aren't nearly good enough to
116
+ contribute. What could you possibly offer?
114
117
115
118
We assure you that the little voice in your head is wrong.
116
119
117
- ** Being a contributor doesn't just mean writing code.** Equally important contributions include: writing or
118
- proof-reading documentation, suggesting or implementing tests, or even giving feedback about the project
119
- (including giving feedback about the contribution process). If you're coming to the project with fresh eyes,
120
- you might see the errors and assumptions that seasoned contributors have glossed over. If you can write any
121
- code at all, you can contribute code to open source. We are constantly trying out new skills, making mistakes,
122
- and learning from those mistakes. That's how we all improve and we are happy to help others learn.
120
+ ** Being a contributor doesn't just mean writing code.** Equally important contributions
121
+ include: writing or proof-reading documentation, suggesting or implementing tests, or
122
+ even giving feedback about the project (including giving feedback about the contribution
123
+ process). If you're coming to the project with fresh eyes, you might see the errors and
124
+ assumptions that seasoned contributors have glossed over. If you can write any code at
125
+ all, you can contribute code to open source. We are constantly trying out new skills,
126
+ making mistakes, and learning from those mistakes. That's how we all improve and we are
127
+ happy to help others learn.
123
128
124
129
* This disclaimer was adapted from the* [ MetPy project] ( https://github.com/Unidata/MetPy ) .
125
130
126
131
## Citing PyGMT
127
132
128
133
PyGMT is a community developed project. See the
129
- [ AUTHORS.md] ( https://github.com/GenericMappingTools/pygmt/blob/main/AUTHORS.md ) file on GitHub for a list of
130
- the people involved and a definition of the term "PyGMT Developers". Feel free to cite our work in your
131
- research using the following BibTeX:
134
+ [ AUTHORS.md] ( https://github.com/GenericMappingTools/pygmt/blob/main/AUTHORS.md ) file
135
+ on GitHub for a list of the people involved and a definition of the term "PyGMT Developers".
136
+ Feel free to cite our work in your research using the following BibTeX:
132
137
133
138
```
134
139
@software{
@@ -162,10 +167,10 @@ research using the following BibTeX:
162
167
```
163
168
164
169
To cite a specific version of PyGMT, go to our Zenodo page at < https://doi.org/10.5281/zenodo.3781524 >
165
- and use the "Export to BibTeX" function there. It is also strongly recommended to cite the
166
- [ GMT 6 paper] ( https://doi.org/10.1029/2019GC008515 ) (which PyGMT wraps around). Note that some modules
167
- like ` dimfilter ` , ` surface ` , and ` x2sys ` also have their dedicated citations. Further information for
168
- all these can be found at < https://www.generic-mapping-tools.org/cite > .
170
+ and use the "Export to BibTeX" function there. It is also strongly recommended to cite
171
+ the [ GMT 6 paper] ( https://doi.org/10.1029/2019GC008515 ) (which PyGMT wraps around). Note
172
+ that some modules like ` dimfilter ` , ` surface ` , and ` x2sys ` also have their dedicated
173
+ citations. Further information for all these can be found at < https://www.generic-mapping-tools.org/cite > .
169
174
170
175
## License
171
176
0 commit comments