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

Rename Euler deconvolution classes #286

Merged
merged 9 commits into from Jun 21, 2016

Conversation

Projects
None yet
1 participant
@leouieda
Member

leouieda commented Jun 20, 2016

Fixes #201

Renames the Euler deconvolution classes:

  • Classic (terrible name) is now EulerDeconv
  • MovingWindow is now EulerDeconvMW and ExpandingWindow is now EulerDeconvEW. Both classes no longer take an euler solver as input. They are subclasses of EulerDeconv and take the same parameters + the window parameters. This makes calling the functions simpler and less confusing for new users.

These names won't clash with any other module and can be made part of the fatiando.gravmag public API.

Checklist:

  • Make tests for new code (at least 80% coverage)
  • Create/update docstrings
  • Include relevant equations and citations in docstrings
  • Docstrings follow the style conventions
  • Code follows PEP8 style conventions
  • Code and docs have been spellchecked
  • Include new dependencies in doc/install.rst, requirements.txt, environment.yml, and README.rst
  • Documentation builds properly (run make docs locally)
  • Changelog entry (leave for last)

Notification for @fatiando/core-devs

leouieda added some commits Jun 20, 2016

Rename Euler deconvolution classes
The new names are EulerDeconv, EulerDeconvMW (for moving window),
EulerDeconvEW (for expanding window). These names won't clash with any
other module and can be made part of the gravmag public API.

@leouieda leouieda added this to the 0.5 milestone Jun 21, 2016

@leouieda leouieda merged commit 9c337b2 into master Jun 21, 2016

3 checks passed

continuous-integration/travis-ci/pr The Travis CI build passed
Details
continuous-integration/travis-ci/push The Travis CI build passed
Details
coverage/coveralls Coverage increased (+0.007%) to 70.439%
Details

@leouieda leouieda deleted the rename-euler branch Jun 21, 2016

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment