Skip to content

Commit 0a03a47

Browse files
committed
Merge branch 'main' into tilemap
2 parents d503268 + 5fd85dd commit 0a03a47

Some content is hidden

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

56 files changed

+450
-179
lines changed

.github/ISSUE_TEMPLATE/bump_gmt_checklist.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -10,7 +10,7 @@ assignees: ''
1010
:tada: [GMT X.Y.Z](https://github.com/GenericMappingTools/gmt/releases/tag/X.Y.Z) has been released! It is installable from the
1111
[conda-forge channel](https://anaconda.org/conda-forge/gmt/files) using the following command:
1212

13-
`conda install -c conda-forge gmt=X.Y.Z`
13+
`mamba install -c conda-forge gmt=X.Y.Z`
1414

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

.github/ISSUE_TEMPLATE/release_checklist.md

Lines changed: 4 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -16,7 +16,10 @@ assignees: ''
1616
- [ ] Wrap Y ()
1717

1818
**Before release**:
19-
- [ ] Run `grep --include="*.py" -r 'remove_version="vX.Y.Z"' pygmt` from the base of the repository to check if any deprecations and related tests should be removed in this version
19+
- [ ] Check to ensure that:
20+
- [ ] All tests pass in the ["GMT Legacy Tests" workflow](https://github.com/GenericMappingTools/pygmt/actions/workflows/ci_tests_legacy.yaml)
21+
- [ ] All tests pass in the ["GMT Dev Tests" workflow](https://github.com/GenericMappingTools/pygmt/actions/workflows/ci_tests_dev.yaml)
22+
- [ ] Deprecations and related tests are removed for this version by running `grep --include="*.py" -r 'remove_version="vX.Y.Z"' pygmt` from the base of the repository
2023
- [ ] Reserve a DOI on [Zenodo](https://zenodo.org) by clicking on "New Version"
2124
- [ ] Finish up 'Changelog entry for v0.x.x' Pull Request:
2225
- [ ] Add a new entry in `doc/_static/version_switch.js` for documentation switcher

.github/workflows/publish-to-pypi.yml

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -53,13 +53,13 @@ jobs:
5353
ls -lh dist/
5454
5555
- name: Publish to Test PyPI
56-
uses: pypa/gh-action-pypi-publish@v1.6.4
56+
uses: pypa/gh-action-pypi-publish@v1.7.1
5757
with:
5858
password: ${{ secrets.TEST_PYPI_API_TOKEN }}
59-
repository_url: https://test.pypi.org/legacy/
59+
repository-url: https://test.pypi.org/legacy/
6060

6161
- name: Publish to PyPI
6262
if: startsWith(github.ref, 'refs/tags')
63-
uses: pypa/gh-action-pypi-publish@v1.6.4
63+
uses: pypa/gh-action-pypi-publish@v1.7.1
6464
with:
6565
password: ${{ secrets.PYPI_API_TOKEN }}

.github/workflows/release-baseline-images.yml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -34,7 +34,7 @@ jobs:
3434
shasum -a 256 baseline-images.zip
3535
3636
- name: Upload baseline image as a release asset
37-
uses: shogo82148/[email protected].3
37+
uses: shogo82148/[email protected].4
3838
with:
3939
upload_url: ${{ github.event.release.upload_url }}
4040
asset_path: baseline-images.zip

.github/workflows/style_checks.yaml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -18,7 +18,7 @@ jobs:
1818
- name: Checkout
1919
uses: actions/[email protected]
2020

21-
# Setup Miniconda
21+
# Setup Python
2222
- name: Set up Python
2323
uses: actions/[email protected]
2424
with:

AUTHORS.md

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -13,6 +13,7 @@ The following people have contributed code and/or documentation to the project
1313
* [Dongdong Tian](https://seisman.info/) | [0000-0001-7967-1197](https://orcid.org/0000-0001-7967-1197) | China University of Geosciences, China
1414
* [Jamie Quinn](http://jamiejquinn.com) | [0000-0002-0268-7032](https://orcid.org/0000-0002-0268-7032) | University College London, United Kingdom
1515
* [Jiayuan Yao](https://github.com/core-man) | [0000-0001-7036-4238](https://orcid.org/0000-0001-7036-4238) | Nanyang Technological University, Singapore
16+
* [Jing-Hui Tong](https://github.com/JingHuiTong) | [0009-0002-7195-3071](https://orcid.org/0009-0002-7195-3071) | National Taiwan Normal University, Taiwan
1617
* [Kathryn Materna](https://github.com/kmaterna) | [0000-0002-6687-980X](https://orcid.org/0000-0002-6687-980X) | US Geological Survey, USA
1718
* [Leonardo Uieda](http://www.leouieda.com/) | [0000-0001-6123-9515](https://orcid.org/0000-0001-6123-9515) | University of Liverpool, United Kingdom
1819
* [Liam Toney](https://liam.earth/) | [0000-0003-0167-9433](https://orcid.org/0000-0003-0167-9433) | University of Alaska Fairbanks, USA

Makefile

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -26,7 +26,7 @@ install:
2626
pip install --no-deps -e .
2727

2828
package:
29-
python -m build --sdist --wheel
29+
python -m build
3030

3131
test:
3232
# Run a tmp folder to make sure the tests are run on the installed version

README.rst

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -92,13 +92,13 @@ Quickstart
9292
Installation
9393
++++++++++++
9494

95-
Simple installation using `conda <https://docs.conda.io/projects/conda/en/latest/user-guide/index.html>`__::
95+
Simple installation using `mamba <https://mamba.readthedocs.org/>`__::
9696

97-
conda install --channel conda-forge pygmt
97+
mamba install --channel conda-forge pygmt
9898

99-
If you use `mamba <https://mamba.readthedocs.org/>`__::
99+
If you use `conda <https://docs.conda.io/projects/conda/en/latest/user-guide/index.html>`__::
100100

101-
mamba install --channel conda-forge pygmt
101+
conda install --channel conda-forge pygmt
102102

103103
For other ways to install ``pygmt``, see `full installation instructions <https://www.pygmt.org/latest/install.html>`__.
104104

doc/contributing.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -190,7 +190,7 @@ We highly recommend using [Mambaforge](https://github.com/conda-forge/miniforge#
190190
and the `mamba` package manager to install and manage your Python packages.
191191
It will make your life a lot easier!
192192

193-
The repository includes a conda environment file `environment.yml` with the
193+
The repository includes a virtual environment file `environment.yml` with the
194194
specification for all development requirements to build and test the project.
195195
In particular, these are some of the key development dependencies you will need
196196
to install to build the documentation and run the unit tests locally:

doc/install.rst

Lines changed: 15 additions & 16 deletions
Original file line numberDiff line numberDiff line change
@@ -116,15 +116,15 @@ Installing GMT and other dependencies
116116
Before installing PyGMT, we must install GMT itself along with the other
117117
dependencies. The easiest way to do this is via the ``mamba`` or ``conda`` package manager.
118118
We recommend working in an isolated
119-
`conda environment <https://conda.io/projects/conda/en/latest/user-guide/tasks/manage-environments.html>`__
119+
`virtual environment <https://conda.io/projects/conda/en/latest/user-guide/tasks/manage-environments.html>`__
120120
to avoid issues with conflicting versions of dependencies.
121121

122122
First, we must configure conda to get packages from the
123123
`conda-forge channel <https://conda-forge.org/>`__::
124124

125125
conda config --prepend channels conda-forge
126126

127-
Now we can create a new conda environment with Python and all our dependencies
127+
Now we can create a new virtual environment with Python and all our dependencies
128128
installed (we'll call it ``pygmt`` but feel free to change it to whatever you
129129
want):
130130

@@ -135,14 +135,14 @@ want):
135135

136136
::
137137

138-
mamba create --name pygmt python=3.9 numpy pandas xarray netcdf4 packaging gmt
138+
mamba create --name pygmt python=3.11 numpy pandas xarray netcdf4 packaging gmt
139139

140140
.. tab-item:: conda
141141
:sync: conda
142142

143143
::
144144

145-
conda create --name pygmt python=3.9 numpy pandas xarray netcdf4 packaging gmt
145+
conda create --name pygmt python=3.11 numpy pandas xarray netcdf4 packaging gmt
146146

147147
Activate the environment by running the following (**do not forget this step!**):
148148

@@ -162,17 +162,17 @@ Activate the environment by running the following (**do not forget this step!**)
162162

163163
conda activate pygmt
164164

165-
From now on, all commands will take place inside the conda virtual environment
166-
called ``pygmt`` and won't affect your default ``base`` installation.
165+
From now on, all commands will take place inside the virtual environment called
166+
``pygmt`` and won't affect your default ``base`` installation.
167167

168168

169169
Installing PyGMT
170170
----------------
171171

172-
Now that you have GMT installed and your conda virtual environment activated,
173-
you can install PyGMT using any of the following methods:
172+
Now that you have GMT installed and your virtual environment activated, you can
173+
install PyGMT using any of the following methods:
174174

175-
Using conda/mamba (recommended)
175+
Using mamba/conda (recommended)
176176
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
177177

178178
This installs the latest stable release of PyGMT from
@@ -233,9 +233,8 @@ Alternatively, you can install the latest development version from
233233
To upgrade the installed stable release or development version to be the latest
234234
one, just add ``--upgrade`` to the corresponding command above.
235235

236-
Any of the above methods (conda/pip) should allow you to use the PyGMT package
237-
from Python.
238-
236+
Any of the above methods (mamba/conda/pip) should allow you to use the PyGMT
237+
package from Python.
239238

240239
Testing your install
241240
--------------------
@@ -268,7 +267,7 @@ respectively.
268267
For Linux/macOS, add the following line to your shell configuration file
269268
(usually ``~/.bashrc`` for Bash on Linux and ``~/.zshrc`` for Zsh on macOS)::
270269

271-
export GMT_LIBRARY_PATH=$HOME/anaconda3/envs/pygmt/lib
270+
export GMT_LIBRARY_PATH=$HOME/mambaforge/envs/pygmt/lib
272271

273272
For Windows, add the ``GMT_LIBRARY_PATH`` environment variable following these
274273
`instructions <https://www.wikihow.com/Create-an-Environment-Variable-in-Windows-10>`__
@@ -281,10 +280,10 @@ Notes for Jupyter users
281280

282281
If you can successfully import pygmt in a Python interpreter or IPython, but
283282
get a ``ModuleNotFoundError`` when importing pygmt in Jupyter, you may need to
284-
install a ``pygmt`` kernel following the commands below::
283+
activate your ``pygmt`` virtual environment (using ``mamba activate pygmt`` or
284+
``conda activate pygmt``) and install a ``pygmt`` kernel following the commands below::
285285

286-
conda activate pygmt
287-
python -m ipykernel install --user --name pygmt # install conda environment properly
286+
python -m ipykernel install --user --name pygmt # install virtual environment properly
288287
jupyter kernelspec list --json
289288

290289
After that, you need to restart Jupyter, open your notebook, select the

0 commit comments

Comments
 (0)