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

Convert test script for segmentizing to doc plot #7967

Merged
merged 10 commits into from
Nov 3, 2023
Merged

Conversation

PaulWessel
Copy link
Member

See #7911 for background. Since plot -F is a bit obscure it can really benefit from an illustration. We had two tests for this and I have removed one of them and converted the other to a tighter and better legend figure for plot.rst. Figure looks like this (based on old test/psxy/geosegmentize.sh that is now deleted, replaced by doc/scripts/GMT_segmentize.sh):

GMT_segmentize

DVC has been updated with the new and removed plots.

Since plot -F is a bit obscure it really benefits from illustrations.  We have two tests and I have removed one of then and converted it to a tighter figure for plot.rst.
@PaulWessel PaulWessel added the documentation Improve documentation label Oct 23, 2023
@PaulWessel PaulWessel added this to the 6.5.0 milestone Oct 23, 2023
@PaulWessel PaulWessel requested a review from a team October 23, 2023 10:47
@PaulWessel PaulWessel self-assigned this Oct 23, 2023
@github-actions
Copy link
Contributor

github-actions bot commented Oct 23, 2023

Summary of changed images

This is an auto-generated report of images that have changed on the DVC remote

Status Path
deleted doc/scripts/images/GMT_-B_custom.ps
deleted doc/scripts/images/GMT_-B_geo_1.ps
deleted doc/scripts/images/GMT_-B_geo_2.ps
deleted doc/scripts/images/GMT_-B_linear.ps
deleted doc/scripts/images/GMT_-B_log.ps
deleted doc/scripts/images/GMT_-B_pow.ps
deleted doc/scripts/images/GMT_-B_radians.ps
deleted doc/scripts/images/GMT_-B_slanted.ps
deleted doc/scripts/images/GMT_-B_time1.ps
deleted doc/scripts/images/GMT_-B_time2.ps
deleted doc/scripts/images/GMT_-B_time3.ps
deleted doc/scripts/images/GMT_-B_time4.ps
deleted doc/scripts/images/GMT_-B_time5.ps
deleted doc/scripts/images/GMT_-B_time6.ps
deleted doc/scripts/images/GMT_-B_time7.ps
deleted doc/scripts/images/GMT_-J.ps
deleted doc/scripts/images/GMT_-R.ps
deleted doc/scripts/images/GMT_-U.ps
deleted doc/scripts/images/GMT_-XY.ps
deleted doc/scripts/images/GMT_API_flow.ps
deleted doc/scripts/images/GMT_API_use.ps
deleted doc/scripts/images/GMT_App_E.ps
deleted doc/scripts/images/GMT_App_F_stand+_iso+.ps
deleted doc/scripts/images/GMT_App_F_symbol_dingbats.ps
deleted doc/scripts/images/GMT_App_G.ps
deleted doc/scripts/images/GMT_App_J_1.ps
deleted doc/scripts/images/GMT_App_J_2.ps
deleted doc/scripts/images/GMT_App_J_3.ps
deleted doc/scripts/images/GMT_App_K_1.ps
deleted doc/scripts/images/GMT_App_K_2.ps
deleted doc/scripts/images/GMT_App_K_3.ps
deleted doc/scripts/images/GMT_App_K_4.ps
deleted doc/scripts/images/GMT_App_K_5.ps
deleted doc/scripts/images/GMT_App_M_1a.ps
deleted doc/scripts/images/GMT_App_M_1b.ps
deleted doc/scripts/images/GMT_App_M_1c.ps
deleted doc/scripts/images/GMT_App_M_1d.ps
deleted doc/scripts/images/GMT_App_M_2.ps
deleted doc/scripts/images/GMT_App_N_1.ps
deleted doc/scripts/images/GMT_App_O_1.ps
deleted doc/scripts/images/GMT_App_O_2.ps
deleted doc/scripts/images/GMT_App_O_3.ps
deleted doc/scripts/images/GMT_App_O_4.ps
deleted doc/scripts/images/GMT_App_O_5.ps
deleted doc/scripts/images/GMT_App_O_6.ps
deleted doc/scripts/images/GMT_App_O_7.ps
deleted doc/scripts/images/GMT_App_O_8.ps
deleted doc/scripts/images/GMT_App_O_9.ps
deleted doc/scripts/images/GMT_CPTscale.ps
deleted doc/scripts/images/GMT_Defaults_1a.ps
deleted doc/scripts/images/GMT_Defaults_1b.ps
deleted doc/scripts/images/GMT_Defaults_1c.ps
deleted doc/scripts/images/GMT_RGBchart.ps
deleted doc/scripts/images/GMT_SRTM.ps
deleted doc/scripts/images/GMT_TM.ps
deleted doc/scripts/images/GMT_albers.ps
deleted doc/scripts/images/GMT_anchor.ps
deleted doc/scripts/images/GMT_angle-azim.ps
deleted doc/scripts/images/GMT_arrows.ps
deleted doc/scripts/images/GMT_arrows_types.ps
deleted doc/scripts/images/GMT_atan.ps
deleted doc/scripts/images/GMT_autolegend.ps
deleted doc/scripts/images/GMT_az_equidistant.ps
deleted doc/scripts/images/GMT_base_symbols1.ps
deleted doc/scripts/images/GMT_base_symbols2.ps
deleted doc/scripts/images/GMT_base_symbols3.ps
deleted doc/scripts/images/GMT_base_symbols3D.ps
deleted doc/scripts/images/GMT_base_symbols4.ps
deleted doc/scripts/images/GMT_base_symbols5.ps
deleted doc/scripts/images/GMT_base_symbols6.ps
deleted doc/scripts/images/GMT_base_symbols7.ps
deleted doc/scripts/images/GMT_base_symbols8.ps
deleted doc/scripts/images/GMT_base_symbols9.ps
deleted doc/scripts/images/GMT_bezier.ps
deleted doc/scripts/images/GMT_blend.ps
deleted doc/scripts/images/GMT_blendtype.ps
deleted doc/scripts/images/GMT_cap.ps
deleted doc/scripts/images/GMT_cassini.ps
deleted doc/scripts/images/GMT_chunking.ps
deleted doc/scripts/images/GMT_cmyk.ps
deleted doc/scripts/images/GMT_color_hsv.ps
deleted doc/scripts/images/GMT_color_interpolate.ps
deleted doc/scripts/images/GMT_colorbar.ps
deleted doc/scripts/images/GMT_colorlist.ps
deleted doc/scripts/images/GMT_coverlogo.ps
deleted doc/scripts/images/GMT_cycle_1.ps
deleted doc/scripts/images/GMT_cycle_2.ps
deleted doc/scripts/images/GMT_cycle_3.ps
deleted doc/scripts/images/GMT_cycle_4.ps
deleted doc/scripts/images/GMT_cycle_5.ps
deleted doc/scripts/images/GMT_cycle_6.ps
deleted doc/scripts/images/GMT_cyclic.ps
deleted doc/scripts/images/GMT_dir_rose.ps
deleted doc/scripts/images/GMT_eckert4.ps
deleted doc/scripts/images/GMT_eckert6.ps
deleted doc/scripts/images/GMT_equi_cyl.ps
deleted doc/scripts/images/GMT_equidistant_conic.ps
deleted doc/scripts/images/GMT_fatline.ps
deleted doc/scripts/images/GMT_fill_curves.ps
deleted doc/scripts/images/GMT_gall_stereo.ps
deleted doc/scripts/images/GMT_general_cyl.ps
deleted doc/scripts/images/GMT_gnomonic.ps
deleted doc/scripts/images/GMT_grid2pix.ps
deleted doc/scripts/images/GMT_grinten.ps
deleted doc/scripts/images/GMT_hammer.ps
deleted doc/scripts/images/GMT_hexbinning.ps
deleted doc/scripts/images/GMT_hinge.ps
deleted doc/scripts/images/GMT_images.ps
deleted doc/scripts/images/GMT_inset.ps
deleted doc/scripts/images/GMT_joint.ps
deleted doc/scripts/images/GMT_lambert_az_hemi.ps
deleted doc/scripts/images/GMT_lambert_az_rect.ps
deleted doc/scripts/images/GMT_lambert_conic.ps
deleted doc/scripts/images/GMT_latex.ps
deleted doc/scripts/images/GMT_legend.ps
deleted doc/scripts/images/GMT_linear.ps
deleted doc/scripts/images/GMT_linear_cal.ps
deleted doc/scripts/images/GMT_linear_d.ps
deleted doc/scripts/images/GMT_linearrow.ps
deleted doc/scripts/images/GMT_linecap.ps
deleted doc/scripts/images/GMT_lineoffset.ps
deleted doc/scripts/images/GMT_log.ps
deleted doc/scripts/images/GMT_mag_rose.ps
deleted doc/scripts/images/GMT_map_frame_type.ps
deleted doc/scripts/images/GMT_mapscale.ps
deleted doc/scripts/images/GMT_mercator.ps
deleted doc/scripts/images/GMT_miller.ps
deleted doc/scripts/images/GMT_misfit.ps
deleted doc/scripts/images/GMT_mollweide.ps
deleted doc/scripts/images/GMT_movie_canvas.ps
deleted doc/scripts/images/GMT_movie_progress.ps
deleted doc/scripts/images/GMT_nearneighbor.ps
deleted doc/scripts/images/GMT_obl_baja.ps
deleted doc/scripts/images/GMT_obl_merc.ps
deleted doc/scripts/images/GMT_obl_nz.ps
deleted doc/scripts/images/GMT_obl_regions.ps
deleted doc/scripts/images/GMT_orthographic.ps
deleted doc/scripts/images/GMT_panel.ps
deleted doc/scripts/images/GMT_perspective.ps
deleted doc/scripts/images/GMT_polar.ps
deleted doc/scripts/images/GMT_polyconic.ps
deleted doc/scripts/images/GMT_pow.ps
deleted doc/scripts/images/GMT_pstext_clearance.ps
deleted doc/scripts/images/GMT_pstext_justify.ps
deleted doc/scripts/images/GMT_registration.ps
deleted doc/scripts/images/GMT_robinson.ps
deleted doc/scripts/images/GMT_seamount_azim.ps
deleted doc/scripts/images/GMT_seamount_cum_inc.ps
deleted doc/scripts/images/GMT_seamount_density.ps
deleted doc/scripts/images/GMT_seamount_flux.ps
deleted doc/scripts/images/GMT_seamount_map.ps
deleted doc/scripts/images/GMT_seamount_prisms.ps
deleted doc/scripts/images/GMT_seamount_psi.ps
deleted doc/scripts/images/GMT_seamount_slide.ps
deleted doc/scripts/images/GMT_seamount_specs.ps
deleted doc/scripts/images/GMT_seamount_types.ps
deleted doc/scripts/images/GMT_seamount_u0.ps
deleted doc/scripts/images/GMT_segmentize.ps
deleted doc/scripts/images/GMT_seislegend.ps
deleted doc/scripts/images/GMT_sinus_int.ps
deleted doc/scripts/images/GMT_sinusoidal.ps
deleted doc/scripts/images/GMT_slope2intensity.ps
deleted doc/scripts/images/GMT_slopes.ps
deleted doc/scripts/images/GMT_splines.ps
deleted doc/scripts/images/GMT_stereographic_general.ps
deleted doc/scripts/images/GMT_stereographic_polar.ps
deleted doc/scripts/images/GMT_stereographic_rect.ps
deleted doc/scripts/images/GMT_stereonets.ps
deleted doc/scripts/images/GMT_title_fade.ps
deleted doc/scripts/images/GMT_transverse_merc.ps
deleted doc/scripts/images/GMT_tut_1.ps
deleted doc/scripts/images/GMT_tut_10.ps
deleted doc/scripts/images/GMT_tut_11.ps
deleted doc/scripts/images/GMT_tut_12.ps
deleted doc/scripts/images/GMT_tut_13.ps
deleted doc/scripts/images/GMT_tut_14.ps
deleted doc/scripts/images/GMT_tut_15.ps
deleted doc/scripts/images/GMT_tut_16.ps
deleted doc/scripts/images/GMT_tut_17.ps
deleted doc/scripts/images/GMT_tut_18.ps
deleted doc/scripts/images/GMT_tut_19.ps
deleted doc/scripts/images/GMT_tut_2.ps
deleted doc/scripts/images/GMT_tut_3.ps
deleted doc/scripts/images/GMT_tut_4.ps
deleted doc/scripts/images/GMT_tut_5.ps
deleted doc/scripts/images/GMT_tut_6.ps
deleted doc/scripts/images/GMT_tut_7.ps
deleted doc/scripts/images/GMT_tut_8.ps
deleted doc/scripts/images/GMT_tut_9.ps
deleted doc/scripts/images/GMT_utm_zones.ps
deleted doc/scripts/images/GMT_vector.ps
deleted doc/scripts/images/GMT_vector4.ps
deleted doc/scripts/images/GMT_velo.ps
deleted doc/scripts/images/GMT_vertscale.ps
deleted doc/scripts/images/GMT_volcano.ps
deleted doc/scripts/images/GMT_winkel.ps
deleted doc/scripts/images/grdflexure_approx.ps
deleted doc/scripts/images/project_setup.ps
deleted doc/scripts/images/psevents_action.ps
deleted doc/scripts/images/psevents_dz.ps
deleted doc/scripts/images/psevents_intensity.ps
deleted doc/scripts/images/psevents_labels.ps
deleted doc/scripts/images/psevents_size.ps
deleted doc/scripts/images/psevents_transparency.ps
modified doc/scripts/images/

