Skip to content

Commit f87ec06

Browse files
Merge branch 'main' into ci/enable-docs-windows
2 parents 1cde3c0 + b8c3353 commit f87ec06

296 files changed

Lines changed: 7454 additions & 3576 deletions

File tree

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

.github/ISSUE_TEMPLATE/2-feature_request.yaml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
name: Feature request - General feature
1+
name: Feature request
22
description: Request the addition of a new feature/functionality
33
labels: ["feature request"]
44
body:
Lines changed: 45 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,45 @@
1+
---
2+
name: Wrapper for a GMT module
3+
about: Track the progress of wrapping a GMT module. [For project maintainers only!]
4+
title: "Wrapper: Description of the module"
5+
labels: ["feature request"]
6+
7+
---
8+
9+
*This issue serves as the central place for discussing and tracking the implementation of the `<wrapper>` method in PyGMT. The issue will be closed when the initial implementation is complete. Progress is tracked at https://github.com/orgs/GenericMappingTools/projects/3.*
10+
11+
## Documentation
12+
13+
- GMT: https://docs.generic-mapping-tools.org/dev/<module>.html
14+
- GMT.jl: https://www.generic-mapping-tools.org/GMTjl_doc/documentation/modules/<module>
15+
- PyGMT: https://www.pygmt.org/dev/api/generated/<wrapper>.html
16+
17+
## GMT Option Flags and Modifiers
18+
19+
☑️: *Implemented*; ⬜: *To be implemented/discussed*; ~~Strikethrough~~: *Won't implement*.
20+
21+
- [ ] `-B`: `frame`
22+
- [ ] `-J`: `projection`
23+
- [ ] `-R`: `region`
24+
- [ ] ...
25+
- [ ] ~~`-U`~~: Use `Figure.timestamp` instead.
26+
- [ ] `-V`: `verbose`
27+
- [ ] ~~`-X`/`-Y`~~: Use `Figure.shift_origin` instead.
28+
- [ ] ~~`--PAR=value`~~: Use `pygmt.config` instead.
29+
30+
## Related GMT configurations
31+
32+
*List any related GMT configurations that may affect the behavior.*
33+
34+
## Notes on Input Formats
35+
36+
*Add any notes on the input formats, especially the meaning of columns.*
37+
38+
## Linked Pull Requests
39+
40+
- [ ] Initial feature implementation
41+
- [ ] Add a tutorial or gallery example
42+
43+
## Related Issues and Discussions
44+
45+
*Add links to related wrapper discussions, API design threads, or upstream GMT changes here.*

.github/ISSUE_TEMPLATE/3-module_request.yaml

Lines changed: 0 additions & 41 deletions
This file was deleted.

.github/ISSUE_TEMPLATE/4-release_checklist.md

