Skip to content

Commit 55af9b6

Browse files
authored
Bump minimum required GMT from 6.0.0rc5 to 6.0.0 (#363)
Set minimum required GMT in our continuous integration scripts and configuration files to use GMT 6.0.0 from the main conda-forge channel. Remove references to conda-forge/label/dev channel and replace gitter with Discourse forum link in some obvious places.
1 parent 55de8d5 commit 55af9b6

9 files changed

+25
-31
lines changed

.azure-pipelines.yml

+1-3
Original file line numberDiff line numberDiff line change
@@ -76,8 +76,7 @@ jobs:
7676
variables:
7777
CONDA_REQUIREMENTS: requirements.txt
7878
CONDA_REQUIREMENTS_DEV: requirements-dev.txt
79-
CONDA_INSTALL_EXTRA: "codecov gmt=6.0.0rc5"
80-
CONDA_EXTRA_CHANNEL: "conda-forge/label/dev"
79+
CONDA_INSTALL_EXTRA: "codecov gmt=6.0.0"
8180

8281
strategy:
8382
matrix:
@@ -162,7 +161,6 @@ jobs:
162161
CONDA_REQUIREMENTS: requirements.txt
163162
CONDA_REQUIREMENTS_DEV: requirements-dev.txt
164163
CONDA_INSTALL_EXTRA: "codecov"
165-
CONDA_EXTRA_CHANNEL: "conda-forge/label/dev"
166164

167165
strategy:
168166
matrix:

.travis.yml

+1-3
Original file line numberDiff line numberDiff line change
@@ -26,9 +26,7 @@ env:
2626
# The file with the listed requirements to be installed by conda
2727
- CONDA_REQUIREMENTS=requirements.txt
2828
- CONDA_REQUIREMENTS_DEV=requirements-dev.txt
29-
- CONDA_INSTALL_EXTRA="codecov twine gmt=6.0.0rc5"
30-
# Enable the development channel so we can get GMT 6.0.0 before it's released
31-
- CONDA_EXTRA_CHANNEL=conda-forge/label/dev
29+
- CONDA_INSTALL_EXTRA="codecov twine gmt=6.0.0"
3230
# These variables control which actions are performed in a build
3331
- DEPLOY=false
3432

CONTRIBUTING.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -64,7 +64,7 @@ read it carefully.
6464
## How Can I Talk to You?
6565

6666
Discussion often happens in the issues and pull requests.
67-
In addition, there is a [Gitter chatroom](https://gitter.im/GenericMappingTools/pygmt)
67+
In addition, there is a [Discourse forum](https://forum.generic-mapping-tools.org)
6868
for the project where you can ask questions.
6969

7070

README.rst

+10-8
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,8 @@ PyGMT
44
A Python interface for the Generic Mapping Tools
55

66
`Documentation (development version) <https://www.pygmt.org/dev>`__ |
7-
`Contact <https://gitter.im/GenericMappingTools/pygmt>`__
7+
`Contact <https://gitter.im/GenericMappingTools/pygmt>`__ |
8+
`Forum <https://forum.generic-mapping-tools.org>`__ `
89

910
.. image:: http://img.shields.io/pypi/v/pygmt.svg?style=flat-square
1011
:alt: Latest version on PyPI
@@ -27,6 +28,9 @@ PyGMT
2728
.. image:: https://img.shields.io/gitter/room/GenericMappingTools/pygmt.svg?style=flat-square
2829
:alt: Chat room on Gitter
2930
:target: https://gitter.im/GenericMappingTools/pygmt
31+
.. image:: https://img.shields.io/discourse/status?label=forum&server=https%3A%2F%2Fforum.generic-mapping-tools.org%2F&style=flat-square
32+
:alt: Discourse forum
33+
:target: https://forum.generic-mapping-tools.org
3034

3135

3236
.. placeholder-for-doc-index
@@ -43,8 +47,7 @@ ideas and implement new features. **This is NOT a finished product.**
4347
We welcome any feedback and ideas!
4448
Let us know by submitting
4549
`issues on Github <https://github.com/GenericMappingTools/pygmt/issues>`__
46-
or send us a message on our
47-
`Gitter chatroom <https://gitter.im/GenericMappingTools/pygmt>`__.
50+
or by posting on our `Discourse forum <https://forum.generic-mapping-tools.org>`__.
4851

4952
About
5053
-----
@@ -54,10 +57,9 @@ publication quality maps and figures. It provides a Pythonic interface for the
5457
`Generic Mapping Tools (GMT) <https://github.com/GenericMappingTools/gmt>`__, a
5558
command-line program widely used in the Earth Sciences.
5659

57-
We rely heavily on new features currently being implemented in GMT. In particular, a new
58-
*modern execution mode* that greatly simplifies figure creation. **These features are
59-
not available in the 5.4 version of GMT**. They will be part of the future 6.0 release
60-
of GMT predicted for early 2019.
60+
We rely heavily on new features that have been implemented in GMT 6.0. In particular,
61+
a new *modern execution mode* that greatly simplifies figure creation. **These features
62+
are not available in the 5.4 version of GMT**.
6163

6264

6365
Project goals
@@ -78,7 +80,7 @@ Contacting Us
7880
<https://github.com/GenericMappingTools/pygmt>`__. Feel free to `open an issue
7981
<https://github.com/GenericMappingTools/pygmt/issues/new>`__ or comment on any
8082
open issue or pull request.
81-
* We have a `chat room on Gitter <https://gitter.im/GenericMappingTools/pygmt>`__
83+
* We have a `Discourse forum <https://forum.generic-mapping-tools.org>`__
8284
where you can ask questions and leave comments.
8385
* This project is released with a `Contributor Code of Conduct
8486
<https://github.com/GenericMappingTools/pygmt/blob/master/CODE_OF_CONDUCT.md>`__.

doc/install.rst

+8-11
Original file line numberDiff line numberDiff line change
@@ -10,8 +10,7 @@ Installing
1010
We welcome any feedback and ideas!
1111
Let us know by submitting
1212
`issues on Github <https://github.com/GenericMappingTools/pygmt/issues>`__
13-
or send us a message on our
14-
`Gitter chatroom <https://gitter.im/GenericMappingTools/pygmt>`__.
13+
or by posting on our `Discourse forum <https://forum.generic-mapping-tools.org>`__.
1514

1615

1716
Which Python?
@@ -29,16 +28,15 @@ doesn't interfere with any other Python installations in your system.
2928
Which GMT?
3029
----------
3130

32-
PyGMT requires GMT 6 as a minimum, which you can find the latest development version
33-
at `this GitHub repository <https://github.com/GenericMappingTools/gmt>`__.
31+
PyGMT requires Generic Mapping Tools (GMT) version 6 as a minimum, which is the latest
32+
released version that can be found at
33+
`this website <https://www.generic-mapping-tools.org>`__.
3434

3535
We need the very latest GMT since there are many changes being made to GMT itself in
3636
response to the development of PyGMT, mainly the new
3737
`modern execution mode <https://gmt.soest.hawaii.edu/projects/gmt/wiki/Modernization>`__.
3838

39-
**GMT 6 has not been officially released yet**, but will be soon!
40-
In the meantime, GMT does provide compiled conda packages of their development version
41-
for Linux, Mac and Windows through
39+
Compiled conda packages of GMT for Linux, Mac and Windows are provided through
4240
`conda-forge <https://anaconda.org/conda-forge/gmt>`__.
4341
Advanced users can also
4442
`build GMT from source <https://github.com/GenericMappingTools/gmt/blob/master/BUILDING.md>`__
@@ -72,15 +70,14 @@ We recommend working in an isolated
7270
to avoid issues with competing versions of its dependencies.
7371

7472
First, we must configure conda to get packages from the
75-
`conda-forge channel <https://conda-forge.org/>`__ (the order is important)::
73+
`conda-forge channel <https://conda-forge.org/>`__::
7674

77-
conda config --prepend channels conda-forge/label/dev
7875
conda config --prepend channels conda-forge
7976

8077
Now we can create a new conda environment with Python and all our dependencies installed
8178
(we'll call it ``pygmt`` but you can change it to whatever you want)::
8279

83-
conda create --name pygmt python=3.6 pip numpy pandas xarray packaging gmt=6.0.0rc*
80+
conda create --name pygmt python=3.6 pip numpy pandas xarray packaging gmt=6.0.0
8481

8582
Activate the environment by running::
8683

@@ -139,5 +136,5 @@ You can tell PyGMT exactly where to look for ``libgmt`` by setting the
139136
This should be set to the directory where ``libgmt.so``, ``libgmt.dylib`` or ``gmt.dll``
140137
can be found for Linux, MacOS and Windows respectively.
141138
e.g. in a terminal run::
142-
139+
143140
export GMT_LIBRARY_PATH=$HOME/anaconda3/envs/pygmt/lib

environment.yml

-1
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,6 @@ name: pygmt
22
channels:
33
- conda-forge
44
- defaults
5-
- conda-forge/label/dev
65
dependencies:
76
- python=3.7
87
- pip

package.json

+1-1
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
{
22
"scripts": {
33
"build:miniconda": "curl -o ~/miniconda.sh https://repo.continuum.io/miniconda/Miniconda3-latest-Linux-x86_64.sh && bash ~/miniconda.sh -b -p $HOME/miniconda",
4-
"build:pygmt": "conda env create -f environment.yml && source activate pygmt && conda install -c conda-forge -c conda-forge/label/dev -y gmt==6.0.0rc5 && make install",
4+
"build:pygmt": "conda env create -f environment.yml && source activate pygmt && conda install -c conda-forge -y gmt==6.0.0 && make install",
55
"build:docs": "source activate pygmt && cd doc && make all && mv _build/html ../public",
66
"build": "export PATH=$HOME/miniconda/bin:$PATH && npm run build:miniconda && npm run build:pygmt && npm run build:docs"
77
}

pygmt/clib/session.py

+2-2
Original file line numberDiff line numberDiff line change
@@ -73,7 +73,7 @@ class Session:
7373
library in the directory specified by it.
7474
7575
A ``GMTVersionError`` exception will be raised if the GMT shared library reports a
76-
version < 6.0.0rc5.
76+
version < 6.0.0.
7777
7878
The ``session_pointer`` attribute holds a ctypes pointer to the currently open
7979
session.
@@ -111,7 +111,7 @@ class Session:
111111
"""
112112

113113
# The minimum version of GMT required
114-
required_version = "6.0.0rc5"
114+
required_version = "6.0.0"
115115

116116
@property
117117
def session_pointer(self):

pygmt/tests/test_clib.py

+1-1
Original file line numberDiff line numberDiff line change
@@ -791,7 +791,7 @@ def test_get_default():
791791
with clib.Session() as lib:
792792
assert lib.get_default("API_GRID_LAYOUT") in ["rows", "columns"]
793793
assert int(lib.get_default("API_CORES")) >= 1
794-
assert Version(lib.get_default("API_VERSION")) >= Version("6.0.0rc5")
794+
assert Version(lib.get_default("API_VERSION")) >= Version("6.0.0")
795795

796796

797797
def test_get_default_fails():

0 commit comments

Comments
 (0)