Image diff(s)

Added images

Modified images

Path Old New

Report last updated at commit 3ae0935

@Esteban82
Copy link
Member

Why does the bot report so many deleted files? Is that ok?

@PaulWessel
Copy link
Member Author

PaulWessel commented Oct 23, 2023

No not good, not sure what I did, pinging @seisman for assistance

@seisman
Copy link
Member

seisman commented Oct 24, 2023

Not sure what happened, maybe because @PaulWessel was working on several PRs that change DVC files at the same time.

Now this PR has conflicts, which must be resolved first.

@PaulWessel
Copy link
Member Author

Conflicts fixed.

- md5: e0c1334651a2b06141769144677fdff5.dir
size: 33377667
nfiles: 204
- md5: 453d9a7563e7c2ec20cc0ed14716053c.dir
Copy link
Member

@seisman seisman Oct 25, 2023

Choose a reason for hiding this comment

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

The changes doesn't make sense to me. I expect to see nfiles in doc/scripts/images.dvc increase by 1, and nfiles in test/baseline/psxy.dvc decrease by 1.

Copy link
Member

Choose a reason for hiding this comment

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

At the top, Paul said that he removed one test.

@PaulWessel
Copy link
Member Author

Hi @maxrjones, any idea what is going on here? A few things I dont understand:

The PS files are not in our GitHub anymore, just DVC. If I have a PR like this one that adds one new doc script and corresponding image but also removes a script, I have deleted that postscript file from test/baseline/module and used dvc add to update the .git file. Should I not/never delete files added to DVC?

@PaulWessel
Copy link
Member Author

Ok, I did dvc add docs/scripts/images again and got a new .git file with 204 files. Seems fine?

@seisman
Copy link
Member

seisman commented Oct 28, 2023

Ok, I did dvc add docs/scripts/images again and got a new .git file with 204 files. Seems fine?

Currently, I can't see any changes in the docs/scripts/images.dvc file.

@seisman seisman merged commit c6e3cbe into master Nov 3, 2023
6 checks passed
@seisman seisman deleted the segmentize-fig branch November 3, 2023 16:57
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improve documentation
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

3 participants