-
Notifications
You must be signed in to change notification settings - Fork 342
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
Improve sample1d -F docs #6643
Comments
Sure, we could have a plot near the top of sample1d. There are similar types of plots in the test/sample1d dir. Note, however, that -Fs is the only directive that takes the fit argument, so |
I found the example. I remove the slope and curvature graphs. I think it is a better graph.
|
Yes, very nice. But a few questions:
|
I’ve never seen a figure in a program’s docs (I think?). Love the idea. |
Check out grdseamount or movie or events. |
The new version of the figure.
|
Nice! Would you like to try to make this into doc/scripts/GMT_splines.sh and follow the Contributing Guide on documentation on how to add a new test or script? I've followed @meghanrjones's write-up myself and it should be OK. You can see in the doc/rst/source/movie.rst or others for what to do to add a figure to the documentation. If you start such a pull request then I can help if you get stuck. Look at the other scripts in doc/script for how to set up names etc. Oh, maybe add "x" as label to go with the u(x) for the y-axis? |
Nice example! I would suggest using SI units rather than US units in the script. |
Awesome example @Esteban82! I can answer questions about the process for adding it to the docs if you decide to do that. In order to push the example image to the dvc repo, you would need to let me or @seisman know after you've created a DAGsHub account so that we can give you write permissions. |
Yes, I will try to add the figure. I only have one doubts. What is the optimal height and length (-JX) of the graph for the docs? I think it should be shorter. |
Most of the time I prefer figs with aspect ratios as you have it. Wider than the hight. I think it is OK. |
Thanks Max. This is my account: https://dagshub.com/Esteban82 |
Great, you've been added to the team on DAGsHub and should be good to go. Let me know if you run into any problems. |
This PR is related to issue #6643. It add a new figure and script to better explain the splines in the docs. Here I add the script. Let me know if it is ok. In what part of the docs should the figure go? At the end of -F argument?
@PaulWessel : on the same track #6611 ... @Esteban82's work could be extended? |
* Add files via upload This PR is related to issue #6643. It add a new figure and script to better explain the splines in the docs. Here I add the script. Let me know if it is ok. In what part of the docs should the figure go? At the end of -F argument? * Update GMT_splines.sh Updated script following Paul's suggestions. * Update GMT_splines.sh Changed name and format of the output file. * Set executable permissionm * Update images.dvc * Update sample1d.rst * Update GMT_splines.sh Fix whiespace * Update images.dvc Co-authored-by: Paul Wessel <[email protected]>
In order to understand well sample1d -F I made the following figure.
I think it could be add to the doc to help the users. What do you think? If so, Are you ok with the figure? Any ideas on how to improve it (besides adding a legend and maybe play a bit with the colors)?
The text was updated successfully, but these errors were encountered: