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 for working with table inputs in PyGMT #2722

Merged
merged 28 commits into from
Dec 13, 2023

Conversation

seisman
Copy link
Member

@seisman seisman commented Oct 8, 2023

Description of proposed changes

Explain the table input types as mentioned in #1268.

Preview: https://pygmt-dev--2722.org.readthedocs.build/en/2722/get_started/04_table_inputs.html
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 commands are:

  • /format: automatically format and lint the code
  • /test-gmt-dev: run full tests on the latest GMT development version

@seisman seisman added the documentation Improvements or additions to documentation label Oct 8, 2023
@seisman seisman added this to the 0.11.0 milestone Oct 8, 2023
@seisman seisman marked this pull request as ready for review October 8, 2023 09:01
@seisman seisman added the needs review This PR has higher priority and needs review. label Oct 8, 2023
@seisman seisman removed the needs review This PR has higher priority and needs review. label Oct 8, 2023
Copy link
Member

@yvonnefroehlich yvonnefroehlich left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Just made some typo and formating comments. Have to look at the conent in more detail later.

examples/get_started/04_working_with_tables.py Outdated Show resolved Hide resolved
examples/get_started/04_working_with_tables.py Outdated Show resolved Hide resolved
examples/get_started/04_working_with_tables.py Outdated Show resolved Hide resolved
examples/get_started/04_working_with_tables.py Outdated Show resolved Hide resolved
examples/get_started/04_working_with_tables.py Outdated Show resolved Hide resolved
examples/get_started/04_working_with_tables.py Outdated Show resolved Hide resolved
examples/get_started/04_working_with_tables.py Outdated Show resolved Hide resolved
examples/get_started/04_working_with_tables.py Outdated Show resolved Hide resolved
examples/get_started/04_working_with_tables.py Outdated Show resolved Hide resolved
examples/get_started/04_working_with_tables.py Outdated Show resolved Hide resolved
Co-authored-by: Yvonne Fröhlich <94163266+yvonnefroehlich@users.noreply.github.com>
@seisman seisman added the needs review This PR has higher priority and needs review. label Oct 19, 2023
@seisman seisman requested a review from a team October 24, 2023 14:49
Co-authored-by: Yvonne Fröhlich <94163266+yvonnefroehlich@users.noreply.github.com>
examples/get_started/04_table_inputs.py Outdated Show resolved Hide resolved
examples/get_started/04_table_inputs.py Outdated Show resolved Hide resolved
examples/get_started/04_table_inputs.py Outdated Show resolved Hide resolved
examples/get_started/04_table_inputs.py Outdated Show resolved Hide resolved
examples/get_started/04_table_inputs.py Outdated Show resolved Hide resolved
examples/get_started/04_table_inputs.py Outdated Show resolved Hide resolved
seisman and others added 2 commits October 25, 2023 00:15
Co-authored-by: Yvonne Fröhlich <94163266+yvonnefroehlich@users.noreply.github.com>
seisman and others added 2 commits November 2, 2023 23:11
Co-authored-by: Yvonne Fröhlich <94163266+yvonnefroehlich@users.noreply.github.com>
@seisman seisman requested a review from a team November 4, 2023 15:30
seisman and others added 2 commits November 5, 2023 05:55
Co-authored-by: Yvonne Fröhlich <94163266+yvonnefroehlich@users.noreply.github.com>
examples/get_started/04_table_inputs.py Outdated Show resolved Hide resolved
examples/get_started/04_table_inputs.py Outdated Show resolved Hide resolved
@seisman seisman requested a review from a team December 4, 2023 16:36
examples/get_started/04_table_inputs.py Outdated Show resolved Hide resolved
examples/get_started/04_table_inputs.py Outdated Show resolved Hide resolved
examples/get_started/04_table_inputs.py Outdated Show resolved Hide resolved
seisman and others added 2 commits December 12, 2023 08:34
Co-authored-by: Wei Ji <23487320+weiji14@users.noreply.github.com>
examples/get_started/04_table_inputs.py Outdated Show resolved Hide resolved
examples/get_started/04_table_inputs.py Outdated Show resolved Hide resolved
Comment on lines +2 to +3
4. PyGMT I/O: Table inputs
==========================
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I/O means Input/Output, but this tutorial is only on inputs 🙂 Will the 'Output' part be added as a separate page? Or do we want multiple parts like:

  • 4.1 PyGMT I/O: Table inputs
  • 4.2 PyGMT I/O: Table outputs
  • 4.3 PyGMT I/O: Grid inputs
  • 4.4 PyGMT I/O: Grid outputs

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Yes, that's my plan, but I may prefer to the following order:

4.1 PyGMT I/O: Table inputs
4.2 PyGMT I/O: Grid inputs
4.3 PyGMT I/O: Table outputs
4.4 PyGMT I/O: Grid outputs

Co-authored-by: Wei Ji <23487320+weiji14@users.noreply.github.com>
Copy link
Member

@weiji14 weiji14 left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thanks @seisman! Might need to update this once we get more PyArrow support (#2800), but good to start with the basics first!

@weiji14 weiji14 added final review call This PR requires final review and approval from a second reviewer and removed needs review This PR has higher priority and needs review. labels Dec 12, 2023
@seisman seisman merged commit d460b07 into main Dec 13, 2023
9 checks passed
@seisman seisman deleted the tutorial/working-with-tables branch December 13, 2023 09:17
@seisman seisman removed the final review call This PR requires final review and approval from a second reviewer label Dec 13, 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
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants