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

Add common alias cores (x) for grdimage and other multi-threaded modules #625

Merged
merged 2 commits into from
Sep 21, 2020

Conversation

weiji14
Copy link
Member

@weiji14 weiji14 commented Sep 20, 2020

Description of proposed changes

Used for setting the number of cores to be used in any OpenMP-enabled multi-threaded algorithms. E.g. for functions like grdimage, x2sys_solve (not yet available on PyGMT) and others. See also https://docs.generic-mapping-tools.org/6.1/cookbook/options.html#selecting-number-of-cpu-cores-the-x-option.

Note that the cores name follow upstream GMT's long option name convention at https://github.com/GenericMappingTools/gmt/blob/88421f9f8fe9759692302905268f4036b287adcb/src/gmt_init.c#L414

Related to #620.

Fixes #

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.

@weiji14 weiji14 added the documentation Improvements or additions to documentation label Sep 20, 2020
@seisman seisman added this to the 0.2.1 milestone Sep 21, 2020
@weiji14 weiji14 changed the title Add common alias cores (x) for grdimage and other OpenMP-enabled multi-threaded modules Add common alias cores (x) for grdimage and other multi-threaded modules Sep 21, 2020
@weiji14 weiji14 merged commit 9e0a868 into master Sep 21, 2020
@weiji14 weiji14 deleted the common-aliases/cores branch September 21, 2020 00:34
@weiji14 weiji14 mentioned this pull request Sep 21, 2020
24 tasks
@weiji14 weiji14 mentioned this pull request Sep 30, 2020
5 tasks
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.

2 participants