Skip to content

Commit 905264e

Browse files
weiji14leouieda
andauthored
Update PyPI install instructions and API disclaimer message (#421)
In anticipation of v0.1.0 release, we're recommending users to just `pip install pygmt` (from PyPI) now instead of installing from Github. Warned Windows users that using GMT from conda-forge won't work and suggest workarounds. Also updated disclaimer on main README to mention pygmt development status. Co-Authored-By: Leonardo Uieda <leouieda@gmail.com>
1 parent a3887ab commit 905264e

File tree

2 files changed

+16
-14
lines changed

2 files changed

+16
-14
lines changed

README.rst

Lines changed: 5 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -35,10 +35,12 @@ PyGMT
3535
Disclaimer
3636
----------
3737

38-
🚨 **This package is in the early stages of design and implementation.** 🚨
38+
🚨 **This package is still undergoing rapid development.** 🚨
3939

40-
All functions/classes/interfaces are subject to change as we experiment with new design
41-
ideas and implement new features. **This is NOT a finished product.**
40+
All of the API (functions/classes/interfaces) is subject to change until we reach v1.0.0
41+
as per the `semantic versioning specification <https://semver.org/spec/v2.0.0.html>`__.
42+
There may be non-backward compatible changes as we experiment with new design ideas and
43+
implement new features. **This is not a finished product, use with caution**
4244

4345
We welcome any feedback and ideas!
4446
Let us know by submitting

doc/install.rst

Lines changed: 11 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -32,16 +32,18 @@ PyGMT requires Generic Mapping Tools (GMT) version 6 as a minimum, which is the
3232
released version that can be found at
3333
`this website <https://www.generic-mapping-tools.org>`__.
3434

35-
We need the very latest GMT since there are many changes being made to GMT itself in
35+
We need the latest GMT (>=6.0.0) since there are many changes being made to GMT itself in
3636
response to the development of PyGMT, mainly the new
37-
`modern execution mode <https://gmt.soest.hawaii.edu/projects/gmt/wiki/Modernization>`__.
37+
`modern execution mode <https://docs.generic-mapping-tools.org/latest/cookbook/introduction.html#modern-and-classic-mode>`__.
3838

39-
Compiled conda packages of GMT for Linux, Mac and Windows are provided through
39+
Compiled conda packages of GMT for Linux and Mac are provided through
4040
`conda-forge <https://anaconda.org/conda-forge/gmt>`__.
4141
Advanced users can also
4242
`build GMT from source <https://github.com/GenericMappingTools/gmt/blob/master/BUILDING.md>`__
43-
instead, which is not so recommended but we would love to get feedback from anyone who
44-
tries.
43+
instead, which is not so recommended but we would love to get feedback from anyone who tries.
44+
For Windows, conda GMT packages are available, but they do not currently work with PyGMT,
45+
so users will need to build from source or use the Windows Subsystem for Linux, see
46+
`here <https://github.com/GenericMappingTools/pygmt/pull/313>`__ for more details.
4547

4648
We recommend following the instructions further on to install GMT 6.
4749

@@ -96,15 +98,13 @@ Installing PyGMT
9698
----------------
9799

98100
Now that you have GMT installed and your conda environment activated,
99-
use ``pip`` to install the latest source of PyGMT from Github::
101+
use ``pip`` to install the latest release of PyGMT from `PyPI <https://pypi.org/project/pygmt>`__::
100102

101-
pip install https://github.com/GenericMappingTools/pygmt/archive/master.zip
103+
pip install pygmt
102104

103-
Alternatively, you can clone the git repository and install using ``pip``::
105+
Alternatively, you can install the development version from the Github repository::
104106

105-
git clone https://github.com/GenericMappingTools/pygmt.git
106-
cd pygmt
107-
pip install .
107+
pip install https://github.com/GenericMappingTools/pygmt/archive/master.zip
108108

109109
This will allow you to use the ``pygmt`` library from Python.
110110

0 commit comments

Comments
 (0)