Add instructions to upgrade installed PyGMT version#1029
Add instructions to upgrade installed PyGMT version#1029seisman merged 18 commits intoGenericMappingTools:masterfrom
Conversation
|
Would it be possible to move the update steps into its own dedicated section? The |
I agree that this subsection is too long to read. I think we can remove "pip install from github": because it works the same as "pip install from TestPyPI" (it's different, but is the same for users): As for upgrading PyGMT, instead of showing the long commands, I think we can simply say something like:
|
|
Some other suggestions: Line 32: should add a comma after Line 43:
Is the above sentence correct? Should we change "to installing and testing" to "to install and test"? Line 92:
I think we should recommend Jupyter or JupyterLab, not IPython. |
done in 49165b1. |
Remove "pip install from GitHub" done in 4580e0d.
Simplify PyGMT update by pip in d5b4ed9. |
Actually, we mention IPython in many places (e.g., https://www.pygmt.org/dev/tutorials/first-figure.html). I agree that it's better to recommend JupyterLab. @weiji14 how do you think? |
Should we also differentiate between Jupyter notebooks and JupyterLab? Currently, a lot of people still work with notebooks without using them in JupyterLab. |
Shall we just recommend Jupyter, so the GMT user may choose which of JupyterLab or Jupyter Notebook they prefer? |
|
Here is what I understand about the chaos:
I think we should:
However, please note that, after we finish and merge #529, we will remove the notes from all tutorials, because |
|
BTW, I don't think our main users are Python newbies, as we use many high-level packages like numpy and pandas in the documentation. I expect that our users at least have some basic knowledge about Python, numpy, pandas, and also should have their own preferences about Jupyter Notebook or JupytereLab. |
seisman
left a comment
There was a problem hiding this comment.
Looks good to me.
Ping @michaelgrund @willschlitzer @weiji14 for comments and approval.
michaelgrund
left a comment
There was a problem hiding this comment.
Execpt the minor suggestion I provided, the PR looks fine for me.
| or from PyGMT's `GitHub repository <https://github.com/GenericMappingTools/pygmt>`__ | ||
| (slower as it downloads the whole archive):: | ||
|
|
||
| pip install git+https://github.com/GenericMappingTools/pygmt.git#egg=pygmt |
There was a problem hiding this comment.
Just double checking that we really want to remove this install option?
There was a problem hiding this comment.
For most users, it's the same as
pip install --pre --index-url https://test.pypi.org/simple/ --extra-index-url https://pypi.org/simple pygmt
but slower.
I don't see any reasons to keep it.
There was a problem hiding this comment.
Ok, fine with removing it. I just think the pip install git+https option is nice when you want to install from a GitHub branch (but that's not what we're doing here).
…ols#1029) Co-authored-by: Michael Grund <michael_grund@gmx.de> Co-authored-by: Dongdong Tian <seisman.info@gmail.com> Co-authored-by: Wei Ji <23487320+weiji14@users.noreply.github.com>
Description of proposed changes
Add how to update PyGMT stable and dev version and some tiny improvements.
Fixes #
Reminders
make formatandmake checkto make sure the code follows the style guide.doc/api/index.rst.Slash Commands
You can write slash commands (
/command) in the first line of a comment to performspecific operations. Supported slash commands are:
/format: automatically format and lint the code/test-gmt-dev: run full tests on the latest GMT development version