Skip to content

Update install instructions - #430

Merged
seisman merged 16 commits into
masterfrom
conda-install
May 21, 2020
Merged

Update install instructions#430
seisman merged 16 commits into
masterfrom
conda-install

Conversation

@seisman

@seismanseisman commented May 17, 2020•
edited
Loading

Copy link
Copy Markdown
Member

Description of proposed changes

  • Add conda install instructions
  • PyGMT now works well with GMT on Windows
  • Fixes a few documentation issues.
  • List netcdf4 as a dependency

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.

seisman added 2 commits May 17, 2020 01:34
@seisman
List netCDF4 as a pygmt dependency
970bdb4
xarray needs the netCDF4 package for reading (perhaps also writing) netCDF files.
However, netCDF4 isn't installed by default since it's an optional
dependency of xarray. Although pygmt doesn't import netCDF4 package
explicitely, some features won't work without the package.
See #239 for past discussions.
@seisman
Add conda install instructions
73f43ec
Use conda to install pygmt:
conda install pygmt
@seisman
seisman requested review from leouieda and weiji14May 17, 2020 05:50
@weiji14weiji14 mentioned this pull request May 17, 2020
Closed
5 tasks
@seismanseisman mentioned this pull request May 17, 2020
Closed
@seismanseisman changed the title Add conda install instructionsWIP: Add conda install instructionsMay 19, 2020
@seisman

seisman commented May 19, 2020

Copy link
Copy Markdown
MemberAuthor

Put it to WIP. Will improve it after #434 is merged.

@weiji14weiji14 added this to the 0.1.x milestone May 20, 2020
@vercel
vercelBot temporarily deployed to Preview May 21, 2020 03:48 Inactive
@seismanseisman changed the title WIP: Add conda install instructionsWIP: Update install instructionsMay 21, 2020
@vercel
vercelBot temporarily deployed to Preview May 21, 2020 03:50 Inactive
@seismanseisman changed the title WIP: Update install instructionsUpdate install instructionsMay 21, 2020
weiji14
weiji14 reviewed May 21, 2020
View reviewed changes

@weiji14weiji14 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.

Looks nice. Just one minor suggestion on setting the GMT_LIBRARY_PATH (for those who might not go the conda route.

Comment threaddoc/install.rst Outdated
seismanand others added 2 commits May 21, 2020 00:37
@seisman
Merge branch 'master' into depend-netcdf4
2e442ad
@seisman@weiji14
Set GMT_LIBRARY_PATH
b376c62
Co-authored-by: Wei Ji <23487320+weiji14@users.noreply.github.com>
@vercel
vercelBot temporarily deployed to Preview May 21, 2020 04:39 Inactive
seisman
seisman commented May 21, 2020
View reviewed changes
Comment threaddoc/install.rst Outdated
seisman
seisman commented May 21, 2020
View reviewed changes
Comment threaddoc/install.rst Outdated
@vercel
vercelBot temporarily deployed to Preview May 21, 2020 05:09 Inactive
@seisman
seisman requested a review from weiji14May 21, 2020 05:22
@seismanseisman added the documentation Improvements or additions to documentation label May 21, 2020
@seisman
seisman merged commit c44205b into masterMay 21, 2020
@seisman
seisman deleted the conda-install branch May 21, 2020 05:46
Sign up for freeto join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

@weiji14weiji14weiji14 approved these changes
@leouiedaleouiedaAwaiting requested review from leouieda

Assignees

No one assigned

Labels

documentationImprovements or additions to documentation

Projects

None yet

Milestone

0.1.x

Development

Successfully merging this pull request may close these issues.

2 participants

@seisman@weiji14