Quick conda install instructions in main README#1717
Conversation
Add simple PyGMT installation instructions using conda and a link to the full installation documentation page.
README.rst
Outdated
| (creates virtual environment and installs `pygmt` and required dependencies):: | ||
|
|
||
| conda create --name pygmt --channel conda-forge pygmt |
There was a problem hiding this comment.
Question: Is it better to have conda create ... here (which also creates a new virtual environment), or just use conda install instead?
There was a problem hiding this comment.
I think for the quickest install instructions we could use conda install to avoid confusion about needing to activate the virtual environment.
Co-authored-by: Dongdong Tian <seisman.info@gmail.com>
maxrjones
left a comment
There was a problem hiding this comment.
Thanks for addressing this! I'm fine with the current version, but we could also consolidate the two section headers because there are no other sections under quickstart.
| Quickstart | ||
| ---------- | ||
|
|
||
| Installation | ||
| ++++++++++++ |
There was a problem hiding this comment.
| Quickstart | |
| ---------- | |
| Installation | |
| ++++++++++++ | |
| Installation | |
| ------------ |
There was a problem hiding this comment.
Good catch. I've put in two separate section headers because I'm thinking of adding a small code snippet below the installation as suggested in pyOpenSci/software-submission#43 (comment)
- Vignette(s) demonstrating major functionality that runs successfully locally
Not provided in a textual form but linked as a tutorial video, so for me, it's ok. However, I think that the short copy & paste example below the clip could be applicable for more advanced users who would like to test the package quickly. For example, it could look like:
* Youtube lecture, * Short installation, * Copy/Paste example.
willschlitzer
left a comment
There was a problem hiding this comment.
Good addition; I would prefer if the installation instructions were at the top of the page, above the "Why PyGMT" section, but I don't think it is inconveniently far down the home page.
Pull request was converted to draft
…1717) Co-authored-by: Dongdong Tian <seisman.info@gmail.com>
Description of proposed changes
Add simple PyGMT installation instructions using conda and a link to the full installation documentation page.
Fixes #1662
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