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

WIP: Wrap earthtide #1824

Closed
wants to merge 12 commits into from
Closed

WIP: Wrap earthtide #1824

wants to merge 12 commits into from

Conversation

willschlitzer
Copy link
Contributor

This PR wraps the module earthtide.

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 wrapping a new module, open a 'Wrap new GMT module' issue and submit reasonably-sized PRs.
  • If adding new functionality, add an example to docstrings or tutorials.

Slash Commands

You can write slash commands (/command) in the first line of a comment to perform
specific operations. Supported slash commands are:

  • /format: automatically format and lint the code
  • /test-gmt-dev: run full tests on the latest GMT development version

@willschlitzer willschlitzer added the feature Brand new feature label Mar 16, 2022
@willschlitzer willschlitzer added this to the 0.7.0 milestone Mar 16, 2022
@willschlitzer willschlitzer self-assigned this Mar 16, 2022
@willschlitzer
Copy link
Contributor Author

/format

pygmt/src/earthtide.py Outdated Show resolved Hide resolved
pygmt/src/earthtide.py Outdated Show resolved Hide resolved
pygmt/src/earthtide.py Outdated Show resolved Hide resolved
Co-authored-by: Dongdong Tian <seisman.info@gmail.com>
willschlitzer and others added 2 commits May 2, 2022 07:27
Co-authored-by: Dongdong Tian <seisman.info@gmail.com>
pygmt/src/earthtide.py Outdated Show resolved Hide resolved
Co-authored-by: Dongdong Tian <seisman.info@gmail.com>
@willschlitzer
Copy link
Contributor Author

I would like to modify this to accept datetime objects. Should I use separate variables for specifying a single time and a range of times? I'm not sure how this module is most commonly used, so I don't want to make a hacky/overly complex solution for something that isn't a common need and a text string can work instead.

@seisman
Copy link
Member

seisman commented Jun 14, 2022

I think it would be much easier to design the wrapper if you can provide some example GMT commands using earthtide.

@willschlitzer
Copy link
Contributor Author

I think it would be much easier to design the wrapper if you can provide some example GMT commands using earthtide.

Sorry, what are you asking for? As far as I can tell from the tests, I have a working version of the earthtide module that accepts string inputs.

@seisman seisman modified the milestones: 0.7.0, 0.8.0 Jun 23, 2022
@seisman seisman modified the milestones: 0.8.0, 0.9.0 Dec 11, 2022
@seisman seisman modified the milestones: 0.9.0, 0.10.0 Mar 19, 2023
@willschlitzer
Copy link
Contributor Author

Not sure what the issue is with the imports; I'm getting:

module_func.__doc__ = docstring.format(**filler_text)
KeyError: 'I'

Since there has been no movement on this for 10 months, I'm going to close the PR.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
feature Brand new feature
Projects
Wrapping GMT modules
Awaiting triage
Development

Successfully merging this pull request may close these issues.

None yet

2 participants