Add the PyGMT ecosystem page #3475
Conversation
seisman
added
documentation
seisman
changed the title
seisman
changed the title
seisman
added
needs review
|
Do you plan to also add the packages that rely on PyGMT as mentioned in the bottom of the page in this PR? |
I feel we shouldn't add any packages without asking for permission from the package maintainers. Similar to what geopandas is doing (https://geopandas.org/en/stable/community/ecosystem.html), we may add a note like:
|
|
|
||
| #### NumPy | ||
|
|
||
| [NumPy][] is the fundamental package for scientific computing in Python. It is a Python |
There was a problem hiding this comment.
The NumPy description comes from https://numpy.org/doc/stable/user/whatisnumpy.html#whatisnumpy.
|
|
||
| #### pandas | ||
|
|
||
| [pandas][] is a Python package providing fast, flexible, and expressive data structures |
There was a problem hiding this comment.
This paragraph comes from https://pandas.pydata.org/docs/getting_started/overview.html.
|
|
||
| #### Xarray | ||
|
|
||
| [Xarray][] is an open source project and Python package that introduces labels in the |
There was a problem hiding this comment.
This paragraph comes from https://xarray.dev/.
doc/ecosystem.md
Outdated
|
|
||
| #### rioxarray | ||
|
|
||
| [rioxarray][] is a geospatial [Xarray][] extension powered by rasterio. Built on top of |
There was a problem hiding this comment.
I can't remember where I found the rioxarray description. Maybe it's written by ChatGPT.
|
|
||
| #### PyArrow | ||
|
|
||
| [Apache Arrow][] is a development platform for in-memory analytics. It contains a set of |
There was a problem hiding this comment.
| (also named "PyArrow") have first-class integration with NumPy, pandas, and built-in | ||
| Python objects. They are based on the C++ implementation of Arrow. | ||
|
|
||
| ```{note} |
There was a problem hiding this comment.
This note is copied from https://www.pygmt.org/dev/install.html with updates from PR #2933.
The plan is to remove the note from https://www.pygmt.org/dev/install.html. See PR #3506.
|
|
||
| Various packages rely on PyGMT for geospatial data processing, analysis, and visualization. | ||
| Below is an incomplete list (in no particular order) of tools which form the PyGMT-related | ||
| ecosystem. |
There was a problem hiding this comment.
For a package that rely on PyGMT, I think a short description about the package itself and how PyGMT is used in the package is enough.
For example, I know SHTOOLS maintained by MarkWieczorek uses PyGMT. I expect to see it listed here like below:
### SHTOOLS
pyshtools is an archive of Python software that can be used for spherical harmonic transforms, multitaper spectral analyses, expansions of gridded data into Slepian basis functions, and standard operations on global gravitational and magnetic field data.
It uses PyGMT for the creation of publication quality maps.
I don't plan to add SHTOOLS myself. Instead, after merging this PR, I prefer to ping MarkWieczorek to see if he is willing to add SHTOOLS himself.
Co-authored-by: Michael Grund <[email protected]>
Co-authored-by: Yvonne Fröhlich <[email protected]>
Co-authored-by: Yvonne Fröhlich <[email protected]>
seisman
force-pushed
the
doc/ecosystem
branch
from
4f2ac29
to
086fb10
Compare
|
@GenericMappingTools/pygmt-maintainers I think this PR is ready for final reviews. |
|
Ping @GenericMappingTools/pygmt-maintainers for final reviews. Will merge in 48 hours if no further comments. |
seisman
added
final review call
Description of proposed changes
Address #3371.
Adapted from https://geopandas.org/en/latest/community/ecosystem.html.
Preview: https://pygmt-dev--3475.org.readthedocs.build/en/3475/ecosystem.html