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

WIP: Add tutorial showing how to plot focal mechanisms (beachballs) #2550

Draft
wants to merge 92 commits into
base: main
Choose a base branch
from

Conversation

yvonnefroehlich
Copy link
Member

@yvonnefroehlich yvonnefroehlich commented May 29, 2023

Description of proposed changes

This PR aims to add a tutorial showing how to plot focal mechanisms using pygmt.Figure.meca. It focuses on how the display of the beachballs can be adjusted and modified:

  • Filling the quadrants
  • Plotting the components of a seismic moment tensor
  • Adjusting the outlines
  • Highlighting the nodal planes
  • Adding offset from the event location
  • Adding a label
  • Using size-coding and color-coding

Related PRs:

Preview: https://pygmt-dev--2550.org.readthedocs.build/en/2550/tutorials/advanced/focal_mechanisms.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

@yvonnefroehlich yvonnefroehlich added the documentation Improvements or additions to documentation label May 29, 2023
@yvonnefroehlich yvonnefroehlich added this to the 0.11.0 milestone May 29, 2023
@yvonnefroehlich yvonnefroehlich self-assigned this May 29, 2023
@yvonnefroehlich yvonnefroehlich marked this pull request as draft May 29, 2023 19:07
@yvonnefroehlich yvonnefroehlich changed the title Add tutorial showing how to plot focal mechanisms (beachballs) WIP: Add tutorial showing how to plot focal mechanisms (beachballs) May 29, 2023
@yvonnefroehlich
Copy link
Member Author

/format

@yvonnefroehlich
Copy link
Member Author

So far this tutorial covers these aspects:

  • Filling the quadrants
  • Plotting the components of a seismic moment tensor (maybe to specific ?)
  • Adjusting the outlines
  • Highlighting the nodal planes
  • Adding offset from the event location
  • Adding a label
  • Using size-coding and color-coding

It does not address details regarding allowed input formats and supported conventions.

Are there any other aspects people think are important to mention? If not, I will continue to improve and complete the comments and documentation 🙂.

@yvonnefroehlich yvonnefroehlich added enhancement Improving an existing feature and removed enhancement Improving an existing feature labels Oct 16, 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.

4 participants