-
Notifications
You must be signed in to change notification settings - Fork 219
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 plotting vectors #1070
Conversation
💖 Thanks for opening this pull request! 💖 Please make sure you read our contributing guidelines and abide by our code of conduct. A few things to keep in mind:
|
@seisman this should be it for our final changes for now. Please let me know if there is anything else you'd like us to add. I left one comment unresolved because I thought it would be a nice idea to add 2 examples to explain the |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
@noorbuchi Great work! Just a few small suggestions and I'm OK with this PR.
@seisman great! I'll be adding those in few minutes |
@seisman Just added your requested changes! everything should be OK. This has been a great community to work with, we will likely start working on another issue in this project very soon. |
@noorbuchi Could you please also click the "Update branch" button so that this branch is up-to-date with our master branch? @core-man It would be great if you can give this PR a final review, but please only suggest small changes if possible. For any big changes, you can still leave your comments here, but we will most likely work on them in a separate RP. |
Looks great to merge this PR. Thanks a lot, @noorbuchi @nathandloria @cklima616 for the great tutorial. I think a lot of PyGMT users will learn a lot from it. Please see the above minor comments. |
Co-authored-by: Yao Jiayuan <[email protected]>
@core-man thanks again for the review. I just added those changes so everything should be set for now. |
🎉🎉🎉 Congrats on merging your first pull request and welcome to the team! 🎉🎉🎉 Please open a new pull request to add yourself to the |
Great work! Thanks for the contribution. |
Co-authored-by: Nathan Loria <[email protected]> Co-authored-by: Claire Klima <[email protected]> Co-authored-by: Claire <[email protected]> Co-authored-by: Nathandloria <[email protected]> Co-authored-by: Megan Munzek <[email protected]> Co-authored-by: Yao Jiayuan <[email protected]> Co-authored-by: Dongdong Tian <[email protected]> Co-authored-by: Meghan Jones <[email protected]> Co-authored-by: Michael Grund <[email protected]>
In this pull request, we plan to add a tutorial to plot different types of vectors. This includes steps for:
We are open to adding different types of examples as we get more feedback on this PR so please let us know if you'd like to see more/different variations.
These changes are being developed in response to issue #892 which requested this documentation. We agree that adding a tutorial would be very helpful for new users who want to learn how to plot vectors using PyGMT.
Our current progress: We created a copy of
lines.py
with existing examples and we plan to follow a similar format but with vector examples. As of opening this PR, we have a draft of 2 examples, one is cartesian and the other is circular, which we are still revising.We really appreciate any feedback we can get on this PR. The goal is to have an easy-to-understand and comprehensive tutorial for creating vectors using PyGMT.
Fixes #892
Reminders
make format
andmake check
to make sure the code follows the style guide.doc/api/index.rst
.Slash Commands
You can write slash commands (
/command
) in the first line of a comment to performspecific operations. Supported slash commands are:
/format
: automatically format and lint the code/test-gmt-dev
: run full tests on the latest GMT development version