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 tutorial section on passing xr.Dataset with 1-D data_vars as input #3147

Draft
wants to merge 1 commit into
base: main
Choose a base branch
from

Conversation

weiji14
Copy link
Member

@weiji14 weiji14 commented Mar 29, 2024

Description of proposed changes

Show how an xarray.Dataset with 1-D data variables can be passed into the data parameter of PyGMT functions/methods.

Preview at https://pygmt-dev--3147.org.readthedocs.build/en/3147/get_started/04_table_inputs.html#xarray-dataset-with-1-d-data-variables

Addresses #3146, #1268

Reminders

  • Run make format and make check to make sure the code follows the style guide.
  • Add tests for new features or tests that would have caught the bug that you're fixing.
  • Add new public functions/methods/classes to doc/api/index.rst.
  • Write detailed docstrings for all functions/methods.
  • If wrapping a new module, open a 'Wrap new GMT module' issue and submit reasonably-sized PRs.
  • If adding new functionality, add an example to docstrings or tutorials.
  • Use underscores (not hyphens) in names of Python files and directories.

Slash Commands

You can write slash commands (/command) in the first line of a comment to perform
specific operations. Supported slash command is:

  • /format: automatically format and lint the code

Show how an xarray.Dataset with 1-D data variables can be passed into the `data` parameter of PyGMT functions/methods.
@weiji14 weiji14 added the documentation Improvements or additions to documentation label Mar 29, 2024
@weiji14 weiji14 added this to the 0.12.0 milestone Mar 29, 2024
@weiji14 weiji14 self-assigned this Mar 29, 2024
@seisman seisman removed this from the 0.12.0 milestone Apr 29, 2024
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
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants