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
Show file tree
Hide file tree
Changes from 18 commits
Commits
Show all changes
24 commits
Select commit Hold shift + click to select a range
4e89311
Remove unsupported calibration notebook
talonchandler Nov 2, 2022
adebde9
Replace defunct notebooks with working scripts
talonchandler Nov 2, 2022
2b66a29
Document script workflows
talonchandler Nov 3, 2022
767f59f
Remove unused import
talonchandler Nov 3, 2022
dccceed
Improve documentation
talonchandler Nov 3, 2022
fce4e62
Delete examples/__init__.py
talonchandler Nov 3, 2022
87efe8d
TC + ZL script improvements
talonchandler Nov 4, 2022
71c4591
Remove unsupported calibration notebook
talonchandler Nov 2, 2022
403aa61
Replace defunct notebooks with working scripts
talonchandler Nov 2, 2022
869525e
Document script workflows
talonchandler Nov 3, 2022
245014a
Remove unused import
talonchandler Nov 3, 2022
cd6d519
Improve documentation
talonchandler Nov 3, 2022
5501ea6
Delete examples/__init__.py
talonchandler Nov 3, 2022
7566ce5
TC + ZL script improvements
talonchandler Nov 4, 2022
7af5af3
human-readable time stamp and open in napari
ziw-liu Nov 4, 2022
9c35edd
Merge branch 'recon-scripts' of https://github.com/mehta-lab/recOrder…
talonchandler Nov 4, 2022
ef92a34
Remove hidden characters in plugin guide
talonchandler Nov 4, 2022
5f6f0d0
Improve readability of timestamps
talonchandler Nov 4, 2022
61615c6
Fix mismatched bold
talonchandler Nov 4, 2022
5898a9a
🇺🇸 focussing -> focusing
talonchandler Nov 4, 2022
8a61133
Improve create_preset_voltage.png
talonchandler Nov 4, 2022
119c29a
Typo
talonchandler Nov 4, 2022
b947e93
Remove extra background info
talonchandler Nov 4, 2022
814b486
Remove whitespace
talonchandler Nov 4, 2022
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
6 changes: 5 additions & 1 deletion docs/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,11 @@

**I would like to install `recOrder` on my microscope:** start with the [microscope installation guide](./microscope-installation-guide.md).

**(outdated) I would like to watch an experienced user introduce `recOrder`**: [watch the tutorial](https://drive.google.com/file/d/1tHLHZ_uUnddb3jzXnQUjUiynSDS8XIy2/view?usp=sharing).
**I would like to use the `napari plugin`:** start with the [plugin guide](./napari-plugin-guide.md).

**I would like to automate my reconstructions:** start with the [reconstruction guide](./reconstruction-guide.md).

**I would like to watch an experienced user introduce `recOrder` (out of date)**: [watch the tutorial](https://drive.google.com/file/d/1tHLHZ_uUnddb3jzXnQUjUiynSDS8XIy2/view?usp=sharing).

**I would like to set up a development environment and test `recOrder`**: start with the [development guide](./development-guide.md)

Expand Down
Binary file removed docs/images/FlowChart.png
Binary file not shown.
Binary file modified docs/images/acq_finished.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file modified docs/images/connect_to_mm.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file removed docs/images/flowchart_resize.jpg
Binary file not shown.
Binary file removed docs/images/flowchart_resize.png
Binary file not shown.
Binary file modified docs/images/recOrder_Fig1_Overview.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file removed docs/images/recOrder_logo.jpg
Binary file not shown.
Binary file removed docs/images/recOrder_logo.png
Binary file not shown.
Binary file removed docs/images/recOrder_logo_web.jpg
Binary file not shown.
Binary file removed docs/images/recOrder_logo_web.png
Binary file not shown.
Binary file removed docs/images/recOrder_offline.png
Binary file not shown.
Binary file removed docs/images/reconstruct_acq.png
Binary file not shown.
Binary file removed docs/images/reconstruct_acq2.png
Binary file not shown.
Binary file removed docs/images/reconstruct_acq_general.png
Binary file not shown.
Binary file removed docs/images/reconstruct_acq_mparams.png
Binary file not shown.
Binary file removed docs/images/reconstruct_acq_reg.png
Binary file not shown.
Binary file removed docs/images/switch_online.png
Binary file not shown.
166 changes: 49 additions & 117 deletions docs/napari-plugin-guide.md

Large diffs are not rendered by default.

13 changes: 13 additions & 0 deletions docs/reconstruction-guide.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,13 @@
# Automating reconstructions

`recOrder` is undergoing changes to the way that it handles automated reconstructions.

`recOrder==0.2.0` had an offline mode with `config.yml` files that were used to configure reconstructions. These config files could be generated and saved via the GUI, and the reconstructions could be run via GUI or CLI.

Although the offline mode had many valuable and convenient features, we found that it had diverged from the online mode and it was difficult to recreate results between online and offline modes. These design limitations led us to the following plan for our upcoming releases:

`recOrder==0.3.0` (release candidate in the coming weeks) will remove the offline mode and use a set of scripts instead. We recommend modifying the reconstruction scripts in `recOrder/examples/` to recreate and automate reconstructions.

Although these scripts are not as user friendly as a GUI+CLI solution, we are preparing for a much cleaner solution in `1.0.0`, and we appreciate your patience as we go through this change. We ask users who are having any difficulty with the scripts to [open an issue](https://github.com/mehta-lab/recOrder/issues/new/choose) or [send us an email](mailto:shalin.mehta@czbiohub.org,talon.chandler@czbiohub.org).

`recOrder==1.0.0` will use a single mode to acquire and reconstruct the data. We are currently planning a refactor that will enable an "acquire once, quickly iterate your reconstruction" workflow, an "acquire now, reconstruct later" workflow, and a "live acquisition, live reconstruction" workflow, among others.
Empty file removed examples/__init__.py
Empty file.
364 changes: 0 additions & 364 deletions examples/notebooks/QLIPP_Calibration_Notebook.ipynb

This file was deleted.

195 changes: 0 additions & 195 deletions examples/notebooks/Reconstruction_PhaseFromBF.ipynb

This file was deleted.

Loading