Restructure blobfinder code for use independent of LiberTEM #14
Conversation
Thx @sk1p for the suggestion!
* Module base for code that only depends on external projects * Module common for code that depends on other LiberTEM common packages, but no core packages. * Module udf for code that depends on LiberTEM core facilities The intention is to allow code re-use without having to install all of LiberTEM, but also with a reduced number of PyPI packages. Dependencies on LiberTEM common and core will be optional features. Still TODO: * Modify setup.py accordingly * Update documentation
|
@sk1p could you review the structure before I get to work with setup.py and documentation? :-) |
Codecov Report
@@ Coverage Diff @@
## master #14 +/- ##
==========================================
+ Coverage 88.72% 95.09% +6.37%
==========================================
Files 7 9 +2
Lines 470 469 -1
Branches 36 38 +2
==========================================
+ Hits 417 446 +29
+ Misses 49 17 -32
- Partials 4 6 +2
Continue to review full report at Codecov.
|
|
Oh, almost forgot: maybe the |
Feedback @sk1p FIXME pytest --doctest-modules src/libertem-blobfinder doesn't like the duplicate correlation.py name
To make sure the folders are packages, which means files with the same name in separate folders are identified as different.
* Test case for visualize_frame * Split in several test files * Docstrings * Imports Closes LiberTEM#10
Done! We just have to keep in mind that the UDF and common parts are responsible for most of the coverage of Thx for your review! :-) Tomorrow I'll start sorting out setup.py and the documentation. |
* Move featurevector to common.patterns since it is closely related to them * Move visualize_frame to UDF folder since it depends on LiberTEM core * Complete list of imports not required since they are imported explicitly in examples now * Use UDF instead of job in test
* Extras "common" and "udf" * Some clean-up
Thx @sk1p! :-)
Using find_packages instead.
|
Perhaps I'll open a separate PR for the documentation to keep the process manageable. |
|
Btw. not sure why codecov is complaining, except for the fft fallback to np I don't see any uncovered lines in the diff... 🤷♂️ |
Closes #6
basefor code that only depends on external projectscommonfor code that depends on other LiberTEM common packages, but no core packages.udffor code that depends on LiberTEM core facilitiesThe intention is to allow code re-use without having to install all of LiberTEM, but also with
a reduced number of PyPI packages. Dependencies on LiberTEM common and core will be optional
features.
Still TODO:
Contributor Checklist: