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.

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

Add a tutorial explaining the generally accepted input types #1268

Open
seisman opened this issue May 10, 2021 · 3 comments
Open

Add a tutorial explaining the generally accepted input types #1268

seisman opened this issue May 10, 2021 · 3 comments
Labels
documentation Improvements or additions to documentation help wanted Helping hands are appreciated

Comments

@seisman
Copy link
Member

seisman commented May 10, 2021

Inspired by PR #1186.

For GMT CLI, there are mainly two types of input: a table or a grid. PyGMT is more powerful and can accept more input types.

For a table input, PyGMT functions generally accept the following input types:

For a grid input, PyGMT functions generally accept the following input types:

  • a file name to a grid file, e.g., grid="input_grid.nc"
  • xarray.DataArray, e.g., grid=grid
  • more?

Although these various input data types are already used in different tutorials and examples, I think it would be better to have a standalone tutorial, explaining these input types.

@seisman seisman added the documentation Improvements or additions to documentation label May 10, 2021
@weiji14 weiji14 added the help wanted Helping hands are appreciated label May 10, 2021
@weiji14 weiji14 added the scipy-sprint Things to work on during the SciPy sprint! label Jul 6, 2021
@maxrjones maxrjones added eswn-workshop Good issues for first-contributions during the ESWN-PyGMT workshop and removed scipy-sprint Things to work on during the SciPy sprint! labels Aug 17, 2021
@seisman seisman removed the eswn-workshop Good issues for first-contributions during the ESWN-PyGMT workshop label Feb 26, 2022
@weiji14
Copy link
Member

weiji14 commented Feb 27, 2022

Also should mention that plotting shapefiles directly using plot and plot3d (maybe others too?) is supported. Xref #1616 and https://docs.generic-mapping-tools.org/6.3/cookbook/file-formats.html?highlight=shapefile#shapefiles

@seisman seisman added this to the 0.6.1 milestone Mar 18, 2022
@seisman
Copy link
Member Author

seisman commented Mar 19, 2022

pathlib.Path support was added in #1382.

@weiji14
Copy link
Member

weiji14 commented Jul 5, 2023

Working on supporting 3-band xarray.DataArray inputs at #2590, this would be in addition to regular 1-band xarray.DataArray inputs (e.g. DEMs).

@weiji14 weiji14 modified the milestones: 0.10.0, 0.11.0 Aug 29, 2023
@seisman seisman unpinned this issue Dec 3, 2023
@seisman seisman modified the milestones: 0.11.0, 0.12.0 Dec 11, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation help wanted Helping hands are appreciated
Projects
None yet
Development

No branches or pull requests

3 participants