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.

Sign up for GitHub

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

Quick conda install instructions in main README #1717

Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
b2a3abe
Quick conda install instructions in main README
weiji14 Feb 2, 2022
ff304f1
Change from conda create to conda install
weiji14 Feb 4, 2022
08e5e5d
Update README.rst
weiji14 Feb 4, 2022
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
13 changes: 13 additions & 0 deletions README.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -77,6 +77,19 @@ Project goals
``xarray.DataArray`` for grids.


Quickstart
----------

Installation
++++++++++++
Comment on lines +80 to +84
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 😄


Simple installation using `conda <https://docs.conda.io/projects/conda/en/latest/user-guide/index.html>`__::

conda install --channel conda-forge pygmt

For other ways to install ``pygmt``, see `full installation instructions <https://www.pygmt.org/latest/install.html>`__.


Contacting Us
-------------

Expand Down