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

Pass scratch directory to underlying unwrapper #39

Merged
merged 1 commit into from
Oct 10, 2023

Conversation

gmgunter
Copy link
Member

tophu.multiscale_unwrap() may be passed the path of a scratch directory in which to put its intermediate outputs. Previously, it did not communicate this to the underlying unwrap callback functor, though, so the unwrapper would just put its scratch outputs in the default temporary directory.

This is undesirable because:

  • The user may want control over where all scratch outputs are written in order to avoid writing to drives with low bandwidth or low available disk space.
  • The user may want intermediate outputs to persist in a known location after unwrapping for debugging purposes.

This update causes the scratch directory location to be propagated to the underlying unwrapper in order to address this issue.

`tophu.multiscale_unwrap()` may be passed the path of a scratch
directory in which to put its intermediate outputs. Previously, it did
not communicate this to the underlying unwrap callback functor, though,
so the unwrapper would just put its scratch outputs in the default
temporary directory.

This is undesirable because:

* The user may want control over where all scratch outputs are written
  in order to avoid writing to drives with low bandwidth or low
  available disk space.
* The user may want intermediate outputs to persist in a known location
  after unwrapping for debugging purposes.

This update causes the scratch directory location to be propagated to
the underlying unwrapper in order to address this issue.
@gmgunter gmgunter added this to the v0.2 milestone Oct 10, 2023
@codecov
Copy link

codecov bot commented Oct 10, 2023

Codecov Report

Merging #39 (095fd02) into main (66df96f) will decrease coverage by 0.01%.
The diff coverage is 100.00%.

@@            Coverage Diff             @@
##             main      #39      +/-   ##
==========================================
- Coverage   97.86%   97.86%   -0.01%     
==========================================
  Files           9        9              
  Lines         797      796       -1     
==========================================
- Hits          780      779       -1     
  Misses         17       17              
Files Coverage Δ
src/tophu/_multiscale.py 96.49% <100.00%> (+0.12%) ⬆️
src/tophu/_unwrap.py 98.68% <100.00%> (-0.05%) ⬇️

📣 We’re building smart automated test selection to slash your CI/CD build times. Learn more

@gmgunter gmgunter merged commit 66ebd64 into isce-framework:main Oct 10, 2023
@gmgunter gmgunter deleted the scratchdir branch October 10, 2023 01:38
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

1 participant