Passing in a list to 'region' in surface doesn't work #347
Labels
Comments
weiji14
changed the title
5 tasks
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
{{ message }}
weiji14
changed the title
Description of the problem
The
surfacegridding function doesn't allow passing in a python list toregion(e.g.[245, 255, 20, 30]). This is actually an oversight on my part since I wrapped the function in #245 😨.Full code that generated the error adapted from tests_surface.py
Full error message
Solution
This will be a relatively straightforward fix, and I'd be happy for someone new-ish wanting to contribute to PyGMT to submit a Pull Request (and learn from it). We can guide you through the process on how to add a Python decorator to fix the issue, and update the unit tests so that the problem won't surface 😉 again in the future.
Before you start, read up on our CONTRIBUTING.md. Also, please leave a comment below if you decide to start working on this!!
Anyhow, first part is to add a python decorator
@kwargs_to_strings(R="sequence")after@use_aliasand beforedef surfacehere:pygmt/pygmt/gridding.py
Lines 18 to 20 in cdcdf70
Make sure that you add a line to import
kwargs_to_stringnear the top ofgridding.pyfile, or it won't work!What the decorator does is to convert a list like
[245, 255, 20, 30]into a slash separated string like"245/255/20/30", the code for it which is found at here.Secondly, you'll need to edit the unit test file to capture this change at https://github.com/GenericMappingTools/pygmt/edit/master/pygmt/tests/test_surface.py. Change all the lines mentioning
region="245/255/20/30"toregion=[245, 255, 20, 30].That should be the bulk of it! Feel free to ask for help in the comments below if you encounter any issues, and good luck!
System information
conda listbelow:output of conda list
The text was updated successfully, but these errors were encountered: