From 905264e8e64438eb2442fb3fa530f87600115741 Mon Sep 17 00:00:00 2001 From: Wei Ji <23487320+weiji14@users.noreply.github.com> Date: Sat, 25 Apr 2020 10:14:05 +1200 Subject: [PATCH] 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 --- README.rst | 8 +++++--- doc/install.rst | 22 +++++++++++----------- 2 files changed, 16 insertions(+), 14 deletions(-) diff --git a/README.rst b/README.rst index e97697de8ca..91f5e8cc464 100644 --- a/README.rst +++ b/README.rst @@ -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 `__. +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 diff --git a/doc/install.rst b/doc/install.rst index 8a8c65dac2a..67b803b9e5d 100644 --- a/doc/install.rst +++ b/doc/install.rst @@ -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 `__. -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 `__. +`modern execution 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 `__. Advanced users can also `build GMT from source `__ -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 `__ for more details. We recommend following the instructions further on to install GMT 6. @@ -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 `__:: - 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.