Skip to content

Update PyPI install instructions and API disclaimer message - #421

Merged
weiji14 merged 4 commits into
masterfrom
pypi_install
Apr 24, 2020
Merged

Update PyPI install instructions and API disclaimer message#421
weiji14 merged 4 commits into
masterfrom
pypi_install

Conversation

@weiji14

@weiji14weiji14 commented Apr 17, 2020

Copy link
Copy Markdown
Member

Description of proposed changes

In anticipation of v0.1.0 release, we're recommending users to just pip install pygmt (from PyPI) now instead of installing from Github.

Also warning Windows users that using GMT from conda-forge won't work and suggest workarounds. Plus put a disclaimer that the API (functions and classes) can still change in future releases.

Fixes #

Reminders

  • Run make format and make check to make sure the code follows the style guide.
  • Add tests for new features or tests that would have caught the bug that you're fixing.
  • Add new public functions/methods/classes to doc/api/index.rst.
  • Write detailed docstrings for all functions/methods.
  • If adding new functionality, add an example to docstrings or tutorials.

@weiji14
Update pygmt install instructions to PyPI instead of Github
db78d8d
In anticipation of v0.1.0 release, we're recommending users to just `pip install pygmt` (from PyPI) now instead of installing from Github. Also warning Windows users that using GMT from conda-forge won't work and suggest workarounds.
@weiji14
Update disclaimer on main README to mention pygmt development status
6a96679
Tweaking the language of our disclaimer on our main page a bit for v0.1.0. Mention that API is subject to change as per semver, until we reach v1.0.0.
@weiji14weiji14 mentioned this pull request Apr 17, 2020
Closed
10 tasks
@weiji14
weiji14 requested a review from a teamApril 17, 2020 11:24
@weiji14weiji14 added this to the 0.1.0 milestone Apr 21, 2020
leouieda
leouieda approved these changes Apr 24, 2020
View reviewed changes

@leouiedaleouieda left a comment

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Only a very minor suggestion. Otherwise, this looks good to go!

Comment threadREADME.rst
Comment threaddoc/install.rst Outdated
Comment threaddoc/install.rst
Comment threaddoc/install.rst
@weiji14@leouieda
Specify that GMT >= 6.0.0 needed for PyGMT
8fcdb9d
Co-Authored-By: Leonardo Uieda <leouieda@gmail.com>
@weiji14
weiji14 merged commit 905264e into masterApr 24, 2020
@weiji14
weiji14 deleted the pypi_install branch April 24, 2020 22:14
Sign up for freeto join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

@leouiedaleouiedaleouieda approved these changes

Assignees

No one assigned

Labels

None yet

Projects

None yet

Milestone

0.1.x

Development

Successfully merging this pull request may close these issues.

2 participants

@weiji14@leouieda