Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Quick conda install instructions in main README #1717

Merged
merged 3 commits into from
Feb 8, 2022
Merged

Conversation

weiji14
Copy link
Member

@weiji14 weiji14 commented Feb 2, 2022

Description of proposed changes

Add simple PyGMT installation instructions using conda and a link to the full installation documentation page.

Fixes #1662

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 wrapping a new module, open a 'Wrap new GMT module' issue and submit reasonably-sized PRs.
  • If adding new functionality, add an example to docstrings or tutorials.

Slash Commands

You can write slash commands (/command) in the first line of a comment to perform
specific operations. Supported slash commands are:

  • /format: automatically format and lint the code
  • /test-gmt-dev: run full tests on the latest GMT development version

Add simple PyGMT installation instructions using conda
and a link to the full installation documentation page.
@weiji14 weiji14 added the documentation Improvements or additions to documentation label Feb 2, 2022
@weiji14 weiji14 added this to the 0.6.0 milestone Feb 2, 2022
README.rst Outdated
Comment on lines 87 to 89
(creates virtual environment and installs `pygmt` and required dependencies)::

conda create --name pygmt --channel conda-forge pygmt
Copy link
Member Author

Choose a reason for hiding this comment

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

Question: Is it better to have conda create ... here (which also creates a new virtual environment), or just use conda install instead?

Copy link
Member

Choose a reason for hiding this comment

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

I think for the quickest install instructions we could use conda install to avoid confusion about needing to activate the virtual environment.

README.rst Outdated Show resolved Hide resolved
Co-authored-by: Dongdong Tian <[email protected]>
@weiji14 weiji14 added the final review call This PR requires final review and approval from a second reviewer label Feb 4, 2022
Copy link
Member

@maxrjones maxrjones left a comment

Choose a reason for hiding this comment

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

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.

Comment on lines +80 to +84
Quickstart
----------

Installation
++++++++++++
Copy link
Member

Choose a reason for hiding this comment

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

Suggested change
Quickstart
----------
Installation
++++++++++++
Installation
------------

Copy link
Member Author

Choose a reason for hiding this comment

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

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.

Copy link
Member

Choose a reason for hiding this comment

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

Sounds good, nice planning 😄

@seisman seisman marked this pull request as ready for review February 5, 2022 05:13
@weiji14 weiji14 enabled auto-merge (squash) February 5, 2022 12:44
Copy link
Contributor

@willschlitzer willschlitzer left a comment

Choose a reason for hiding this comment

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

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.

@weiji14 weiji14 marked this pull request as draft February 7, 2022 18:08
auto-merge was automatically disabled February 7, 2022 18:08

Pull request was converted to draft

@weiji14 weiji14 marked this pull request as ready for review February 7, 2022 18:08
@seisman seisman merged commit acf546e into main Feb 8, 2022
@seisman seisman deleted the readme/quickinstall branch February 8, 2022 11:40
@seisman seisman removed the final review call This PR requires final review and approval from a second reviewer label Feb 8, 2022
sixy6e pushed a commit to sixy6e/pygmt that referenced this pull request Dec 21, 2022
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Quickinstall in the README?
4 participants