diff --git a/.github/workflows/dvc-diff.yml b/.github/workflows/dvc-diff.yml index cf003faf117..ccaeb631d4e 100644 --- a/.github/workflows/dvc-diff.yml +++ b/.github/workflows/dvc-diff.yml @@ -33,7 +33,7 @@ jobs: uses: iterative/setup-cml@v2.0.1 - name: Setup Micromamba - uses: mamba-org/setup-micromamba@v1.5.0 + uses: mamba-org/setup-micromamba@v1.6.0 with: environment-name: gmt condarc: | @@ -45,12 +45,6 @@ jobs: create-args: >- gmt - # workaround from https://github.com/iterative/cml/issues/1377 - - name: Setup NodeJS - uses: actions/setup-node@v3.8.1 - with: - node-version: '16' - # Produce the markdown diff report, which should look like: # ## Summary of changed images # diff --git a/ci/install-dependencies-linux.sh b/ci/install-dependencies-linux.sh index 28ff3b4984c..313ecf18b89 100755 --- a/ci/install-dependencies-linux.sh +++ b/ci/install-dependencies-linux.sh @@ -45,6 +45,9 @@ conda update -n base -c conda-forge conda --solver libmamba conda install ${conda_packages} -c conda-forge --solver libmamba echo "${CONDA}/bin" >> $GITHUB_PATH +# Remove pcre-config from conda's path so cmake won't find the conda's one +rm -f ${CONDA}/bin/pcre-config ${CONDA}/bin/pcre2-config + # Install Sphinx extensions if [ "$BUILD_DOCS" = "true" ]; then ${CONDA}/bin/python -m pip install --user -r doc/rst/requirements.txt diff --git a/ci/install-dependencies-macos.sh b/ci/install-dependencies-macos.sh index 8793d80b6bf..a6c0edaf01b 100755 --- a/ci/install-dependencies-macos.sh +++ b/ci/install-dependencies-macos.sh @@ -45,6 +45,9 @@ conda update -n base -c conda-forge conda --solver libmamba conda install ${conda_packages} -c conda-forge --solver libmamba echo "${CONDA}/bin" >> $GITHUB_PATH +# Remove pcre-config from conda's path so cmake won't find the conda's one +rm -f ${CONDA}/bin/pcre-config ${CONDA}/bin/pcre2-config + # Install Sphinx extensions if [ "$BUILD_DOCS" = "true" ]; then ${CONDA}/bin/python -m pip install --user -r doc/rst/requirements.txt diff --git a/ci/install-dependencies-windows.sh b/ci/install-dependencies-windows.sh index 2773c411170..e6d8e7c4449 100755 --- a/ci/install-dependencies-windows.sh +++ b/ci/install-dependencies-windows.sh @@ -53,6 +53,10 @@ $CONDA\\condabin\\conda.bat install ${conda_packages} -c conda-forge --solver li echo "$CONDA\\Library\\bin" >> $GITHUB_PATH echo "$CONDA\\Scripts" >> $GITHUB_PATH +# Add the vcpkg path again so it's prepended before conda's path and cmake can find +# the vcpkg library correctly +echo "${VCPKG_INSTALLATION_ROOT}/installed/${WIN_PLATFORM}/bin" >> $GITHUB_PATH + # Install Sphinx extensions if [ "$BUILD_DOCS" = "true" ]; then ${CONDA}/python -m pip install --user -r doc/rst/requirements.txt diff --git a/doc/examples/.gitignore b/doc/examples/.gitignore deleted file mode 100644 index 187d3623f5f..00000000000 --- a/doc/examples/.gitignore +++ /dev/null @@ -1 +0,0 @@ -/images diff --git a/doc/examples/images.dvc b/doc/examples/images.dvc deleted file mode 100644 index e54984a55df..00000000000 --- a/doc/examples/images.dvc +++ /dev/null @@ -1,6 +0,0 @@ -outs: -- md5: 4dd0ad31844cb0b0b451648cda314e2a.dir - size: 37295153 - nfiles: 53 - path: images - hash: md5 diff --git a/doc/examples/images/.gitignore b/doc/examples/images/.gitignore new file mode 100644 index 00000000000..11eb07cef48 --- /dev/null +++ b/doc/examples/images/.gitignore @@ -0,0 +1 @@ +*.ps diff --git a/doc/examples/images/ex01.ps.dvc b/doc/examples/images/ex01.ps.dvc new file mode 100644 index 00000000000..2cd54d81f80 --- /dev/null +++ b/doc/examples/images/ex01.ps.dvc @@ -0,0 +1,5 @@ +outs: +- md5: 08a2e5d2a7f9135d82ea0ae2ac99579f + size: 338598 + hash: md5 + path: ex01.ps diff --git a/doc/examples/images/ex02.ps.dvc b/doc/examples/images/ex02.ps.dvc new file mode 100644 index 00000000000..d1b295a91ae --- /dev/null +++ b/doc/examples/images/ex02.ps.dvc @@ -0,0 +1,5 @@ +outs: +- md5: fad03a8dc558ecac634a8b88ea619250 + size: 865873 + hash: md5 + path: ex02.ps diff --git a/doc/examples/images/ex03.ps.dvc b/doc/examples/images/ex03.ps.dvc new file mode 100644 index 00000000000..5ef5cf3f8f3 --- /dev/null +++ b/doc/examples/images/ex03.ps.dvc @@ -0,0 +1,5 @@ +outs: +- md5: d4827f7c0c43ea34f94e539f1bfa7e55 + size: 72664 + hash: md5 + path: ex03.ps diff --git a/doc/examples/images/ex04.ps.dvc b/doc/examples/images/ex04.ps.dvc new file mode 100644 index 00000000000..15869c9a062 --- /dev/null +++ b/doc/examples/images/ex04.ps.dvc @@ -0,0 +1,5 @@ +outs: +- md5: 307901e55d819418d70a3e7713046887 + size: 607318 + hash: md5 + path: ex04.ps diff --git a/doc/examples/images/ex04c.ps.dvc b/doc/examples/images/ex04c.ps.dvc new file mode 100644 index 00000000000..b3a2313ca09 --- /dev/null +++ b/doc/examples/images/ex04c.ps.dvc @@ -0,0 +1,5 @@ +outs: +- md5: 061c172ba4aedbde304ac4bfd6d7f75b + size: 378179 + hash: md5 + path: ex04c.ps diff --git a/doc/examples/images/ex05.ps.dvc b/doc/examples/images/ex05.ps.dvc new file mode 100644 index 00000000000..4e850b252c1 --- /dev/null +++ b/doc/examples/images/ex05.ps.dvc @@ -0,0 +1,5 @@ +outs: +- md5: 71d5d70676cdc2622b8ef89f5e00ac73 + size: 506539 + hash: md5 + path: ex05.ps diff --git a/doc/examples/images/ex06.ps.dvc b/doc/examples/images/ex06.ps.dvc new file mode 100644 index 00000000000..c966f50988c --- /dev/null +++ b/doc/examples/images/ex06.ps.dvc @@ -0,0 +1,5 @@ +outs: +- md5: 9813f7fb167eaec7b963aa3d8d65531a + size: 28408 + hash: md5 + path: ex06.ps diff --git a/doc/examples/images/ex07.ps.dvc b/doc/examples/images/ex07.ps.dvc new file mode 100644 index 00000000000..08ea7e556f2 --- /dev/null +++ b/doc/examples/images/ex07.ps.dvc @@ -0,0 +1,5 @@ +outs: +- md5: f917bf82f4c4722fd7837f27275b279b + size: 102822 + hash: md5 + path: ex07.ps diff --git a/doc/examples/images/ex08.ps.dvc b/doc/examples/images/ex08.ps.dvc new file mode 100644 index 00000000000..927dc0e986b --- /dev/null +++ b/doc/examples/images/ex08.ps.dvc @@ -0,0 +1,5 @@ +outs: +- md5: de41373d6dc789baff5e0f5f4da474a0 + size: 2212834 + hash: md5 + path: ex08.ps diff --git a/doc/examples/images/ex09.ps.dvc b/doc/examples/images/ex09.ps.dvc new file mode 100644 index 00000000000..c462d16a74c --- /dev/null +++ b/doc/examples/images/ex09.ps.dvc @@ -0,0 +1,5 @@ +outs: +- md5: 03d6040145b93e3c9e34433d271f8046 + size: 342948 + hash: md5 + path: ex09.ps diff --git a/doc/examples/images/ex10.ps.dvc b/doc/examples/images/ex10.ps.dvc new file mode 100644 index 00000000000..dc3855e2abb --- /dev/null +++ b/doc/examples/images/ex10.ps.dvc @@ -0,0 +1,5 @@ +outs: +- md5: 5014ce09d6fe8406258e9e81e372cdbd + size: 148160 + hash: md5 + path: ex10.ps diff --git a/doc/examples/images/ex11.ps.dvc b/doc/examples/images/ex11.ps.dvc new file mode 100644 index 00000000000..90febc57da5 --- /dev/null +++ b/doc/examples/images/ex11.ps.dvc @@ -0,0 +1,5 @@ +outs: +- md5: 75d5637e2d95ff525494625885256606 + size: 1091529 + hash: md5 + path: ex11.ps diff --git a/doc/examples/images/ex12.ps.dvc b/doc/examples/images/ex12.ps.dvc new file mode 100644 index 00000000000..f7fab3adf75 --- /dev/null +++ b/doc/examples/images/ex12.ps.dvc @@ -0,0 +1,5 @@ +outs: +- md5: c9049724b426016caa290c2168d12664 + size: 78589 + hash: md5 + path: ex12.ps diff --git a/doc/examples/images/ex13.ps.dvc b/doc/examples/images/ex13.ps.dvc new file mode 100644 index 00000000000..30e58367e67 --- /dev/null +++ b/doc/examples/images/ex13.ps.dvc @@ -0,0 +1,5 @@ +outs: +- md5: b9149b00b7560bc27f06a066df99b7f7 + size: 148482 + hash: md5 + path: ex13.ps diff --git a/doc/examples/images/ex14.ps.dvc b/doc/examples/images/ex14.ps.dvc new file mode 100644 index 00000000000..8d64169132a --- /dev/null +++ b/doc/examples/images/ex14.ps.dvc @@ -0,0 +1,5 @@ +outs: +- md5: 19f87e08bdfcc8ba1dc5c72a4f3a262a + size: 61390 + hash: md5 + path: ex14.ps diff --git a/doc/examples/images/ex15.ps.dvc b/doc/examples/images/ex15.ps.dvc new file mode 100644 index 00000000000..59280d834d2 --- /dev/null +++ b/doc/examples/images/ex15.ps.dvc @@ -0,0 +1,5 @@ +outs: +- md5: 045a9fee7b18fa6b152dd200992ee32a + size: 2513023 + hash: md5 + path: ex15.ps diff --git a/doc/examples/images/ex16.ps.dvc b/doc/examples/images/ex16.ps.dvc new file mode 100644 index 00000000000..304592b63a5 --- /dev/null +++ b/doc/examples/images/ex16.ps.dvc @@ -0,0 +1,5 @@ +outs: +- md5: df907fae27fdda1b58056863af3d7eaa + size: 386416 + hash: md5 + path: ex16.ps diff --git a/doc/examples/images/ex17.ps.dvc b/doc/examples/images/ex17.ps.dvc new file mode 100644 index 00000000000..da40ba7e5e9 --- /dev/null +++ b/doc/examples/images/ex17.ps.dvc @@ -0,0 +1,5 @@ +outs: +- md5: c2b9b205e09bd547886c920280bb8522 + size: 528693 + hash: md5 + path: ex17.ps diff --git a/doc/examples/images/ex18.ps.dvc b/doc/examples/images/ex18.ps.dvc new file mode 100644 index 00000000000..1d96eded0b2 --- /dev/null +++ b/doc/examples/images/ex18.ps.dvc @@ -0,0 +1,5 @@ +outs: +- md5: afdba9c8d13ec9bee12088502d1f2075 + size: 363801 + hash: md5 + path: ex18.ps diff --git a/doc/examples/images/ex19.ps.dvc b/doc/examples/images/ex19.ps.dvc new file mode 100644 index 00000000000..9cc54e0178f --- /dev/null +++ b/doc/examples/images/ex19.ps.dvc @@ -0,0 +1,5 @@ +outs: +- md5: 299cbc1cc17c17cc1a3dda1bbdb249bb + size: 411124 + hash: md5 + path: ex19.ps diff --git a/doc/examples/images/ex20.ps.dvc b/doc/examples/images/ex20.ps.dvc new file mode 100644 index 00000000000..48f81e74697 --- /dev/null +++ b/doc/examples/images/ex20.ps.dvc @@ -0,0 +1,5 @@ +outs: +- md5: 940a4342cf14931bf83dbd1e49fa806b + size: 128669 + hash: md5 + path: ex20.ps diff --git a/doc/examples/images/ex21.ps.dvc b/doc/examples/images/ex21.ps.dvc new file mode 100644 index 00000000000..94ae05b2564 --- /dev/null +++ b/doc/examples/images/ex21.ps.dvc @@ -0,0 +1,5 @@ +outs: +- md5: 988740319be5b76a3dee2f1ec6bd9943 + size: 102970 + hash: md5 + path: ex21.ps diff --git a/doc/examples/images/ex22.ps.dvc b/doc/examples/images/ex22.ps.dvc new file mode 100644 index 00000000000..dc2e7c25e2b --- /dev/null +++ b/doc/examples/images/ex22.ps.dvc @@ -0,0 +1,5 @@ +outs: +- md5: 89e71bd726ef040cd85eccbc6b0f0a4f + size: 182130 + hash: md5 + path: ex22.ps diff --git a/doc/examples/images/ex23.ps.dvc b/doc/examples/images/ex23.ps.dvc new file mode 100644 index 00000000000..1b902fc898a --- /dev/null +++ b/doc/examples/images/ex23.ps.dvc @@ -0,0 +1,5 @@ +outs: +- md5: 1b5e262f48b85921fe378dd9207bd8a0 + size: 1997227 + hash: md5 + path: ex23.ps diff --git a/doc/examples/images/ex24.ps.dvc b/doc/examples/images/ex24.ps.dvc new file mode 100644 index 00000000000..fa56dde51a2 --- /dev/null +++ b/doc/examples/images/ex24.ps.dvc @@ -0,0 +1,5 @@ +outs: +- md5: 74b01d6d1c0735575af2a0155ebc527e + size: 300863 + hash: md5 + path: ex24.ps diff --git a/doc/examples/images/ex25.ps.dvc b/doc/examples/images/ex25.ps.dvc new file mode 100644 index 00000000000..541fd6bbc87 --- /dev/null +++ b/doc/examples/images/ex25.ps.dvc @@ -0,0 +1,5 @@ +outs: +- md5: b91608ab5959d860608a20399c50fac2 + size: 118293 + hash: md5 + path: ex25.ps diff --git a/doc/examples/images/ex26.ps.dvc b/doc/examples/images/ex26.ps.dvc new file mode 100644 index 00000000000..06cf6aa58b8 --- /dev/null +++ b/doc/examples/images/ex26.ps.dvc @@ -0,0 +1,5 @@ +outs: +- md5: e5f75b9d8c715fd7c1b0f8a263a356f9 + size: 195305 + hash: md5 + path: ex26.ps diff --git a/doc/examples/images/ex27.ps.dvc b/doc/examples/images/ex27.ps.dvc new file mode 100644 index 00000000000..6eeb6627490 --- /dev/null +++ b/doc/examples/images/ex27.ps.dvc @@ -0,0 +1,5 @@ +outs: +- md5: 711b91c1e9ce135c4cefe5c0423dd0d3 + size: 2404580 + hash: md5 + path: ex27.ps diff --git a/doc/examples/images/ex28.ps.dvc b/doc/examples/images/ex28.ps.dvc new file mode 100644 index 00000000000..666815b71a1 --- /dev/null +++ b/doc/examples/images/ex28.ps.dvc @@ -0,0 +1,5 @@ +outs: +- md5: a2480da6a0860464edc57b41f197f658 + size: 1039001 + hash: md5 + path: ex28.ps diff --git a/doc/examples/images/ex29.ps.dvc b/doc/examples/images/ex29.ps.dvc new file mode 100644 index 00000000000..bbc26ac5a4d --- /dev/null +++ b/doc/examples/images/ex29.ps.dvc @@ -0,0 +1,5 @@ +outs: +- md5: b22feed290df699ce63fca7417a646cb + size: 286387 + hash: md5 + path: ex29.ps diff --git a/doc/examples/images/ex30.ps.dvc b/doc/examples/images/ex30.ps.dvc new file mode 100644 index 00000000000..6fb0a5a998e --- /dev/null +++ b/doc/examples/images/ex30.ps.dvc @@ -0,0 +1,5 @@ +outs: +- md5: bb594fe661dd7940bf78e1a8af6f8868 + size: 33782 + hash: md5 + path: ex30.ps diff --git a/doc/examples/images/ex31.ps.dvc b/doc/examples/images/ex31.ps.dvc new file mode 100644 index 00000000000..8097b5dd071 --- /dev/null +++ b/doc/examples/images/ex31.ps.dvc @@ -0,0 +1,5 @@ +outs: +- md5: 0ac74fd663eb32296334ca7d22aa325f + size: 554276 + hash: md5 + path: ex31.ps diff --git a/doc/examples/images/ex32.ps.dvc b/doc/examples/images/ex32.ps.dvc new file mode 100644 index 00000000000..348911842a6 --- /dev/null +++ b/doc/examples/images/ex32.ps.dvc @@ -0,0 +1,5 @@ +outs: +- md5: 925184952e603054c6b768c1f62cae4d + size: 1464471 + hash: md5 + path: ex32.ps diff --git a/doc/examples/images/ex33.ps.dvc b/doc/examples/images/ex33.ps.dvc new file mode 100644 index 00000000000..9eee8140ca2 --- /dev/null +++ b/doc/examples/images/ex33.ps.dvc @@ -0,0 +1,5 @@ +outs: +- md5: f393ea9a81e4cfbf9c09878aec0118f9 + size: 904035 + hash: md5 + path: ex33.ps diff --git a/doc/examples/images/ex34.ps.dvc b/doc/examples/images/ex34.ps.dvc new file mode 100644 index 00000000000..1a640345e29 --- /dev/null +++ b/doc/examples/images/ex34.ps.dvc @@ -0,0 +1,5 @@ +outs: +- md5: 892d54dcebe045ef673f87b677cdbc60 + size: 1492129 + hash: md5 + path: ex34.ps diff --git a/doc/examples/images/ex35.ps.dvc b/doc/examples/images/ex35.ps.dvc new file mode 100644 index 00000000000..29f97412906 --- /dev/null +++ b/doc/examples/images/ex35.ps.dvc @@ -0,0 +1,5 @@ +outs: +- md5: 65b92e89e91c0f35b51a194b2885e36a + size: 823296 + hash: md5 + path: ex35.ps diff --git a/doc/examples/images/ex36.ps.dvc b/doc/examples/images/ex36.ps.dvc new file mode 100644 index 00000000000..a543e4bfcd9 --- /dev/null +++ b/doc/examples/images/ex36.ps.dvc @@ -0,0 +1,5 @@ +outs: +- md5: 7b477ec60633cf07619ac381b32b474c + size: 225250 + hash: md5 + path: ex36.ps diff --git a/doc/examples/images/ex37.ps.dvc b/doc/examples/images/ex37.ps.dvc new file mode 100644 index 00000000000..a5a004f150d --- /dev/null +++ b/doc/examples/images/ex37.ps.dvc @@ -0,0 +1,5 @@ +outs: +- md5: c7f860156d3347f9971d78ecbf46f0d6 + size: 436205 + hash: md5 + path: ex37.ps diff --git a/doc/examples/images/ex38.ps.dvc b/doc/examples/images/ex38.ps.dvc new file mode 100644 index 00000000000..416d24c7f66 --- /dev/null +++ b/doc/examples/images/ex38.ps.dvc @@ -0,0 +1,5 @@ +outs: +- md5: 9f8af211369a5ef5b94a6063e43b4e24 + size: 906119 + hash: md5 + path: ex38.ps diff --git a/doc/examples/images/ex39.ps.dvc b/doc/examples/images/ex39.ps.dvc new file mode 100644 index 00000000000..1d7af35aa1f --- /dev/null +++ b/doc/examples/images/ex39.ps.dvc @@ -0,0 +1,5 @@ +outs: +- md5: 6b97297b4c899fa516329bfb3e5237b9 + size: 545331 + hash: md5 + path: ex39.ps diff --git a/doc/examples/images/ex40.ps.dvc b/doc/examples/images/ex40.ps.dvc new file mode 100644 index 00000000000..3fc002df4ab --- /dev/null +++ b/doc/examples/images/ex40.ps.dvc @@ -0,0 +1,5 @@ +outs: +- md5: 2593c103ab54880a8cb2f9684f86481f + size: 1086037 + hash: md5 + path: ex40.ps diff --git a/doc/examples/images/ex41.ps.dvc b/doc/examples/images/ex41.ps.dvc new file mode 100644 index 00000000000..3a084a84317 --- /dev/null +++ b/doc/examples/images/ex41.ps.dvc @@ -0,0 +1,5 @@ +outs: +- md5: 57dae2c4622e72b2b4b3c64088cfa7d5 + size: 1774717 + hash: md5 + path: ex41.ps diff --git a/doc/examples/images/ex42.ps.dvc b/doc/examples/images/ex42.ps.dvc new file mode 100644 index 00000000000..2cb67572f38 --- /dev/null +++ b/doc/examples/images/ex42.ps.dvc @@ -0,0 +1,5 @@ +outs: +- md5: 21c7284833af7f7e2524f831fbc8a807 + size: 2596990 + hash: md5 + path: ex42.ps diff --git a/doc/examples/images/ex43.ps.dvc b/doc/examples/images/ex43.ps.dvc new file mode 100644 index 00000000000..d4215726151 --- /dev/null +++ b/doc/examples/images/ex43.ps.dvc @@ -0,0 +1,5 @@ +outs: +- md5: 3a12689ef3eb2bc30c042fb89c686204 + size: 45539 + hash: md5 + path: ex43.ps diff --git a/doc/examples/images/ex44.ps.dvc b/doc/examples/images/ex44.ps.dvc new file mode 100644 index 00000000000..d6f7f5124c1 --- /dev/null +++ b/doc/examples/images/ex44.ps.dvc @@ -0,0 +1,5 @@ +outs: +- md5: a2628204dba0dff6b66d34a0eb356915 + size: 1429237 + hash: md5 + path: ex44.ps diff --git a/doc/examples/images/ex45.ps.dvc b/doc/examples/images/ex45.ps.dvc new file mode 100644 index 00000000000..422cd8735df --- /dev/null +++ b/doc/examples/images/ex45.ps.dvc @@ -0,0 +1,5 @@ +outs: +- md5: e8af47e5460dd98121129eee9015bc0c + size: 90000 + hash: md5 + path: ex45.ps diff --git a/doc/examples/images/ex46.ps.dvc b/doc/examples/images/ex46.ps.dvc new file mode 100644 index 00000000000..2b0b3d81b99 --- /dev/null +++ b/doc/examples/images/ex46.ps.dvc @@ -0,0 +1,5 @@ +outs: +- md5: 63099f450d94aa5bf6824c2f58cf6dfa + size: 251831 + hash: md5 + path: ex46.ps diff --git a/doc/examples/images/ex47.ps.dvc b/doc/examples/images/ex47.ps.dvc new file mode 100644 index 00000000000..006d6121a5d --- /dev/null +++ b/doc/examples/images/ex47.ps.dvc @@ -0,0 +1,5 @@ +outs: +- md5: 705ff7cf7226e84b785fd46159eeca0c + size: 90762 + hash: md5 + path: ex47.ps diff --git a/doc/examples/images/ex48.ps.dvc b/doc/examples/images/ex48.ps.dvc new file mode 100644 index 00000000000..afbee0b4bb7 --- /dev/null +++ b/doc/examples/images/ex48.ps.dvc @@ -0,0 +1,5 @@ +outs: +- md5: ec9b6b44473b759e899ef054e5e78116 + size: 2083270 + hash: md5 + path: ex48.ps diff --git a/doc/examples/images/ex49.ps.dvc b/doc/examples/images/ex49.ps.dvc new file mode 100644 index 00000000000..9a43164fdfa --- /dev/null +++ b/doc/examples/images/ex49.ps.dvc @@ -0,0 +1,5 @@ +outs: +- md5: daf004484cbd15bcf609fe7584cf4656 + size: 1258444 + hash: md5 + path: ex49.ps diff --git a/doc/examples/images/ex50.ps.dvc b/doc/examples/images/ex50.ps.dvc new file mode 100644 index 00000000000..a1398138435 --- /dev/null +++ b/doc/examples/images/ex50.ps.dvc @@ -0,0 +1,5 @@ +outs: +- md5: 2f77ec166630cb099be9ef954785b840 + size: 71636 + hash: md5 + path: ex50.ps diff --git a/doc/examples/images/ex51.ps.dvc b/doc/examples/images/ex51.ps.dvc new file mode 100644 index 00000000000..3147a299519 --- /dev/null +++ b/doc/examples/images/ex51.ps.dvc @@ -0,0 +1,5 @@ +outs: +- md5: cb768260acd029b2645ac26988aab131 + size: 41241 + hash: md5 + path: ex51.ps diff --git a/doc/examples/images/ex52.ps.dvc b/doc/examples/images/ex52.ps.dvc new file mode 100644 index 00000000000..989b30d860b --- /dev/null +++ b/doc/examples/images/ex52.ps.dvc @@ -0,0 +1,5 @@ +outs: +- md5: 2e9f58baf5ba59bfe9b8142ec34ce076 + size: 1147740 + hash: md5 + path: ex52.ps diff --git a/doc/rst/requirements.txt b/doc/rst/requirements.txt index 359eb9fbf5f..151527c9a29 100644 --- a/doc/rst/requirements.txt +++ b/doc/rst/requirements.txt @@ -6,7 +6,7 @@ # sphinx_rtd_theme==1.3.0 sphinx-copybutton==0.5.2 -sphinx_design==0.5.0 +sphinx-design==0.5.0 sphinx-jinja==2.0.2 sphinx-togglebutton==0.3.2 sphinxcontrib-youtube==1.4.1 diff --git a/doc/rst/source/batch.rst b/doc/rst/source/batch.rst index 8617351d765..f379b5b7254 100644 --- a/doc/rst/source/batch.rst +++ b/doc/rst/source/batch.rst @@ -49,7 +49,7 @@ Required Arguments *mainscript* Name of a stand-alone GMT modern mode processing script that makes the parameter-dependent calculations. The script may access job variables, such as job number and others defined below, and may be - written using the Bourne shell (.sh), the Bourne again shell (.bash), the csh (.csh) + written using the Bourne shell (.sh), the Bourne again shell (.bash), the C shell (.csh) or DOS batch language (.bat). The script language is inferred from the file extension and we build hidden batch scripts using the same language. Parameters that can be accessed are discussed below. @@ -301,15 +301,15 @@ are all completed we determine the standard deviation in the result. To replica gmt grdcut -R-10/20/-10/20 @earth_relief_02m -Gdata.grd gmt end EOF - cat << EOF > main.sh + cat << 'EOF' > main.sh gmt begin - gmt grdfilter data.grd -Fg\${BATCH_COL0}+h -G\${BATCH_NAME}.grd -D2 + gmt grdfilter data.grd -Fg${BATCH_COL0}+h -G${BATCH_NAME}.grd -D2 gmt end EOF - cat << EOF > post.sh - gmt begin \${BATCH_PREFIX} pdf - gmt grdmath \${BATCH_PREFIX}_*.grd -S STD = \${BATCH_PREFIX}_std.grd - gmt grdimage \${BATCH_PREFIX}_std.grd -B -B+t"STD of Gaussians residuals" -Chot + cat << 'EOF' > post.sh + gmt begin ${BATCH_PREFIX} pdf + gmt grdmath ${BATCH_PREFIX}_*.grd -S STD = ${BATCH_PREFIX}_std.grd + gmt grdimage ${BATCH_PREFIX}_std.grd -B -B+t"STD of Gaussians residuals" -Chot gmt coast -Wthin,white gmt end show EOF @@ -317,7 +317,8 @@ are all completed we determine the standard deviation in the result. To replica Of course, the syntax of how variables are used vary according to the scripting language. Here, we actually build the pre.sh, main.sh, and post.sh scripts on the fly, hence we need to escape any variables (since they -start with a dollar sign that we need to be written verbatim). At the end of the execution we find 20 grids +start with a dollar sign that we need to be written verbatim). By putting EOF in quotes, the redirect will not +replace the variables but leave them as verbatim text. At the end of the execution we find 20 grids (e.g., such as filter_07.grd), as well as the filter_std.grd file obtained by stacking all the individual scripts and computing a standard deviation. The information needed to do all of this is hidden from the user; the actual batch scripts that we execute are derived from the user-provided main.sh script and **batch** @@ -328,7 +329,7 @@ As another example, we get a list of all European countries and make a simple co placing their name in the title and the 2-character ISO code in the upper left corner, then in postflight we combine all the individual PDFs into a single PDF file and delete the individual files. Here, we place the EOF tag in quotes which prevent the un-escaped variables from being interpreted:: - cat << 'EOF' > pre.sh + cat << EOF > pre.sh gmt begin gmt coast -E=EU+l > countries.txt gmt end diff --git a/doc/rst/source/changes.rst b/doc/rst/source/changes.rst index 2413590002b..c78ac2407d8 100644 --- a/doc/rst/source/changes.rst +++ b/doc/rst/source/changes.rst @@ -1411,7 +1411,7 @@ grdraster found in the sph supplement. :doc:`sphtriangulate` - Delaunay or Voronoi construction of spherical lon,lat data. Previously + Delaunay or Voronoi construction of spherical (*lon, lat*) data. Previously found in the sph supplement. We have also added a new supplement called potential that contains these five modules: @@ -1583,7 +1583,7 @@ ways, such as * While we support the scaling of z-values in grids via the filename convention name[=\ *ID*\ [**+s**\ *scale*][**+o**\ *offset*][**+n**\ *nan*] mechanism, there are times - when we wish to scale the x,y domain as well. Users can now + when we wish to scale the *x, y* domain as well. Users can now append **+u**\ *unit* to their gridfile names, where *unit* is one of non-arc units listed in Table :ref:`distunits `. This will convert your Cartesian x and y coordinates *from* the given unit *to* meters. We also support the inverse @@ -1660,7 +1660,7 @@ Finally, here is a list of numerous enhancements to individual programs: * :doc:`grd2cpt` takes **-F** to specify output color model and **-G** to truncate incoming CPT to be limited to a given range. -* :doc:`grd2xyz` takes **-C** to write row, col instead of x,y. Append **f** +* :doc:`grd2xyz` takes **-C** to write row, col instead of *x, y*. Append **f** to start at 1, else start at 0. Alternatively, use **-Ci** to write just the two columns *index* and *z*, where *index* is the 1-D indexing that GMT uses when referring to grid nodes. diff --git a/doc/rst/source/clip.rst b/doc/rst/source/clip.rst index 4230c2ef6d6..8cc80d82a49 100644 --- a/doc/rst/source/clip.rst +++ b/doc/rst/source/clip.rst @@ -42,7 +42,7 @@ Synopsis Description ----------- -Reads (x,y) file(s) [or standard input] and draws polygons +Reads (*x, y*) file(s) [or standard input] and draws polygons that are activated as clipping paths. Several files may be read to create complex paths consisting of several non-connecting segments. Only marks that are subsequently drawn inside the clipping path will be diff --git a/doc/rst/source/color-picker.rst b/doc/rst/source/color-picker.rst new file mode 100644 index 00000000000..94574921001 --- /dev/null +++ b/doc/rst/source/color-picker.rst @@ -0,0 +1,673 @@ +GMT Color Picker +################ + +**Hover to show the color name and RGB value, and click to copy to clipboard.** + +.. raw:: html + + + +
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ +
RGB value copied to clipboard
+ + diff --git a/doc/rst/source/colorbar.rst b/doc/rst/source/colorbar.rst index 894700e123c..07898ee1360 100644 --- a/doc/rst/source/colorbar.rst +++ b/doc/rst/source/colorbar.rst @@ -59,7 +59,7 @@ see the Technical Reference section on :ref:`Color palette tables ` :width: 500 px :align: center - Example of a horizontal colorbar placed below a geographic map. + Example of a horizontal color bar placed below a geographic map. Required Arguments ------------------ @@ -72,7 +72,7 @@ Optional Arguments .. _-B: **-B**\ [**p**\|\ **s**]\ *parameters* - Set annotation, tick, and gridline interval for the colorbar. The + Set annotation, tick, and gridline interval for the bar. The x-axis label will plot beneath a horizontal bar (or vertically to the right of a vertical bar), except when using the **+m** modifier of the |-D| option. As an option, use the y-axis label to plot the data unit to the right of a @@ -114,39 +114,35 @@ Optional Arguments pre-calculate all further settings. Specifically, the *length* is set to 80% of the map side, horizontal or vertical depends on the side, the offset is :term:`MAP_LABEL_OFFSET` for **Dj** with an extra offset :term:`MAP_FRAME_WIDTH` for **DJ**, and annotations are placed on the side of the scale facing - away from the map frame. + away from the map frame. If not given, the default argument is JBC (Place color bar centered beneath current plot). However, you can override any of these with these modifiers: - Append **+w** followed by the *length* and *width* of the color bar. If *width* is not + + - **+w** followed by the *length* and *width* of the color bar sets bar dimensions. If *width* is not specified then it is set to 4% of the given *length*. If *length* is not given then it defaults to 80% of the corresponding map side dimension. If either *length* or *width* end with % then those percentages are used instead to set the dimensions, where *width* is defined as a - percentage of the colorbar *length*. - Give a negative *length* to reverse the scale bar, or append **+r**. Append **+h** to get a - horizontal scale [Default is vertical (**+v**)]. - By default, the anchor point on the scale is assumed to be the bottom left corner (BL), but this - can be changed by appending **+j** followed by a 2-char justification code *justify* (see :doc:`text`). + percentage of the bar *length*. + - **+e** adds sidebar triangles for back- and/or foreground colors. Append **f** (foreground) or **b** + background) for only one sidebar triangle [Default gives both]. Optionally, append triangle height [Default is half the barwidth]. + - **+h** selects a horizontal scale [Default is vertical (**+v**)]. + - **+j** sets the anchor point. By default, the anchor point on the scale is assumed to be the bottom left corner (BL), + but this can be changed by appending **+j** followed by a 2-char justification code *justify* (see :doc:`text`). **Note**: If **-Dj** is used then *justify* defaults to the same as *refpoint*, if **-DJ** is used then *justify* defaults to the mirror opposite of *refpoint*. Consequently, **-DJ** is used to place a scale outside the map frame while **-Dj** is used to place it inside the frame. - Add sidebar triangles for back- and/or foreground - colors with **+e**. Append **f** (foreground) or **b** (background) for only one sidebar triangle [Default - gives both]. Optionally, append triangle height [Default is half the barwidth]. - Move text to opposite side with **+m**\ [**a**\|\ **c**\|\ **l**\|\ **u**]. + - **+m** will move text to opposite side as per arguments [**a**\|\ **c**\|\ **l**\|\ **u**]. Horizontal scale bars: Move annotations and labels above the scale bar [Default is below]; - the unit remains on the left. - Vertical scale bars: Move annotations and labels to the left of the scale bar [Default is to the right]; - the unit remains below. - Append one or more of **a**, **l** or **u** to control which of the annotations, label, and + the unit remains on the left. Vertical scale bars: Move annotations and labels to the left of the scale bar [Default is to the right]; + the unit remains below. Append one or more of **a**, **l** or **u** to control which of the annotations, label, and unit that will be moved to the opposite side. Append **c** if you want to print a vertical label as a column of characters (does not work with special characters). - Append **+n** to plot a rectangle with the NaN color at - the start of the bar, append *text* to change label from NaN. - If not given, the default argument is JBC (Place color bar centered beneath current plot). + - **+n** plots a rectangle with the NaN color at the start of the bar, append *text* to change label from NaN. + - **+r** will reverse the positive direction of the bar. .. _-F: **-F**\ [**+c**\ *clearances*][**+g**\ *fill*][**+i**\ [[*gap*/]\ *pen*]][**+p**\ [*pen*]][**+r**\ [*radius*]][**+s**\ [[*dx*/*dy*/][*shade*]]] - Without further options, draws a rectangular border around the colorbar using :term:`MAP_FRAME_PEN`. The following + Without further options, draws a rectangular border around the bar using :term:`MAP_FRAME_PEN`. The following modifiers can be appended to |-F|, with additional explanation and examples provided in the :ref:`Background-panel` cookbook section: @@ -252,7 +248,7 @@ Optional Arguments .. _-Z: **-Z**\ *widthfile* - File with colorbar-width per color entry. By default, width of entry + File with bar-width per color entry. By default, width of entry is scaled to color range, i.e., z = 0-100 gives twice the width as z = 100-150 (Also see |-L|). **Note**: The widths may be in plot distance units or given as relative fractions and will be automatically scaled diff --git a/doc/rst/source/common_SYN_OPTs.rst_ b/doc/rst/source/common_SYN_OPTs.rst_ index 6dbec408a1e..65560ff3824 100644 --- a/doc/rst/source/common_SYN_OPTs.rst_ +++ b/doc/rst/source/common_SYN_OPTs.rst_ @@ -74,7 +74,7 @@ .. |SYN_OPT-:| replace:: **-:**\ [**i**\|\ **o**] -.. |No-spaces| replace:: **Note:** No space is allowed between the option flag and the associated arguments. +.. |No-spaces| replace:: **Note**: No space is allowed between the option flag and the associated arguments. .. |SYN_OPT--| replace:: **--PAR**\ =\ *value* diff --git a/doc/rst/source/contour.rst b/doc/rst/source/contour.rst index 646cdfd65a5..e5a00665dab 100644 --- a/doc/rst/source/contour.rst +++ b/doc/rst/source/contour.rst @@ -95,7 +95,7 @@ Optional Arguments contours give them as a comma-separated string; if only a single contour please add a trailing comma so it is seen as a list and not a contour interval. The optional *labelinfo* controls the specifics of the label formatting and consists - of a concatenated string made up of any of the following control arguments: + of a concatenated string made up of any of the following modifiers: .. include:: explain_clabelinfo.rst_ @@ -107,7 +107,7 @@ Optional Arguments .. _-C: **-C**\ *contours* - The contours to be drawn may be specified in one of four possible ways: + The contours to be drawn may be specified in one of five possible ways: (1) If *contours* is a string with suffix ".cpt" and can be opened as a file, it is assumed to be a CPT. The color @@ -157,7 +157,7 @@ Optional Arguments triplets of node numbers for a triangle [Default computes these using Delaunay triangulation (see :doc:`triangulate`)]. If the *indexfile* is binary and can be read the same way as the binary - input *table* then you can append **+b** to spead up the reading + input *table* then you can append **+b** to speed up the reading [Default reads nodes as ASCII]. .. _-G: @@ -175,7 +175,7 @@ Optional Arguments **-L**\ *pen* :ref:`(more ...) ` Draw the underlying triangular mesh using the specified pen - attributes [Default is no mesh]. + attributes [Default draws no mesh]. .. _-N: @@ -191,12 +191,12 @@ Optional Arguments (see `Units`_ for available units and how distances are computed), including **c** (Cartesian distances using user coordinates) or **C** for plot length units in current plot units after projecting the coordinates. - Optionally, append **z** to exclude the zero contour. + Optionally, append **+z** to exclude the zero contour. .. _-S: **-S**\ [**p**\|\ **t**] - Skip all input *xyz* points that fall outside the region [Default + Skip all input *x, y, z* points that fall outside the region [Default uses all the data in the triangulation]. Alternatively, use **-St** to skip triangles whose three vertices are all outside the region. |-S| with no modifier is interpreted as **-Sp**. @@ -204,20 +204,8 @@ Optional Arguments .. _-T: **-T**\ [**h**\|\ **l**][**+a**][**+d**\ *gap*\ [/*length*]][**+l**\ [*labels*]] - Will draw tick marks pointing in the downward direction every *gap* - along the innermost closed contours only; append **+a** to tick all closed - contours. Append **+d**\ *gap* and optionally tick - mark *length* (append units as **c**, **i**, or **p**) or use defaults - [15\ **p**/3\ **p**]. User may choose to tick only local highs or local - lows by specifying **-Th** or **-Tl**, respectively. Append - **+l**\ *labels* to annotate the centers of closed innermost contours - (i.e., the local lows and highs). If no *labels* is appended we use - - and + as the labels. Appending exactly two characters, e.g., **+l**\ *LH*, - will plot the two characters (here, L and H) as labels. For more elaborate - labels, separate the low and high label strings with a comma (e.g., - **+l**\ *lo*,\ *hi*). If a file is given by |-C| and |-T| is set, - then only contours marked with upper case C or A will have tick marks - [and annotations]. + +.. include:: explain_contticks.rst_ .. |Add_-U| replace:: |Add_-U_links| .. include:: explain_-U.rst_ @@ -237,16 +225,16 @@ Optional Arguments particular line. Default pen for annotated contours: 0.75p,black. Regular contours use pen 0.25p,black. Normally, all contours are drawn with a fixed color determined by the pen setting. If the modifier **+cl** is appended - then the color of the contour lines are taken from the CPT (see - |-C|). If instead modifier **+cf** is appended then the color from the cpt - file is applied to the contour annotations. Select **+c** for both effects. + then the colors of the contour lines are taken from the CPT (see + |-C|). If instead modifier **+cf** is appended then the colors from the cpt + file are applied to the contour annotations. Select **+c** for both effects. .. |Add_-XY| replace:: |Add_-XY_links| .. include:: explain_-XY.rst_ :start-after: **Syntax** :end-before: **Description** -.. |Add_-bi| replace:: [Default is 3 input columns]. Use 4-byte integer triplets for node ids (|-E|). +.. |Add_-bi| replace:: [Default is 3 input columns]. To use binary 4-byte integer triplets for node ids append **+b** to |-E|. .. include:: explain_-bi.rst_ .. |Add_-bo| replace:: [Default is 3 output columns]. @@ -266,7 +254,7 @@ Optional Arguments .. include:: explain_-icols.rst_ -.. |Add_-l| replace:: Normally, the annotated contour is selected for the legend. You can select the regular contour instead, or both of them, by considering the *label* to be of the format [*annotcontlabel*][/*contlabel*]. If either label contains a slash (/) character then use | as the separator for the two labels instead. +.. |Add_-l| replace:: Normally, the annotated contour is selected for the legend. You can select the plain contour instead, or both of them, by considering the *label* to be of the format [*annotcontlabel*][/*contlabel*]. If either label contains a slash (/) character then use | instead as the separator for the two labels. .. include:: explain_-l.rst_ .. include:: explain_-qi.rst_ diff --git a/doc/rst/source/devdocs/api.rst b/doc/rst/source/devdocs/api.rst index b266c2ac4c9..ce6a052fb0c 100644 --- a/doc/rst/source/devdocs/api.rst +++ b/doc/rst/source/devdocs/api.rst @@ -2340,7 +2340,7 @@ you call GMT_Begin_IO_. The modes for setting various comment types. -The named modes (*command*, *remark*, *title*, *name_x,y,z* and +The named modes (*command*, *remark*, *title*, *name_x*\|\ *y*\|\ *z* and *colnames* are used to distinguish regular text comments from specific fields in the header structures of the data resources, such as :ref:`GMT_GRID `. For the various table resources (e.g., :ref:`GMT_DATASET `) diff --git a/doc/rst/source/devdocs/postscriptlight.rst b/doc/rst/source/devdocs/postscriptlight.rst index 18dee466cba..d81f34d9a0a 100644 --- a/doc/rst/source/devdocs/postscriptlight.rst +++ b/doc/rst/source/devdocs/postscriptlight.rst @@ -626,10 +626,10 @@ Here are functions used to plot various geometric symbols or constructs. of vector head, PSL_VEC_BEGIN (4) = place vector head at beginning of vector, PSL_VEC_END (8) = place vector head at end of vector, - PSL_VEC_JUST_B (0) = align vector beginning at (x,y), - PSL_VEC_JUST_C (16) = align vector center at (x,y), - PSL_VEC_JUST_E (32) = align vector end at (x,y), - PSL_VEC_JUST_S (64) = align vector center at (x,y), + PSL_VEC_JUST_B (0) = align vector beginning at (*x, y*), + PSL_VEC_JUST_C (16) = align vector center at (*x, y*), + PSL_VEC_JUST_E (32) = align vector end at (*x, y*), + PSL_VEC_JUST_S (64) = align vector center at (*x, y*), PSL_VEC_OUTLINE (128) = draw vector head outline using default pen, PSL_VEC_FILL (512) = fill vector head using default fill, PSL_VEC_MARC90 (2048) = if angles subtend 90, draw straight angle @@ -868,7 +868,7 @@ and others and issue calculations with **PSL_setcommand**. you must pass as *arg1* the *node* array indicating at which node in the *xpath, ypath* array the text will be plotted; let *arg2* be NULL. For - straight baselines you must instead pass another set of x,y + straight baselines you must instead pass another set of *x, y* coordinates with the locations of the text label placements via *arg1, arg2*. Each label has its own entry in the diff --git a/doc/rst/source/dimfilter.rst b/doc/rst/source/dimfilter.rst index 56abc3fd73f..530b62073af 100644 --- a/doc/rst/source/dimfilter.rst +++ b/doc/rst/source/dimfilter.rst @@ -60,20 +60,20 @@ Required Arguments .. _-D: **-D**\ *flag* - Distance *flag* (0-4) determines how grid (x,y) relates to filter *width*, as follows: + Distance *flag* (0-4) determines how grid (*x, y*) relates to filter *width*, as follows: - - *flag* = 0: grid (x,y) in same units as *width*, Cartesian distances. - - *flag* = 1: grid (x,y) in degrees, *width* in kilometers, Cartesian distances. - - *flag* = 2: grid (x,y) in degrees, *width* in km, dx scaled by + - *flag* = 0: grid (*x, y*) in same units as *width*, Cartesian distances. + - *flag* = 1: grid (*x, y*) in degrees, *width* in kilometers, Cartesian distances. + - *flag* = 2: grid (*x, y*) in degrees, *width* in km, dx scaled by cos(middle y), Cartesian distances. The above options are fastest because they allow weight matrix to be computed only once. The next two options are slower because they recompute weights for each latitude. - - *flag* = 3: grid (x,y) in degrees, *width* in km, dx scaled by + - *flag* = 3: grid (*x, y*) in degrees, *width* in km, dx scaled by cosine(y), Cartesian distance calculation. - - *flag* = 4: grid (x,y) in degrees, *width* in km, Spherical distance + - *flag* = 4: grid (*x, y*) in degrees, *width* in km, Spherical distance calculation. .. _-F: diff --git a/doc/rst/source/events.rst b/doc/rst/source/events.rst index bbcfb78ef49..7d5d172ada8 100644 --- a/doc/rst/source/events.rst +++ b/doc/rst/source/events.rst @@ -478,7 +478,7 @@ To prevent this, you can sort your file into ascending order via the :doc:`gmtco Drawing trajectories -------------------- -If **-Ar** is used to draw trajectories (lines with *x,y,t* coordinates) then, as stated, we will +If **-Ar** is used to draw trajectories (lines with *x, y, t* coordinates) then, as stated, we will use a linear interpolation to find intermediate terminal points. For geographic data, and especially if your original point spacing is large, you may wish to first interpolate such trajectories along great circles via :doc:`sample1d` rather than subject large gaps to linear interpolation. diff --git a/doc/rst/source/explain_-aspatial_full.rst_ b/doc/rst/source/explain_-aspatial_full.rst_ index 3f76aafda3a..f5a54124251 100644 --- a/doc/rst/source/explain_-aspatial_full.rst_ +++ b/doc/rst/source/explain_-aspatial_full.rst_ @@ -21,7 +21,7 @@ OGR/GMT input with **-a** option ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ If you need to populate GMT data columns with (constant) values specified by aspatial attributes, use **-a** and append -any number of comma-separated *col=name* associations. For example, **-a**\ *2=depth* will read the spatial *x,y* +any number of comma-separated *col=name* associations. For example, **-a**\ *2=depth* will read the spatial *x, y* columns from the file and add a third (*z*) column based on the value of the aspatial field called *depth*. You can also associate aspatial fields with other settings such as labels, fill colors, pens, and values (for looking-up colors) by letting the *col* value be one of **D** (for *distance*), **G** (for *fill*), **I** (for *ID*), **L** (for *label*), diff --git a/doc/rst/source/explain_-d_full.rst_ b/doc/rst/source/explain_-d_full.rst_ index 60531a22e0d..a96b7b03bd3 100644 --- a/doc/rst/source/explain_-d_full.rst_ +++ b/doc/rst/source/explain_-d_full.rst_ @@ -11,7 +11,7 @@ The **-d** option The **-d** option allows user-coded missing data values to be translated to official NaN values in GMT. Within GMT, any missing values are represented by the IEEE NaN value. However, user data may occasionally denote missing data with an unlikely value (e.g., -99999). Since GMT cannot guess this special missing data value, you can use the **-d** -option to have such values replaced with NaNs. Similarly, the **-d** option can replace all NaNs with the chosed +option to have such values replaced with NaNs. Similarly, the **-d** option can replace all NaNs with the chosen *nodata* value should the GMT output need to conform to such a requirement. For input only, use **-di**\ *nodata* to examine all input columns after the first two. If any item equals *nodata*, diff --git a/doc/rst/source/explain_-e_full.rst_ b/doc/rst/source/explain_-e_full.rst_ index 54de8a42f11..961257940db 100644 --- a/doc/rst/source/explain_-e_full.rst_ +++ b/doc/rst/source/explain_-e_full.rst_ @@ -15,4 +15,5 @@ The test can also be inverted to only pass data records that *do not* match the character with a backslash [Default accepts all data records]. For matching data records against extended `regular expressions `_, please enclose the expression in slashes. Append **i** for case-insensitive matching. To supply a list of such patterns, give **+f**\ *file* with one pattern per line. -To give a single pattern starting with **+f**, escape it with a backslash. +To give a single pattern starting with **+f**, escape it with a backslash. **Note**: Option **-e** is not allowed if +**-b** selects binary input. diff --git a/doc/rst/source/explain_contdump.rst_ b/doc/rst/source/explain_contdump.rst_ index 5ed7420abc5..ff58782bcf4 100644 --- a/doc/rst/source/explain_contdump.rst_ +++ b/doc/rst/source/explain_contdump.rst_ @@ -1,4 +1,4 @@ - Dump the (x,y,z) coordinates of each contour to one or more output files + Dump the (*x, y, z*) coordinates of each contour to one or more output files (or standard output if *template* is not given). No plotting will take place. If *template* contains one or more of the C language `printf `_ format specifiers %d, %f, %c diff --git a/doc/rst/source/explain_contlabel.rst_ b/doc/rst/source/explain_contlabel.rst_ index f403c662223..a617f528bc2 100644 --- a/doc/rst/source/explain_contlabel.rst_ +++ b/doc/rst/source/explain_contlabel.rst_ @@ -12,8 +12,8 @@ option, you can append /*fraction* which is used to place the very first label for each contour when the cumulative along-contour distance equals *fraction \* dist* [0.25]. - **f**\ *ffile.d* - Reads the ASCII file *ffile.d* and places labels at locations in + **f**\ *ffile* + Reads the ASCII file *ffile* and places labels at locations in the file that matches locations along the quoted lines. Inexact matches and points outside the region are skipped. **l\|L**\ *line1*\ [,\ *line2*,...] @@ -24,7 +24,7 @@ are either a specified point *lon/lat* or a 2-character **XY** key that uses the justification format employed in :doc:`text` to indicate a point on the map, given as [**LCR**][**BMT**]. - In addition, you can use Z-, Z+ to mean the global minimum and + In addition, you can use **Z-**, **Z+** to mean the global minimum and maximum locations in the grid. **L** will interpret the point pairs as defining great circles [Default is straight line]. **n**\ *n\_label* @@ -36,10 +36,10 @@ /*min\_dist*\ [**c**\|\ **i**\|\ **p**] to enforce that a minimum distance separation between successive labels is enforced. - **x\|X**\ *xfile.d* - Reads the multisegment file *xfile.d* and places labels at the + **x\|X**\ *xfile* + Reads the multisegment file *xfile* and places labels at the intersections between the quoted lines and the lines in - *xfile.d*. **X** will resample the lines first along + *xfile*. **X** will resample the lines first along great-circle arcs. In addition, you may optionally append diff --git a/doc/rst/source/explain_contticks.rst_ b/doc/rst/source/explain_contticks.rst_ new file mode 100644 index 00000000000..d4c5a0ef2bd --- /dev/null +++ b/doc/rst/source/explain_contticks.rst_ @@ -0,0 +1,18 @@ + Will draw tick marks pointing in the downward direction every *gap* distance + along the innermost closed contours only. User may choose to tick only local + highs or local lows by appending the directives **h** or **l**, respectively. + This behavior can be further changed with these modifiers: + - **+a** will tick all closed contours, not just the innermost. + - **+d**\ *gap*\ [/*length*] sets the gap between ticks and optionally the tick + mark *length* (append units as **c**, **i**, or **p**) or use defaults + [15\ **p**/3\ **p**]. + - **+l**\ *labels* sets how to annotate the centers of closed innermost contours + (i.e., the local lows and highs). If no *labels* is appended we use **-** + and **+** as the labels. Appending exactly two characters, e.g., **+l**\ *LH*, + will plot the two characters (here, L and H) as labels. For more elaborate + labels, separate the low and high label strings with a comma (e.g., + **+l**\ *lo*,\ *hi*). If a file is given by |-C| and |-T| is set, + then only contours marked with upper case C or A will have tick marks + [and annotations]. **Note**: The labeling of local highs and lows may plot sometimes + outside the innermost contour since only the mean value of the contour coordinates + is used to position the label. diff --git a/doc/rst/source/explain_grd_inout.rst_ b/doc/rst/source/explain_grd_inout.rst_ index e8c6b25aaf4..495448732e4 100644 --- a/doc/rst/source/explain_grd_inout.rst_ +++ b/doc/rst/source/explain_grd_inout.rst_ @@ -58,7 +58,7 @@ double quotes. - **+o** - Offset data values by the given *offset* [Default is 0]. - **+s** - Scale data values by the given *scale* [Default is 1]. - Note: Any offset is added after any scaling. + **Note**: Any offset is added after any scaling. .. ingrid-syntax-ends .. outgrid-syntax-begins diff --git a/doc/rst/source/explain_symbols.rst_ b/doc/rst/source/explain_symbols.rst_ index 9a4b088d069..5c40b1f92b5 100644 --- a/doc/rst/source/explain_symbols.rst_ +++ b/doc/rst/source/explain_symbols.rst_ @@ -221,7 +221,7 @@ to *base* [Relative to origin]. Normally, the bar requires a single input *y*-value. To plot multi-band bars, please append **+v**\|\ **i**\ *ny*, where *ny* indicates the total number of bands in the bar (and hence the number of values required to follow - the x,y coordinate pair in the input). Here, **+i** means we must accumulate the + the *x, y* coordinate pair in the input). Here, **+i** means we must accumulate the bar values from the increments *dy*, while **+v** means we get the complete values relative to *base* in increasing order. Normally, the bands are plotted as sections of a final single bar. Use **+s** to instead split the bar into *ny* side-by-side, individual and thinner bars. The @@ -239,7 +239,7 @@ to *base* [Relative to origin]. Normally, the bar requires a single input *x*-value. To plot multi-band bars, please append **+v**\|\ **i**\ *nx*, where *nx* indicates the total number of bands in the bar (and hence the number of values required to follow - the x,y coordinate pair in the input). Here, **+i** means we must accumulate the + the *x, y* coordinate pair in the input). Here, **+i** means we must accumulate the bar value from the increments *dx*, while **+v** means we get the complete values relative to *base* in increasing order. Normally, the bands are plotted as sections of a final single bar. Use **+s** to instead split the bar into *nx* side-by-side, individual and thinner bars. The diff --git a/doc/rst/source/figure.rst b/doc/rst/source/figure.rst index de56d974fe3..2c7f1753924 100644 --- a/doc/rst/source/figure.rst +++ b/doc/rst/source/figure.rst @@ -60,7 +60,7 @@ Optional Arguments can be passed to :doc:`psconvert` when preparing this figure [**A**]. The valid subset of options are **A**\ [*args*],\ **C**\ *args*,\ **D**\ *dir*,\ **E**\ *dpi*,\ **H**\ *factor*,\ **I**\ *args*,\ **M**\ *args*,\ **N**\ *args*,\ **Q**\ *args*,\ **S**. - See the :doc:`psconvert` documentation for details on these options. + Note that the leading hyphens should not be given. See the :doc:`psconvert` documentation for details on these options. .. |Add_-V| replace:: |Add_-V_links| .. include:: explain_-V.rst_ diff --git a/doc/rst/source/filter1d.rst b/doc/rst/source/filter1d.rst index 9b6852e97aa..192a9f40ce5 100644 --- a/doc/rst/source/filter1d.rst +++ b/doc/rst/source/filter1d.rst @@ -226,11 +226,11 @@ v3312.txt, checking for gaps of 10 km and asymmetry of 0.3: gmt filter1d v3312.txt -FM50 -T0/100000/25 -L10 -S0.3 > v3312_filt.txt To smooth a noisy geospatial track using a Gaussian filter of full-width 100 km -and not shorten the track, and add the distances to the file, use +and not shorten the track, and add the distances every 2km to the file, use :: - gmt filter1d track.txt -Tk+a -E -Fg200 > smooth_track.txt + gmt filter1d track.txt -T2k+a -E -Fg200 > smooth_track.txt See Also -------- diff --git a/doc/rst/source/fitcircle.rst b/doc/rst/source/fitcircle.rst index 0dae59f120c..cdfc0e7af0f 100644 --- a/doc/rst/source/fitcircle.rst +++ b/doc/rst/source/fitcircle.rst @@ -32,7 +32,7 @@ Synopsis Description ----------- -**fitcircle** reads lon,lat [or lat,lon] values from the first two +**fitcircle** reads (*lon, lat*) [or (*lat, lon*)] values from the first two columns on standard input [or *table*]. These are converted to Cartesian three-vectors on the unit sphere. Then two locations are found: the mean of the input positions, and the pole to the great circle @@ -64,7 +64,7 @@ Required Arguments ------------------ *table* - One or more ASCII [or binary, see **-bi**] files containing lon,lat [or lat,lon; see + One or more ASCII [or binary, see **-bi**] files containing (*lon, lat*) [or (*lat, lon*); see **-:**\ [**i**\|\ **o**]] values in the first 2 columns. If no file is specified, **fitcircle** will read from standard input. @@ -140,12 +140,12 @@ Examples .. include:: explain_example.rst_ -To find the parameters of a great circle that most closely fits the (lon,lat) +To find the parameters of a great circle that most closely fits the (*lon, lat*) points in the remote file @sat_03.txt in a least-squares sense, try:: gmt fitcircle @sat_03.txt -L2 -Fm -Suppose you have lon,lat,grav data along a twisty ship track in the file +Suppose you have *lon, lat, grav* data along a twisty ship track in the file ship.xyg. You want to project this data onto a great circle and resample it in distance, in order to filter it or check its spectrum. Do the following: @@ -160,7 +160,7 @@ Here, *ox*/*oy* is the lon/lat of the mean from **fitcircle**, and gravity data sampled every 1 km along the great circle which best fits ship.xyg -If you have lon, lat points in the file data.txt and wish to return the northern +If you have *lon, lat* points in the file data.txt and wish to return the northern hemisphere great circle pole location using the L2 norm, try :: diff --git a/doc/rst/source/gallery/ex03.rst b/doc/rst/source/gallery/ex03.rst index d097208c3e6..197b3b6b043 100644 --- a/doc/rst/source/gallery/ex03.rst +++ b/doc/rst/source/gallery/ex03.rst @@ -6,9 +6,9 @@ In this example we will show how to use the GMT programs :doc:`fitcircle `, :doc:`project `, :doc:`sample1d `, :doc:`spectrum1d `, -and :doc:`plot `. Suppose you have (lon, lat, -gravity) along a satellite track in a file called ``sat.xyg``, and (lon, lat, -gravity) along a ship track in a file called ``ship.xyg``. You want to make a +and :doc:`plot `. Suppose you have (*lon, lat, +gravity*) along a satellite track in a file called ``sat.xyg``, and (*lon, lat, +gravity*) along a ship track in a file called ``ship.xyg``. You want to make a cross-spectral analysis of these data. First, you will have to get the two data sets into equidistantly sampled time-series form. To do this, it will be convenient to project these along the great circle that best diff --git a/doc/rst/source/gallery/ex49.rst b/doc/rst/source/gallery/ex49.rst index bbcea5bbcce..3325bf420c2 100644 --- a/doc/rst/source/gallery/ex49.rst +++ b/doc/rst/source/gallery/ex49.rst @@ -5,7 +5,7 @@ In this example we show an example of data analysis using grids of seafloor depth and age for a region in the south Atlantic. -Dumping separate x,y,z triplets with :doc:`grd2xyz ` +Dumping separate *x, y, z* triplets with :doc:`grd2xyz ` lets us paste the output back via :doc:`gmtconvert ` to make binary tables of age,depth,depth. Here, depth is repeated in order to use :doc:`blockmode ` for modal depth estimation diff --git a/doc/rst/source/gmt.conf.rst b/doc/rst/source/gmt.conf.rst index 096501ba77c..c95fb4fc02f 100644 --- a/doc/rst/source/gmt.conf.rst +++ b/doc/rst/source/gmt.conf.rst @@ -568,11 +568,11 @@ I/O Parameters **IO_LONLAT_TOGGLE** (**-:**) Set if the first two columns of input and output files - contain (latitude,longitude) or (y,x) rather than the expected - (longitude,latitude) or (x,y). false means we have (x,y) both on - input and output. **true** means both input and output should be (y,x). - **IN** means only input has (y,x), while **OUT** means only output should - be (y,x) [default is **false**]. + contain (*latitude,longitude*) or (**y, x**) rather than the expected + (longitude,latitude) or (*x, y*). false means we have (*x, y*) both on + input and output. **true** means both input and output should be (**y, x**). + **IN** means only input has (**y, x**), while **OUT** means only output should + be (**y, x**) [default is **false**]. **IO_N_HEADER_RECS** Specifies how many header records to expect if **-h** is used [default is **0**]. diff --git a/doc/rst/source/gmt.rst b/doc/rst/source/gmt.rst index df3a922a28e..dff6fe01328 100644 --- a/doc/rst/source/gmt.rst +++ b/doc/rst/source/gmt.rst @@ -12,13 +12,13 @@ Introduction ------------ GMT is a collection of freely available command-line tools under the GNU LGPL that allows you to -manipulate x,y and x,y,z data sets (filtering, trend fitting, gridding, +manipulate *x, y* and *x, y, z* data sets (filtering, trend fitting, gridding, projecting, etc.) and produce illustrations ranging from simple x-y plots, via contour maps, to artificially illuminated surfaces and 3-D perspective views in black/white or full color. Linear, :math:`\log_{10}`, and power scaling is supported in addition to over 30 common map projections. The processing and display routines within GMT are -completely general and will handle any (x,y) or (x,y,z) data as input. +completely general and will handle any (*x, y*) or (*x, y, z*) data as input. Synopsis -------- diff --git a/doc/rst/source/gmt2kml.rst b/doc/rst/source/gmt2kml.rst index cce0774d73f..109415ac5db 100644 --- a/doc/rst/source/gmt2kml.rst +++ b/doc/rst/source/gmt2kml.rst @@ -306,14 +306,14 @@ first make the CPT and then create the KML file thus:: gmt makecpt -Ccategorical > categories.cpt gmt 2kml @kml_pointsets.txt -Ccategories.cpt > points.kml -To convert a file with point locations (lon, lat) into a KML file with +To convert a file with point locations (*lon, lat*) into a KML file with red circle symbols, try :: gmt 2kml mypoints.txt -Gred+f -Fs > mypoints.kml -To convert a multisegment file with lines (lon, lat) separated by +To convert a multisegment file with lines (*lon, lat*) separated by segment headers that contain a **-L**\ labelstring with the feature name, selecting a thick white pen, and title the document, try @@ -321,7 +321,7 @@ name, selecting a thick white pen, and title the document, try gmt 2kml mylines.txt -Wthick,white -Fl -T"Lines from here to there" > mylines.kml -To convert a multisegment file with polygons (lon, lat) separated by +To convert a multisegment file with polygons (*lon, lat*) separated by segment headers that contain a **-L**\ labelstring with the feature name, selecting a thick black pen and semi-transparent yellow fill, giving a title to the document, and prescribing a particular region @@ -331,7 +331,7 @@ limit, try gmt 2kml mypolygons.txt -Gyellow@50+f -Fp -T"My polygons" -R30/90/-20/40 > mypolygons.kml -To convert a file with point locations (lon, lat, time) into a KML file +To convert a file with point locations (*lon, lat, time*) into a KML file with green circle symbols that will go active at the specified time and stay active going forward, try @@ -415,7 +415,7 @@ a crude example: