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

refactor quicknd #1170

Merged
merged 48 commits into from
Apr 29, 2024
Merged

refactor quicknd #1170

merged 48 commits into from
Apr 29, 2024

Conversation

ddkohler
Copy link
Contributor

@ddkohler ddkohler commented Mar 18, 2024

This PR is the first part of a broader effort to revamp the artists module. These changes focus on reducing the redundant code within quick1D and quick2D. Before this PR, both functions had almost independent code, despite performing very similar operations. Now they are built with the same core utility (ChopHandler). ChopHandler also makes it easy to create new quick artists, either by users or potentially to be included in the artists package.

Changes

  • refactor quick1D/quick2D functions to reuse common functionalities
  • make it easy to implement different plotting functions
  • ChopHandler class: allow to be used as an iterator or as a for loop to be implemented later
  • implement context kwarg for simple style changes (and write a standard quick style file) context will be a future change

Checklist

  • added tests
  • updated documentation, if applicable
  • updated CHANGELOG.md
  • tests pass

@ddkohler ddkohler changed the title Refactor quicknd [WIP] refactor quicknd Mar 18, 2024
@ddkohler ddkohler changed the title [WIP] refactor quicknd refactor quicknd Mar 18, 2024
@ddkohler ddkohler changed the title refactor quicknd [WIP] refactor quicknd Mar 18, 2024
WrightTools/artists/_helpers.py Fixed Show fixed Hide fixed
WrightTools/artists/_helpers.py Fixed Show fixed Hide fixed
WrightTools/artists/_helpers.py Fixed Show fixed Hide fixed
ddkohler added 3 commits April 1, 2024 12:10
use existing code for label creation
@ddkohler ddkohler marked this pull request as ready for review April 10, 2024 16:14
@ddkohler ddkohler changed the title [WIP] refactor quicknd refactor quicknd Apr 10, 2024
tests/artists/test_quick2D.py Dismissed Show dismissed Hide dismissed
tests/artists/test_quick2D.py Dismissed Show dismissed Hide dismissed
@kameyer226 kameyer226 merged commit 6745f3e into master Apr 29, 2024
11 checks passed
@kameyer226 kameyer226 deleted the refactor_quicknd branch April 29, 2024 21:04
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Development

Successfully merging this pull request may close these issues.

2 participants