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

Reconstruction scripts w/ documentation #249

Merged
merged 24 commits into from
Nov 4, 2022
Merged

Reconstruction scripts w/ documentation #249

merged 24 commits into from
Nov 4, 2022

Conversation

talonchandler
Copy link
Collaborator

This PR reinstates a minimal set of example reconstruction scripts that users can modify for "QLIPP" and "PhaseFromBF" reconstructions. These scripts serve as a stopgap between 0.2.0's "Offline Mode" and 1.0.0's plan for a single autogenerated reconstruction mode.

This PR also includes improved documentation for the plugin and the status of automated reconstructions (see the new /docs/reconstruction-guide.md).

I will leave this as a draft, test on hummingbird tomorrow, and request review soon afterwards.

@talonchandler talonchandler marked this pull request as draft November 3, 2022 01:10
@talonchandler talonchandler self-assigned this Nov 3, 2022
@talonchandler talonchandler added this to the 0.3.0 milestone Nov 3, 2022
@codecov-commenter
Copy link

codecov-commenter commented Nov 3, 2022

Codecov Report

Merging #249 (814b486) into main (e05974a) will decrease coverage by 0.02%.
The diff coverage is 0.00%.

@@           Coverage Diff            @@
##            main    #249      +/-   ##
========================================
- Coverage   4.39%   4.37%   -0.03%     
========================================
  Files         22      22              
  Lines       4958    4986      +28     
========================================
  Hits         218     218              
- Misses      4740    4768      +28     
Impacted Files Coverage Δ
recOrder/compute/qlipp_compute.py 0.00% <0.00%> (ø)
recOrder/plugin/gui.py 0.00% <0.00%> (ø)
recOrder/plugin/main_widget.py 0.00% <0.00%> (ø)
recOrder/acq/acquisition_workers.py 0.00% <0.00%> (ø)

Help us with your feedback. Take ten seconds to tell us how you rate us. Have a feature suggestion? Share it here.

@deprecated-napari-hub-preview-bot
Copy link

deprecated-napari-hub-preview-bot bot commented Nov 3, 2022

Preview page for your plugin is ready here:
https://preview.napari-hub.org/mehta-lab/recOrder/249
Updated: 2022-11-04T21:52:39.795855

docs/napari-plugin-guide.md Outdated Show resolved Hide resolved
@ziw-liu
Copy link
Contributor

ziw-liu commented Nov 3, 2022

Linking #230.

@ziw-liu
Copy link
Contributor

ziw-liu commented Nov 3, 2022

Since we are making a 100% diff change to ./examples, maybe it's time to remove the now obsolete ./examples/__init__.py? The new scripts are only supposed to be run 'as is' or copy-paste-modified, and does not define any importable object.

@ziw-liu
Copy link
Contributor

ziw-liu commented Nov 4, 2022

This PR may also fix #242.

@ziw-liu ziw-liu added documentation Improvements or additions to documentation work-around labels Nov 4, 2022
@talonchandler talonchandler marked this pull request as ready for review November 4, 2022 20:04
docs/napari-plugin-guide.md Outdated Show resolved Hide resolved
docs/napari-plugin-guide.md Outdated Show resolved Hide resolved
docs/napari-plugin-guide.md Outdated Show resolved Hide resolved
docs/napari-plugin-guide.md Outdated Show resolved Hide resolved
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation work-around
Projects
None yet
Development

Successfully merging this pull request may close these issues.

0.2.0's offline mode has dropped support for mixed-channel reconstructions
3 participants