Skip to content

Update install instructions #430

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

Jump to bottom
Merged
merged 16 commits into from
May 21, 2020
Merged

Update install instructions #430

merged 16 commits into from
May 21, 2020

Conversation

seisman
Copy link
Member

@seisman seisman commented May 17, 2020 •
edited
Loading

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 weiji14 and leouieda May 17, 2020 05:50
@weiji14 weiji14 mentioned this pull request May 17, 2020
Closed
5 tasks
@seisman seisman mentioned this pull request May 17, 2020
Closed
@seisman seisman changed the title Add conda install instructions WIP: Add conda install instructions May 19, 2020
@seisman
Copy link
Member Author

seisman commented May 19, 2020

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

@weiji14 weiji14 added this to the 0.1.x milestone May 20, 2020
@vercel vercel bot temporarily deployed to Preview May 21, 2020 03:48 Inactive
@seisman seisman changed the title WIP: Add conda install instructions WIP: Update install instructions May 21, 2020
@vercel vercel bot temporarily deployed to Preview May 21, 2020 03:50 Inactive
@seisman seisman changed the title WIP: Update install instructions Update install instructions May 21, 2020
weiji14
weiji14 reviewed May 21, 2020
View reviewed changes
Copy link
Member

@weiji14 weiji14 left a comment

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.

@vercel vercel bot temporarily deployed to Preview May 21, 2020 04:39 Inactive
seisman
seisman commented May 21, 2020
View reviewed changes
seisman
seisman commented May 21, 2020
View reviewed changes
@vercel vercel bot temporarily deployed to Preview May 21, 2020 05:09 Inactive
@seisman seisman requested a review from weiji14 May 21, 2020 05:22
@seisman seisman added the documentation Improvements or additions to documentation label May 21, 2020
@seisman seisman merged commit c44205b into master May 21, 2020
@seisman seisman deleted the conda-install branch May 21, 2020 05:46
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@weiji14 weiji14 weiji14 approved these changes

@leouieda leouieda Awaiting requested review from leouieda

Assignees
No one assigned
Labels
documentation Improvements 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