Lines changed: 4 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -23,11 +23,13 @@ assignees: ''
2323
- [ ] Check [SPEC 0](https://scientific-python.org/specs/spec-0000/) to see if we need to bump the minimum supported versions of GMT, Python and core package dependencies (NumPy, pandas, Xarray)
2424
- [ ] Review the ["PyGMT Team" page](https://www.pygmt.org/dev/team.html)
2525
- [ ] README looks good on TestPyPI. Visit [TestPyPI](https://test.pypi.org/project/pygmt/#history), click the latest pre-release, and check the homepage.
26+
- [ ] Review new parameter names added/changed for clarity and consistency across the API
2627
- [ ] Check to ensure that:
27-
- [ ] Deprecated workarounds/codes/tests are removed. Run `grep "# TODO" **/*.py` to find all potential TODOs.
28+
- [ ] Deprecated workarounds/codes/tests are removed. Run `grep -r "# TODO" --include="*.py" .` to find all potential TODOs.
2829
- [ ] All tests pass in the ["GMT Legacy Tests" workflow](https://github.com/GenericMappingTools/pygmt/actions/workflows/ci_tests_legacy.yaml)
2930
- [ ] All tests pass in the ["GMT Dev Tests" workflow](https://github.com/GenericMappingTools/pygmt/actions/workflows/ci_tests_dev.yaml)
3031
- [ ] All tests pass in the ["Doctests" workflow](https://github.com/GenericMappingTools/pygmt/actions/workflows/ci_doctests.yaml)
32+
- [ ] All links work in the ["Check Links" workflow](https://github.com/GenericMappingTools/pygmt/actions/workflows/check-links.yml)
3133
- [ ] Update warnings in `pygmt/_show_versions.py` as well as notes in [Not working transparency](https://www.pygmt.org/dev/install.html#not-working-transparency) regarding GMT-Ghostscript incompatibility
3234
- [ ] Reserve a DOI on [Zenodo](https://zenodo.org) by clicking on "New Version"
3335
- [ ] Finish up the "Changelog entry for v0.x.x" Pull Request (Use the previous changelog PR as a reference)
@@ -52,7 +54,7 @@ assignees: ''
5254
- [ ] Bump PyGMT version on https://github.com/GenericMappingTools/try-gmt (after conda-forge update)
5355
- [ ] Announce the release on:
5456
- [ ] GMT [forum](https://forum.generic-mapping-tools.org/c/news/) (do this announcement first! Requires moderator status)
55-
- [ ] [ResearchGate](https://www.researchgate.net) (after forum announcement; download the ZIP file of the new release from the release page and add it as research item via the **code** category, be sure to include the corresponding new Zenodo DOI)
57+
- [ ] [ResearchGate](https://www.researchgate.net) (after forum announcement; download the ZIP file of the new release from Zenodo and add it as research item via the **code** category, be sure to include the corresponding new Zenodo DOI)
5658
- [ ] Update release checklist template with any additional bullet points that may have arisen during the release
5759

5860
---

.github/ISSUE_TEMPLATE/5-bump_gmt_checklist.md

Lines changed: 13 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -7,11 +7,10 @@ assignees: ''
77

88
---
99

10-
:tada: [GMT X.Y.Z](https://github.com/GenericMappingTools/gmt/releases/tag/X.Y.Z) has been released!
11-
It is installable from the [conda-forge channel](https://anaconda.org/conda-forge/gmt/files)
12-
using the following command:
13-
14-
`mamba install -c conda-forge gmt=X.Y.Z`
10+
:tada: [GMT X.Y.Z](https://github.com/GenericMappingTools/gmt/releases/tag/X.Y.Z) has been released! It is installable from the [conda-forge channel](https://anaconda.org/conda-forge/gmt/files) using the following command:
11+
```
12+
mamba install -c conda-forge gmt=X.Y.Z
13+
```
1514

1615
<!-- Please add specific checklist items for the tests, xfail pytest markers, and deprecated syntax that need to be updated. -->
1716

@@ -29,13 +28,20 @@ using the following command:
2928
- [ ] Update GMT 6.x minor version for `extlinks` urls in `doc/conf.py`
3029
- [ ] Fix failing tests (1 or more PRs)
3130
- [ ] Fix failing doctests reported in the ["Doctest" workflow](https://github.com/GenericMappingTools/pygmt/actions/workflows/ci_doctests.yaml)
32-
- [ ] Fix [xfail](https://docs.pytest.org/en/stable/skipping.html#xfail-mark-test-functions-as-expected-to-fail) pytest markers on tests that are now xpass
31+
- [ ] Run `grep -r "# TODO(GMT.*)" --include="*.py" .` to find TODO items related to GMT
32+
- [ ] Remove related workarounds/patches
33+
- [ ] Fix tests with pytest `xfail`/`skipif` markers that now pass
34+
- [ ] Update URLs to manually inserted images of the GMT documentation
35+
- [ ] Update this checklist if necessary
3336

3437
**To-Do for bumping the minimum required GMT version**:
3538

3639
- [ ] Bump the minimum required GMT version (1 PR)
3740
- [ ] Update `required_gmt_version` in `pygmt/clib/__init__.py`
3841
- [ ] Remove unsupported GMT version from `.github/workflows/ci_tests_legacy.yaml`
3942
- [ ] Ensure minimum required version is correct in `doc/minversions.md`
40-
- [ ] Remove [xfail](https://docs.pytest.org/en/stable/skipping.html#xfail-mark-test-functions-as-expected-to-fail) pytest markers on tests that are now xpass
43+
- [ ] Run `grep -r "# TODO(GMT.*)" --include="*.py" .` to find TODO items related to GMT
44+
- [ ] Remove related workarounds/patches
45+
- [ ] Fix tests with pytest `xfail`/`skipif` markers that now pass
4146
- [ ] Update deprecated syntax in source code and examples based on the [GMT Changelog](https://docs.generic-mapping-tools.org/latest/changes.html)
47+
- [ ] Update this checklist if necessary

.github/PULL_REQUEST_TEMPLATE.md

Lines changed: 4 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -11,15 +11,11 @@ Fixes #
1111
<!-- If significant changes to the documentation are made, please insert the link to the documentation page after it has been built. -->
1212
**Preview**:
1313

14+
**Guidelines**
1415

15-
**Reminders**
16-
17-
- [ ] Run `make format` and `make check` to make sure the code follows the style guide.
18-
- [ ] Add tests for new features or tests that would have caught the bug that you're fixing.
19-
- [ ] Add new public functions/methods/classes to `doc/api/index.rst`.
20-
- [ ] Write detailed docstrings for all functions/methods.
21-
- [ ] If wrapping a new module, open a 'Wrap new GMT module' issue and submit reasonably-sized PRs.
22-
- [ ] If adding new functionality, add an example to docstrings or tutorials.
16+
- [General Guidelines for Pull Request](https://www.pygmt.org/dev/contributing.html#general-guidelines-for-making-a-pull-request-pr)
17+
- [Guidelines for Contributing Documentation](https://www.pygmt.org/dev/contributing.html#contributing-documentation)
18+
- [Guidelines for Contributing Code](https://www.pygmt.org/dev/contributing.html#contributing-code)
2319

2420
**Slash Commands**
2521

.github/config.yml

Lines changed: 0 additions & 23 deletions
This file was deleted.

.github/dependabot.yml

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,6 @@
22

33
version: 2
44
updates:
5-
65
- package-ecosystem: "github-actions"
76
directory: "/"
87
schedule:
@@ -15,3 +14,5 @@ updates:
1514
labels:
1615
- "maintenance"
1716
- "skip-changelog"
17+
cooldown:
18+
default-days: 7

.github/workflows/benchmarks.yml

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -36,7 +36,7 @@ jobs:
3636
steps:
3737
# Checkout current git repository
3838
- name: Checkout
39-
uses: actions/checkout@v5.0.0
39+
uses: actions/checkout@v6.0.1
4040
with:
4141
# fetch all history so that setuptools-scm works
4242
fetch-depth: 0
@@ -56,7 +56,7 @@ jobs:
5656
cache-environment-key: micromamba-environment-${{ steps.date.outputs.date }}
5757
create-args: >-
5858
gmt=6.6.0
59-
python=3.13
59+
python=3.14
6060
numpy
6161
pandas
6262
xarray
@@ -84,7 +84,7 @@ jobs:
8484

8585
# Run the benchmark tests
8686
- name: Run benchmarks
87-
uses: CodSpeedHQ/action@6eeb021fd0f305388292348b775d96d95253adf4 # v4.0.0
87+
uses: CodSpeedHQ/action@4deb3275dd364fb96fb074c953133d29ec96f80f # v4.10.6
8888
with:
8989
mode: "instrumentation"
9090
# 'bash -el -c' is needed to use the custom shell.

.github/workflows/cache_data.yaml

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -38,7 +38,7 @@ jobs:
3838
steps:
3939
# Checkout current git repository
4040
- name: Checkout
41-
uses: actions/checkout@v5.0.0
41+
uses: actions/checkout@v6.0.1
4242
with:
4343
# fetch all history so that setuptools-scm works
4444
fetch-depth: 0
@@ -50,7 +50,7 @@ jobs:
5050
with:
5151
environment-name: pygmt
5252
create-args: >-
53-
python=3.13
53+
python=3.14
5454
gmt=6.6.0
5555
numpy
5656
pandas
@@ -74,7 +74,7 @@ jobs:
7474

7575
# Upload the downloaded files as artifacts to GitHub
7676
- name: Upload artifacts to GitHub
77-
uses: actions/upload-artifact@v4.6.2
77+
uses: actions/upload-artifact@v6.0.0
7878
with:
7979
name: gmt-cache
8080
include-hidden-files: true

0 commit comments

Comments
 (0)