Skip to content

Commit

Permalink
Update PyPI install instructions and API disclaimer message (#421)
Browse files Browse the repository at this point in the history
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>
  • Loading branch information
weiji14 and leouieda committed Apr 24, 2020
1 parent a3887ab commit 905264e
Show file tree
Hide file tree
Showing 2 changed files with 16 additions and 14 deletions.
8 changes: 5 additions & 3 deletions README.rst
Original file line number Diff line number Diff line change
Expand Up @@ -35,10 +35,12 @@ PyGMT
Disclaimer
----------

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

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

We welcome any feedback and ideas!
Let us know by submitting
Expand Down
22 changes: 11 additions & 11 deletions doc/install.rst
Original file line number Diff line number Diff line change
Expand Up @@ -32,16 +32,18 @@ PyGMT requires Generic Mapping Tools (GMT) version 6 as a minimum, which is the
released version that can be found at
`this website <https://www.generic-mapping-tools.org>`__.

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

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

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

Expand Down Expand Up @@ -96,15 +98,13 @@ Installing PyGMT
----------------

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

pip install https://github.com/GenericMappingTools/pygmt/archive/master.zip
pip install pygmt

Alternatively, you can clone the git repository and install using ``pip``::
Alternatively, you can install the development version from the Github repository::

git clone https://github.com/GenericMappingTools/pygmt.git
cd pygmt
pip install .
pip install https://github.com/GenericMappingTools/pygmt/archive/master.zip

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

Expand Down

0 comments on commit 905264e

Please sign in to comment.