waveorder 2.2.1__tar.gz → 3.0.0a0__tar.gz

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (198) hide show
  1. {waveorder-2.2.1 → waveorder-3.0.0a0}/.git-blame-ignore-revs +4 -0
  2. waveorder-3.0.0a0/.github/ISSUE_TEMPLATE/bug_report.md +30 -0
  3. waveorder-3.0.0a0/.github/ISSUE_TEMPLATE/documentation.md +12 -0
  4. waveorder-3.0.0a0/.github/ISSUE_TEMPLATE/feature_request.md +18 -0
  5. {waveorder-2.2.1 → waveorder-3.0.0a0}/.github/workflows/pr.yml +23 -25
  6. waveorder-3.0.0a0/.github/workflows/test.yml +45 -0
  7. {waveorder-2.2.1 → waveorder-3.0.0a0}/.gitignore +5 -1
  8. {waveorder-2.2.1 → waveorder-3.0.0a0}/.pre-commit-config.yaml +2 -3
  9. {waveorder-2.2.1 → waveorder-3.0.0a0}/CITATION.cff +1 -2
  10. {waveorder-2.2.1 → waveorder-3.0.0a0}/CONTRIBUTING.md +1 -1
  11. {waveorder-2.2.1 → waveorder-3.0.0a0}/LICENSE +1 -1
  12. waveorder-3.0.0a0/PKG-INFO +311 -0
  13. waveorder-3.0.0a0/README.md +223 -0
  14. waveorder-3.0.0a0/docs/QLIPP.md +58 -0
  15. waveorder-3.0.0a0/docs/README.md +27 -0
  16. waveorder-3.0.0a0/docs/buyers-guide.md +39 -0
  17. waveorder-3.0.0a0/docs/calibration-guide.md +64 -0
  18. waveorder-3.0.0a0/docs/data-schema.md +47 -0
  19. waveorder-3.0.0a0/docs/development-guide.md +105 -0
  20. waveorder-3.0.0a0/docs/examples/README.md +11 -0
  21. waveorder-3.0.0a0/docs/examples/configs/README.md +70 -0
  22. waveorder-3.0.0a0/docs/examples/configs/birefringence-and-phase.yml +32 -0
  23. waveorder-3.0.0a0/docs/examples/configs/birefringence.yml +16 -0
  24. waveorder-3.0.0a0/docs/examples/configs/fluorescence.yml +18 -0
  25. waveorder-3.0.0a0/docs/examples/configs/phase.yml +20 -0
  26. {waveorder-2.2.1 → waveorder-3.0.0a0/docs}/examples/maintenance/PTI_simulation/PTI_Simulation_Forward_2D3D.py +8 -3
  27. {waveorder-2.2.1 → waveorder-3.0.0a0/docs}/examples/maintenance/PTI_simulation/PTI_Simulation_Recon2D.py +8 -2
  28. {waveorder-2.2.1 → waveorder-3.0.0a0/docs}/examples/maintenance/PTI_simulation/PTI_Simulation_Recon3D.py +8 -2
  29. {waveorder-2.2.1 → waveorder-3.0.0a0/docs}/examples/maintenance/QLIPP_simulation/2D_QLIPP_forward.py +6 -1
  30. {waveorder-2.2.1 → waveorder-3.0.0a0/docs}/examples/maintenance/QLIPP_simulation/2D_QLIPP_recon.py +5 -2
  31. {waveorder-2.2.1 → waveorder-3.0.0a0/docs}/examples/models/isotropic_thin_3d.py +24 -4
  32. waveorder-3.0.0a0/docs/images/HSV_legend.png +0 -0
  33. waveorder-3.0.0a0/docs/images/JCh_Color_legend.png +0 -0
  34. waveorder-3.0.0a0/docs/images/JCh_legend.png +0 -0
  35. waveorder-3.0.0a0/docs/images/acq_finished.png +0 -0
  36. waveorder-3.0.0a0/docs/images/acquire_buttons.png +0 -0
  37. waveorder-3.0.0a0/docs/images/acquisition_settings.png +0 -0
  38. waveorder-3.0.0a0/docs/images/advanced.png +0 -0
  39. waveorder-3.0.0a0/docs/images/cap_bg.png +0 -0
  40. waveorder-3.0.0a0/docs/images/cli_structure.png +0 -0
  41. waveorder-3.0.0a0/docs/images/comms_video_screenshot.png +0 -0
  42. waveorder-3.0.0a0/docs/images/connect_to_mm.png +0 -0
  43. waveorder-3.0.0a0/docs/images/create_group.png +0 -0
  44. waveorder-3.0.0a0/docs/images/create_group_voltage.png +0 -0
  45. waveorder-3.0.0a0/docs/images/create_preset.png +0 -0
  46. waveorder-3.0.0a0/docs/images/create_preset_voltage.png +0 -0
  47. waveorder-3.0.0a0/docs/images/general_reconstruction_settings.png +0 -0
  48. waveorder-3.0.0a0/docs/images/ideal_plot.png +0 -0
  49. waveorder-3.0.0a0/docs/images/modulation.png +0 -0
  50. waveorder-3.0.0a0/docs/images/no-overlay.png +0 -0
  51. waveorder-3.0.0a0/docs/images/overlay-demo.png +0 -0
  52. waveorder-3.0.0a0/docs/images/overlay.png +0 -0
  53. waveorder-3.0.0a0/docs/images/phase_reconstruction_settings.png +0 -0
  54. waveorder-3.0.0a0/docs/images/poincare_swing.svg +535 -0
  55. waveorder-3.0.0a0/docs/images/reconstruction_birefriengence.png +0 -0
  56. waveorder-3.0.0a0/docs/images/reconstruction_data.png +0 -0
  57. waveorder-3.0.0a0/docs/images/reconstruction_data_info.png +0 -0
  58. waveorder-3.0.0a0/docs/images/reconstruction_models.png +0 -0
  59. waveorder-3.0.0a0/docs/images/reconstruction_queue.png +0 -0
  60. waveorder-3.0.0a0/docs/images/run_calib.png +0 -0
  61. waveorder-3.0.0a0/docs/images/run_port.png +0 -0
  62. waveorder-3.0.0a0/docs/images/waveorder_Fig1_Overview.png +0 -0
  63. waveorder-3.0.0a0/docs/images/waveorder_plugin_logo.png +0 -0
  64. waveorder-3.0.0a0/docs/microscope-installation-guide.md +100 -0
  65. waveorder-3.0.0a0/docs/napari-plugin-guide.md +204 -0
  66. waveorder-3.0.0a0/docs/reconstruction-guide.md +53 -0
  67. waveorder-3.0.0a0/docs/software-installation-guide.md +28 -0
  68. {waveorder-2.2.1 → waveorder-3.0.0a0}/pyproject.toml +50 -10
  69. waveorder-3.0.0a0/tests/acq_tests/test_acq.py +17 -0
  70. waveorder-3.0.0a0/tests/calibration_tests/test_calibration.py +2 -0
  71. waveorder-3.0.0a0/tests/cli_tests/test_cli.py +11 -0
  72. waveorder-3.0.0a0/tests/cli_tests/test_compute_tf.py +150 -0
  73. waveorder-3.0.0a0/tests/cli_tests/test_reconstruct.py +260 -0
  74. waveorder-3.0.0a0/tests/cli_tests/test_settings.py +127 -0
  75. waveorder-3.0.0a0/tests/conftest.py +77 -0
  76. waveorder-3.0.0a0/tests/mmcore_tests/test_core_func.py +202 -0
  77. {waveorder-2.2.1 → waveorder-3.0.0a0}/tests/test_examples.py +20 -6
  78. waveorder-3.0.0a0/tests/util_tests/test_create_empty.py +60 -0
  79. waveorder-3.0.0a0/tests/util_tests/test_io.py +72 -0
  80. waveorder-3.0.0a0/tests/util_tests/test_overlays.py +72 -0
  81. waveorder-3.0.0a0/tests/widget_tests/test_dock_widget.py +9 -0
  82. waveorder-3.0.0a0/tests/widget_tests/test_sample_contributions.py +8 -0
  83. waveorder-3.0.0a0/tox.ini +34 -0
  84. waveorder-3.0.0a0/waveorder/__init__.py +0 -0
  85. {waveorder-2.2.1 → waveorder-3.0.0a0}/waveorder/_version.py +2 -2
  86. waveorder-3.0.0a0/waveorder/acq/__init__.py +0 -0
  87. waveorder-3.0.0a0/waveorder/acq/acq_functions.py +166 -0
  88. waveorder-3.0.0a0/waveorder/acq/acquisition_workers.py +651 -0
  89. waveorder-3.0.0a0/waveorder/calib/Calibration.py +1512 -0
  90. waveorder-3.0.0a0/waveorder/calib/Optimization.py +470 -0
  91. waveorder-3.0.0a0/waveorder/calib/__init__.py +0 -0
  92. waveorder-3.0.0a0/waveorder/calib/calibration_workers.py +463 -0
  93. waveorder-3.0.0a0/waveorder/cli/apply_inverse_models.py +261 -0
  94. waveorder-3.0.0a0/waveorder/cli/apply_inverse_transfer_function.py +438 -0
  95. waveorder-3.0.0a0/waveorder/cli/compute_transfer_function.py +301 -0
  96. waveorder-3.0.0a0/waveorder/cli/gui_widget.py +57 -0
  97. waveorder-3.0.0a0/waveorder/cli/jobs_mgmt.py +206 -0
  98. waveorder-3.0.0a0/waveorder/cli/main.py +35 -0
  99. waveorder-3.0.0a0/waveorder/cli/monitor.py +163 -0
  100. waveorder-3.0.0a0/waveorder/cli/option_eat_all.py +47 -0
  101. waveorder-3.0.0a0/waveorder/cli/parsing.py +135 -0
  102. waveorder-3.0.0a0/waveorder/cli/printing.py +12 -0
  103. waveorder-3.0.0a0/waveorder/cli/reconstruct.py +72 -0
  104. waveorder-3.0.0a0/waveorder/cli/settings.py +186 -0
  105. waveorder-3.0.0a0/waveorder/cli/utils.py +105 -0
  106. {waveorder-2.2.1 → waveorder-3.0.0a0}/waveorder/focus.py +12 -3
  107. waveorder-3.0.0a0/waveorder/io/__init__.py +0 -0
  108. waveorder-3.0.0a0/waveorder/io/_reader.py +61 -0
  109. waveorder-3.0.0a0/waveorder/io/core_functions.py +272 -0
  110. waveorder-3.0.0a0/waveorder/io/metadata_reader.py +195 -0
  111. waveorder-3.0.0a0/waveorder/io/utils.py +173 -0
  112. waveorder-3.0.0a0/waveorder/io/visualization.py +157 -0
  113. {waveorder-2.2.1 → waveorder-3.0.0a0}/waveorder/models/isotropic_thin_3d.py +71 -70
  114. waveorder-3.0.0a0/waveorder/napari.yaml +36 -0
  115. waveorder-3.0.0a0/waveorder/plugin/__init__.py +9 -0
  116. waveorder-3.0.0a0/waveorder/plugin/gui.py +1695 -0
  117. waveorder-3.0.0a0/waveorder/plugin/gui.ui +2235 -0
  118. waveorder-3.0.0a0/waveorder/plugin/main_widget.py +2173 -0
  119. waveorder-3.0.0a0/waveorder/plugin/tab_recon.py +3913 -0
  120. waveorder-3.0.0a0/waveorder/scripts/__init__.py +0 -0
  121. waveorder-3.0.0a0/waveorder/scripts/launch_napari.py +13 -0
  122. waveorder-3.0.0a0/waveorder/scripts/repeat-cal-acq-rec.py +147 -0
  123. waveorder-3.0.0a0/waveorder/scripts/repeat-calibration.py +31 -0
  124. waveorder-3.0.0a0/waveorder/scripts/samples.py +85 -0
  125. waveorder-3.0.0a0/waveorder/scripts/simulate_zarr_acq.py +207 -0
  126. {waveorder-2.2.1 → waveorder-3.0.0a0}/waveorder/util.py +1 -1
  127. waveorder-3.0.0a0/waveorder.egg-info/PKG-INFO +311 -0
  128. waveorder-3.0.0a0/waveorder.egg-info/SOURCES.txt +185 -0
  129. waveorder-3.0.0a0/waveorder.egg-info/entry_points.txt +5 -0
  130. waveorder-3.0.0a0/waveorder.egg-info/requires.txt +33 -0
  131. waveorder-3.0.0a0/waveorder.egg-info/top_level.txt +5 -0
  132. waveorder-2.2.1/.github/workflows/pytests.yml +0 -48
  133. waveorder-2.2.1/PKG-INFO +0 -188
  134. waveorder-2.2.1/README.md +0 -118
  135. waveorder-2.2.1/examples/README.md +0 -10
  136. waveorder-2.2.1/examples/documentation/PTI_experiment/PTI_Experiment_Recon3D_anisotropic_target_small.pdf +0 -0
  137. waveorder-2.2.1/examples/documentation/README.md +0 -1
  138. waveorder-2.2.1/tests/conftest.py +0 -13
  139. waveorder-2.2.1/waveorder.egg-info/PKG-INFO +0 -188
  140. waveorder-2.2.1/waveorder.egg-info/SOURCES.txt +0 -84
  141. waveorder-2.2.1/waveorder.egg-info/requires.txt +0 -15
  142. waveorder-2.2.1/waveorder.egg-info/top_level.txt +0 -1
  143. {waveorder-2.2.1/tests → waveorder-3.0.0a0/docs}/__init__.py +0 -0
  144. {waveorder-2.2.1/examples/documentation → waveorder-3.0.0a0/docs/examples/deprecated}/PTI_experiment/PTI_Experiment_Recon3D_anisotropic_target_small.py +0 -0
  145. {waveorder-2.2.1/examples/documentation → waveorder-3.0.0a0/docs/examples/deprecated}/PTI_experiment/PTI_full_FOV_anisotropic_target.ipynb +0 -0
  146. {waveorder-2.2.1/examples/documentation → waveorder-3.0.0a0/docs/examples/deprecated}/PTI_experiment/PTI_full_FOV_cardiac_muscle.ipynb +0 -0
  147. {waveorder-2.2.1/examples/documentation → waveorder-3.0.0a0/docs/examples/deprecated}/PTI_experiment/PTI_full_FOV_cardiomyocyte_infected_1.ipynb +0 -0
  148. {waveorder-2.2.1/examples/documentation → waveorder-3.0.0a0/docs/examples/deprecated}/PTI_experiment/PTI_full_FOV_cardiomyocyte_infected_2.ipynb +0 -0
  149. {waveorder-2.2.1/examples/documentation → waveorder-3.0.0a0/docs/examples/deprecated}/PTI_experiment/PTI_full_FOV_cardiomyocyte_mock.ipynb +0 -0
  150. {waveorder-2.2.1/examples/documentation → waveorder-3.0.0a0/docs/examples/deprecated}/PTI_experiment/PTI_full_FOV_human_uterus.ipynb +0 -0
  151. {waveorder-2.2.1/examples/documentation → waveorder-3.0.0a0/docs/examples/deprecated}/PTI_experiment/PTI_full_FOV_mouse_brain_aco.ipynb +0 -0
  152. {waveorder-2.2.1/examples/documentation → waveorder-3.0.0a0/docs/examples/deprecated}/PTI_experiment/README.md +0 -0
  153. {waveorder-2.2.1/examples/documentation → waveorder-3.0.0a0/docs/examples/deprecated}/QLIPP_experiment/2D_QLIPP_recon_experiment.ipynb +0 -0
  154. {waveorder-2.2.1/examples/documentation → waveorder-3.0.0a0/docs/examples/deprecated}/QLIPP_experiment/3D_QLIPP_recon_experiment.ipynb +0 -0
  155. {waveorder-2.2.1/examples/documentation → waveorder-3.0.0a0/docs/examples/deprecated}/fluorescence_deconvolution/fluorescence_deconv.ipynb +0 -0
  156. {waveorder-2.2.1 → waveorder-3.0.0a0/docs}/examples/maintenance/PTI_simulation/PTI_formulation.html +0 -0
  157. {waveorder-2.2.1 → waveorder-3.0.0a0/docs}/examples/maintenance/PTI_simulation/README.md +0 -0
  158. {waveorder-2.2.1 → waveorder-3.0.0a0/docs}/examples/maintenance/README.md +0 -0
  159. {waveorder-2.2.1 → waveorder-3.0.0a0/docs}/examples/models/README.md +0 -0
  160. {waveorder-2.2.1 → waveorder-3.0.0a0/docs}/examples/models/inplane_oriented_thick_pol3d.py +0 -0
  161. {waveorder-2.2.1 → waveorder-3.0.0a0/docs}/examples/models/inplane_oriented_thick_pol3d_vector.py +0 -0
  162. {waveorder-2.2.1 → waveorder-3.0.0a0/docs}/examples/models/isotropic_fluorescent_thick_3d.py +0 -0
  163. {waveorder-2.2.1 → waveorder-3.0.0a0/docs}/examples/models/phase_thick_3d.py +0 -0
  164. {waveorder-2.2.1 → waveorder-3.0.0a0/docs}/examples/visuals/plot_greens_tensor.py +0 -0
  165. {waveorder-2.2.1 → waveorder-3.0.0a0/docs}/examples/visuals/plot_vector_transfer_function_support.py +0 -0
  166. {waveorder-2.2.1 → waveorder-3.0.0a0}/docs/valuable-prs/2023-02-27.110.pr.open.md +0 -0
  167. {waveorder-2.2.1 → waveorder-3.0.0a0}/readme.png +0 -0
  168. {waveorder-2.2.1 → waveorder-3.0.0a0}/setup.cfg +0 -0
  169. {waveorder-2.2.1/waveorder → waveorder-3.0.0a0/tests}/__init__.py +0 -0
  170. {waveorder-2.2.1 → waveorder-3.0.0a0}/tests/models/test_inplane_oriented_thick_pol3D.py +0 -0
  171. {waveorder-2.2.1 → waveorder-3.0.0a0}/tests/models/test_isotropic_fluorescent_thick_3d.py +0 -0
  172. {waveorder-2.2.1 → waveorder-3.0.0a0}/tests/models/test_isotropic_thin_3d.py +0 -0
  173. {waveorder-2.2.1 → waveorder-3.0.0a0}/tests/models/test_phase_thick_3d.py +0 -0
  174. {waveorder-2.2.1 → waveorder-3.0.0a0}/tests/test_correction.py +0 -0
  175. {waveorder-2.2.1 → waveorder-3.0.0a0}/tests/test_filter.py +0 -0
  176. {waveorder-2.2.1 → waveorder-3.0.0a0}/tests/test_focus_estimator.py +0 -0
  177. {waveorder-2.2.1 → waveorder-3.0.0a0}/tests/test_optics.py +0 -0
  178. {waveorder-2.2.1 → waveorder-3.0.0a0}/tests/test_sampling.py +0 -0
  179. {waveorder-2.2.1 → waveorder-3.0.0a0}/tests/test_stokes.py +0 -0
  180. {waveorder-2.2.1 → waveorder-3.0.0a0}/tests/test_util.py +0 -0
  181. {waveorder-2.2.1 → waveorder-3.0.0a0}/waveorder/background_estimator.py +0 -0
  182. {waveorder-2.2.1 → waveorder-3.0.0a0}/waveorder/correction.py +0 -0
  183. {waveorder-2.2.1 → waveorder-3.0.0a0}/waveorder/filter.py +0 -0
  184. {waveorder-2.2.1 → waveorder-3.0.0a0}/waveorder/models/inplane_oriented_thick_pol3d.py +0 -0
  185. {waveorder-2.2.1 → waveorder-3.0.0a0}/waveorder/models/inplane_oriented_thick_pol3d_vector.py +0 -0
  186. {waveorder-2.2.1 → waveorder-3.0.0a0}/waveorder/models/isotropic_fluorescent_thick_3d.py +0 -0
  187. {waveorder-2.2.1 → waveorder-3.0.0a0}/waveorder/models/phase_thick_3d.py +0 -0
  188. {waveorder-2.2.1 → waveorder-3.0.0a0}/waveorder/optics.py +0 -0
  189. {waveorder-2.2.1 → waveorder-3.0.0a0}/waveorder/reconstruct.py +0 -0
  190. {waveorder-2.2.1 → waveorder-3.0.0a0}/waveorder/sampling.py +0 -0
  191. {waveorder-2.2.1 → waveorder-3.0.0a0}/waveorder/stokes.py +0 -0
  192. {waveorder-2.2.1 → waveorder-3.0.0a0}/waveorder/visuals/jupyter_visuals.py +0 -0
  193. {waveorder-2.2.1 → waveorder-3.0.0a0}/waveorder/visuals/matplotlib_visuals.py +0 -0
  194. {waveorder-2.2.1 → waveorder-3.0.0a0}/waveorder/visuals/napari_visuals.py +0 -0
  195. {waveorder-2.2.1 → waveorder-3.0.0a0}/waveorder/visuals/utils.py +0 -0
  196. {waveorder-2.2.1 → waveorder-3.0.0a0}/waveorder/waveorder_reconstructor.py +0 -0
  197. {waveorder-2.2.1 → waveorder-3.0.0a0}/waveorder/waveorder_simulator.py +0 -0
  198. {waveorder-2.2.1 → waveorder-3.0.0a0}/waveorder.egg-info/dependency_links.txt +0 -0
@@ -1,4 +1,8 @@
1
1
  # .git-blame-ignore-revs
2
2
  # created as described in: https://docs.github.com/en/repositories/working-with-files/using-files/viewing-a-file#ignore-commits-in-the-blame-view
3
+
3
4
  # black-format files
4
5
  07517c3353c392106cabae003d589946ea25918a
6
+ 82f6df5ed34460374ce7c0fdca089d8caa570b9f
7
+ aa7050f973f36dc204ea495e105b5432223dc68d
8
+ a3dd7e5e9bc0bed404792e9b241f1639ade76f33
@@ -0,0 +1,30 @@
1
+ ---
2
+ name: Bug report
3
+ about: Create a report to help us improve
4
+ title: "[BUG]"
5
+ labels: ''
6
+ assignees: ''
7
+
8
+ ---
9
+
10
+ **Summary and expected behavior**
11
+
12
+ **Code for reproduction (using python script or command line interface)**
13
+ ```
14
+ # paste your code here
15
+
16
+ ```
17
+
18
+ **Screenshots or steps for reproduction (using napari GUI)**
19
+
20
+ **Include relevant logs which are created next to the output dir, name of the dataset, yaml file(s) if encountering reconstruction errors.**
21
+
22
+ **Expected behavior**
23
+ A clear and concise description of what you expected to happen.
24
+
25
+ **Environment:**
26
+
27
+ Operating system:
28
+ Python version:
29
+ Python environment (command line, IDE, Jupyter notebook, etc):
30
+ Micro-Manager/pycromanager version:
@@ -0,0 +1,12 @@
1
+ ---
2
+ name: Documentation
3
+ about: Help us improve documentation
4
+ title: "[DOC]"
5
+ labels: ''
6
+ assignees: ''
7
+
8
+ ---
9
+
10
+ **Suggested improvement**
11
+
12
+ **Optional: Pull request with better documentation**
@@ -0,0 +1,18 @@
1
+ ---
2
+ name: Feature request
3
+ about: Suggest an idea for this project
4
+ title: "[FEATURE]"
5
+ labels: ''
6
+ assignees: ''
7
+
8
+ ---
9
+
10
+ **Problem**
11
+
12
+ **Proposed solution**
13
+
14
+
15
+ **Alternatives you have considered, if any**
16
+
17
+ **Additional context**
18
+ Note relevant experimental conditions or datasets
@@ -5,8 +5,6 @@ name: lint, style, and tests
5
5
 
6
6
  on:
7
7
  pull_request:
8
- branches:
9
- - main
10
8
 
11
9
  jobs:
12
10
  style:
@@ -15,7 +13,7 @@ jobs:
15
13
 
16
14
  strategy:
17
15
  matrix:
18
- python-version: ["3.10"]
16
+ python-version: ["3.11"]
19
17
 
20
18
  steps:
21
19
  - uses: actions/checkout@v3
@@ -29,8 +27,8 @@ jobs:
29
27
  pip install black==25.1.0
30
28
  - name: Check code styling with Black
31
29
  run: |
32
- black --diff -S -t py310 waveorder
33
- black --check -S -t py310 waveorder
30
+ black --diff -S -t py311 waveorder
31
+ black --check -S -t py311 waveorder
34
32
 
35
33
  # lint:
36
34
  # name: Lint Check
@@ -38,7 +36,7 @@ jobs:
38
36
 
39
37
  # strategy:
40
38
  # matrix:
41
- # python-version: ["3.10"]
39
+ # python-version: ["3.11"]
42
40
 
43
41
  # steps:
44
42
  # - uses: actions/checkout@v3
@@ -61,7 +59,7 @@ jobs:
61
59
 
62
60
  strategy:
63
61
  matrix:
64
- python-version: ["3.10"]
62
+ python-version: ["3.11"]
65
63
 
66
64
  steps:
67
65
  - uses: actions/checkout@v3
@@ -77,25 +75,25 @@ jobs:
77
75
  run: |
78
76
  isort --check waveorder
79
77
 
80
- tests:
81
- needs: [style, isort] # lint
82
- runs-on: ubuntu-latest
83
- strategy:
84
- matrix:
85
- python-version: ["3.10", "3.11", "3.12"]
78
+ # needs: [style, isort] # lint
79
+ # runs-on: ubuntu-latest
80
+ # strategy:
81
+ # matrix:
82
+ # python-version: ["3.11", "3.12", "3.13"]
86
83
 
87
- steps:
88
- - uses: actions/checkout@v3
84
+ # steps:
85
+ # - uses: actions/checkout@v3
89
86
 
90
- - uses: actions/setup-python@v4
91
- with:
92
- python-version: ${{ matrix.python-version }}
87
+ # - uses: actions/setup-python@v4
88
+ # with:
89
+ # python-version: ${{ matrix.python-version }}
93
90
 
94
- - name: Install dependencies
95
- run: |
96
- python -m pip install --upgrade pip
97
- pip install ".[dev]"
91
+ # - name: Install dependencies
92
+ # run: |
93
+ # python -m pip install --upgrade pip
94
+ # pip install ".[all,dev]"
98
95
 
99
- - name: Test with pytest
100
- run: |
101
- pytest -v --cov=./ --cov-report=xml
96
+ # - name: Test with pytest
97
+ # run: |
98
+ # pytest -v
99
+ # pytest -v --cov=./ --cov-report=xml
@@ -0,0 +1,45 @@
1
+ name: test
2
+
3
+ on: [push]
4
+
5
+ jobs:
6
+ test:
7
+ name: ${{ matrix.platform }} py${{ matrix.python-version }}
8
+ runs-on: ${{ matrix.platform }}
9
+ strategy:
10
+ matrix:
11
+ platform: [ubuntu-latest, windows-latest, macos-latest]
12
+ python-version: ["3.11", "3.12", "3.13"]
13
+
14
+ steps:
15
+ - name: Checkout repo
16
+ uses: actions/checkout@v3
17
+
18
+ - name: Set up Python ${{ matrix.python-version }}
19
+ uses: actions/setup-python@v4
20
+ with:
21
+ python-version: ${{ matrix.python-version }}
22
+
23
+ # these libraries enable testing on Qt on linux
24
+ - uses: tlambert03/setup-qt-libs@v1
25
+
26
+ # strategy borrowed from vispy for installing opengl libs on windows
27
+ - name: Install Windows OpenGL
28
+ if: runner.os == 'Windows'
29
+ run: |
30
+ git clone --depth 1 https://github.com/pyvista/gl-ci-helpers.git
31
+ powershell gl-ci-helpers/appveyor/install_opengl.ps1
32
+
33
+ - name: Install dependencies
34
+ run: |
35
+ python -m pip install --upgrade pip
36
+ python -m pip install setuptools tox tox-gh-actions
37
+
38
+ # https://github.com/napari/cookiecutter-napari-plugin/commit/cb9a8c152b68473e8beabf44e7ab11fc46483b5d
39
+ - name: Test
40
+ uses: aganders3/headless-gui@v1
41
+ with:
42
+ run: python -m tox
43
+
44
+ - name: Coverage
45
+ uses: codecov/codecov-action@v3
@@ -143,7 +143,7 @@ dmypy.json
143
143
 
144
144
  # written by setuptools_scm
145
145
  */_version.py
146
- recOrder/_version.py
146
+ waveorder/_version.py
147
147
  *.autosave
148
148
 
149
149
  # images
@@ -151,3 +151,7 @@ recOrder/_version.py
151
151
  *.png
152
152
  *.tif[f]
153
153
  *.pdf
154
+
155
+ # example data
156
+ /examples/data_temp/*
157
+ /logs/*
@@ -1,4 +1,3 @@
1
-
2
1
  repos:
3
2
  # basic pre-commit
4
3
  - repo: https://github.com/pre-commit/pre-commit-hooks
@@ -26,9 +25,9 @@ repos:
26
25
  # rev: 6.0.0
27
26
  # hooks:
28
27
  # - id: flake8
29
- # args: [--ignore, "E203,W503", --min-python-version, '3.10']
28
+ # args: [--ignore, "E203,W503", --min-python-version, '3.11']
30
29
  # additional_dependencies: [flake8-typing-imports==1.12.0]
31
30
  - repo: https://github.com/psf/black
32
31
  rev: 25.1.0
33
32
  hooks:
34
- - id: black
33
+ - id: black
@@ -43,8 +43,7 @@ identifiers:
43
43
  - type: url
44
44
  value: 'https://www.napari-hub.org/plugins/recOrder-napari'
45
45
  description: >-
46
- recOrder-napari plugin for label-free imaging that
47
- depends on waveOrder library
46
+ waveorder plugin for label-free imaging (TODO: update URL)
48
47
  - type: doi
49
48
  value: 10.1364/BOE.455770
50
49
  description: >-
@@ -26,7 +26,7 @@ and Python with an environment management tool
26
26
  If you use Conda, set up an environment with:
27
27
 
28
28
  ```sh
29
- conda create -n waveorder-dev python=3.10
29
+ conda create -n waveorder-dev python=3.12
30
30
  conda activate waveorder-dev
31
31
  ```
32
32
 
@@ -1,6 +1,6 @@
1
1
  BSD 3-Clause License
2
2
 
3
- Copyright (c) 2019, Chan Zuckerberg Biohub
3
+ Copyright (c) 2025, Chan Zuckerberg Biohub
4
4
 
5
5
  Redistribution and use in source and binary forms, with or without
6
6
  modification, are permitted provided that the following conditions are met:
@@ -0,0 +1,311 @@
1
+ Metadata-Version: 2.4
2
+ Name: waveorder
3
+ Version: 3.0.0a0
4
+ Summary: Wave-optical simulations and deconvolution of optical properties
5
+ Author-email: CZ Biohub SF <compmicro@czbiohub.org>
6
+ Maintainer-email: Talon Chandler <talon.chandler@czbiohub.org>, Shalin Mehta <shalin.mehta@czbiohub.org>
7
+ License: BSD 3-Clause License
8
+
9
+ Copyright (c) 2025, Chan Zuckerberg Biohub
10
+
11
+ Redistribution and use in source and binary forms, with or without
12
+ modification, are permitted provided that the following conditions are met:
13
+
14
+ 1. Redistributions of source code must retain the above copyright notice, this
15
+ list of conditions and the following disclaimer.
16
+
17
+ 2. Redistributions in binary form must reproduce the above copyright notice,
18
+ this list of conditions and the following disclaimer in the documentation
19
+ and/or other materials provided with the distribution.
20
+
21
+ 3. Neither the name of the copyright holder nor the names of its
22
+ contributors may be used to endorse or promote products derived from
23
+ this software without specific prior written permission.
24
+
25
+ THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
26
+ AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
27
+ IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
28
+ DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE
29
+ FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
30
+ DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
31
+ SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER
32
+ CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
33
+ OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
34
+ OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
35
+
36
+ Project-URL: Homepage, https://github.com/mehta-lab/waveorder
37
+ Project-URL: Repository, https://github.com/mehta-lab/waveorder
38
+ Project-URL: Issues, https://github.com/mehta-lab/waveorder/issues
39
+ Keywords: simulation,optics,phase,scattering,polarization,label-free,permittivity,reconstruction-algorithm,qlipp,mipolscope,permittivity-tensor-imaging
40
+ Classifier: Development Status :: 4 - Beta
41
+ Classifier: Intended Audience :: Science/Research
42
+ Classifier: License :: OSI Approved :: BSD License
43
+ Classifier: Programming Language :: Python :: 3
44
+ Classifier: Programming Language :: Python :: 3.11
45
+ Classifier: Programming Language :: Python :: 3.12
46
+ Classifier: Programming Language :: Python :: 3.13
47
+ Classifier: Topic :: Scientific/Engineering
48
+ Classifier: Topic :: Scientific/Engineering :: Image Processing
49
+ Classifier: Topic :: Scientific/Engineering :: Bio-Informatics
50
+ Classifier: Operating System :: POSIX :: Linux
51
+ Classifier: Operating System :: Microsoft :: Windows
52
+ Classifier: Operating System :: MacOS
53
+ Requires-Python: >=3.11
54
+ Description-Content-Type: text/markdown
55
+ License-File: LICENSE
56
+ Requires-Dist: click>=8.0.1
57
+ Requires-Dist: colorspacious>=1.1.2
58
+ Requires-Dist: importlib-metadata
59
+ Requires-Dist: iohub<0.3,>=0.2
60
+ Requires-Dist: ipywidgets>=7.5.1
61
+ Requires-Dist: matplotlib>=3.1.1
62
+ Requires-Dist: natsort>=7.1.1
63
+ Requires-Dist: numpy>=1.24
64
+ Requires-Dist: psutil
65
+ Requires-Dist: pyqtgraph>=0.12.3
66
+ Requires-Dist: pydantic
67
+ Requires-Dist: pywavelets>=1.1.1
68
+ Requires-Dist: scipy>=1.3.0
69
+ Requires-Dist: submitit
70
+ Requires-Dist: torch>=2.4.1
71
+ Requires-Dist: qtpy
72
+ Requires-Dist: wget>=3.2
73
+ Provides-Extra: all
74
+ Requires-Dist: napari[pyqt6]; extra == "all"
75
+ Requires-Dist: napari-ome-zarr>=0.3.2; extra == "all"
76
+ Requires-Dist: pycromanager==0.27.2; extra == "all"
77
+ Requires-Dist: jupyter; extra == "all"
78
+ Provides-Extra: dev
79
+ Requires-Dist: black==25.1.0; extra == "dev"
80
+ Requires-Dist: click>=8.2.0; extra == "dev"
81
+ Requires-Dist: hypothesis; extra == "dev"
82
+ Requires-Dist: pre-commit; extra == "dev"
83
+ Requires-Dist: pytest-cov; extra == "dev"
84
+ Requires-Dist: pytest-qt; extra == "dev"
85
+ Requires-Dist: pytest>=5.0.0; extra == "dev"
86
+ Requires-Dist: tox; extra == "dev"
87
+ Dynamic: license-file
88
+
89
+ <p align="center">
90
+ <img src="https://github.com/user-attachments/assets/1b4fabd4-2ead-40fa-ae88-99642a1589f1" alt="Image" width="50%">
91
+ </p>
92
+
93
+ [![Python package index](https://img.shields.io/pypi/v/waveorder.svg)](https://pypi.org/project/waveorder)
94
+ [![PyPI monthly downloads](https://img.shields.io/pypi/dm/waveorder.svg)](https://pypistats.org/packages/waveorder)
95
+ [![Total downloads](https://pepy.tech/badge/waveorder)](https://pepy.tech/project/waveorder)
96
+ [![GitHub contributors](https://img.shields.io/github/contributors-anon/mehta-lab/waveorder)](https://github.com/mehta-lab/waveorder/graphs/contributors)
97
+ ![GitHub Repo stars](https://img.shields.io/github/stars/mehta-lab/waveorder)
98
+ ![GitHub forks](https://img.shields.io/github/forks/mehta-lab/waveorder)
99
+ ![PyPI - Python Version](https://img.shields.io/pypi/pyversions/waveorder)
100
+
101
+ Label-agnostic computational microscopy of architectural order.
102
+
103
+ # Overview
104
+
105
+ `waveorder` is a generalist framework for label-agnostic computational microscopy of architectural order, i.e., density, alignment, and orientation of biomolecules with the spatial resolution down to the diffraction limit. The framework implements wave-optical simulations and corresponding reconstruction algorithms for diverse label-free and fluorescence computational imaging methods that enable quantitative imaging of the architecture of dynamic cell systems.
106
+
107
+ Our goal is to enable modular and user-friendly implementations of computational microscopy methods for dynamic imaging across the scales of organelles, cells, and tissues.
108
+
109
+
110
+ The framework is described in the following [preprint](https://arxiv.org/abs/2412.09775).
111
+
112
+ https://github.com/user-attachments/assets/4f9969e5-94ce-4e08-9f30-68314a905db6
113
+
114
+ <details>
115
+ `waveorder` enables simulations and reconstructions of label-agnostic microscopy data as described in the following [preprint](https://arxiv.org/abs/2412.09775)
116
+ <summary> Chandler et al. 2024 </summary>
117
+ <pre><code>
118
+ @article{chandler_2024,
119
+ author = {Chandler, Talon and Hirata-Miyasaki, Eduardo and Ivanov, Ivan E. and Liu, Ziwen and Sundarraman, Deepika and Ryan, Allyson Quinn and Jacobo, Adrian and Balla, Keir and Mehta, Shalin B.},
120
+ title = {waveOrder: generalist framework for label-agnostic computational microscopy},
121
+ journal = {arXiv},
122
+ year = {2024},
123
+ month = dec,
124
+ eprint = {2412.09775},
125
+ doi = {10.48550/arXiv.2412.09775}
126
+ }
127
+ </code></pre>
128
+ </details>
129
+
130
+ # Computational Microscopy Methods
131
+
132
+ `waveorder` framework enables simulations and reconstructions of data for diverse one-photon (single-scattering based) computational microscopy methods, summarized below.
133
+
134
+ ## Label-free microscopy
135
+
136
+ ### Quantitative label-free imaging with phase and polarization (QLIPP)
137
+
138
+ Acquisition, calibration, background correction, reconstruction, and applications of QLIPP are described in the following [E-Life Paper](https://elifesciences.org/articles/55502):
139
+
140
+ [![Unveiling the invisible](https://github.com/mehta-lab/recOrder/blob/main/docs/images/comms_video_screenshot.png?raw=true)](https://www.youtube.com/watch?v=JEZAaPeZhck)
141
+
142
+ <details>
143
+ <summary> Guo et al. 2020 </summary>
144
+ <pre><code>
145
+ @article{guo_2020,
146
+ author = {Guo, Syuan-Ming and Yeh, Li-Hao and Folkesson, Jenny and Ivanov, Ivan E. and Krishnan, Anitha P. and Keefe, Matthew G. and Hashemi, Ezzat and Shin, David and Chhun, Bryant B. and Cho, Nathan H. and Leonetti, Manuel D. and Han, May H. and Nowakowski, Tomasz J. and Mehta, Shalin B.},
147
+ title = {Revealing architectural order with quantitative label-free imaging and deep learning},
148
+ journal = {eLife},
149
+ volume = {9},
150
+ pages = {e55502},
151
+ year = {2020},
152
+ doi = {10.7554/eLife.55502}
153
+ }
154
+ </code></pre>
155
+ </details>
156
+
157
+ ### Permittivity tensor imaging (PTI)
158
+
159
+ PTI provides volumetric reconstructions of mean permittivity ($\propto$ material density), differential permittivity ($\propto$ material anisotropy), 3D orientation, and optic sign. The following figure summarizes PTI acquisition and reconstruction with a small optical section of the mouse brain tissue:
160
+
161
+ ![Data_flow](https://github.com/mehta-lab/waveorder/blob/main/readme.png?raw=true)
162
+
163
+ The acquisition, calibration, background correction, reconstruction, and applications of PTI are described in the following [paper](https://doi.org/10.1101/2020.12.15.422951) published in Nature Methods:
164
+
165
+ <details>
166
+ <summary> Yeh et al. 2024 </summary>
167
+ <pre><code>
168
+ @article{yeh_2024,
169
+ author = {Yeh, Li-Hao and Ivanov, Ivan E. and Chandler, Talon and Byrum, Janie R. and Chhun, Bryant B. and Guo, Syuan-Ming and Foltz, Cameron and Hashemi, Ezzat and Perez-Bermejo, Juan A. and Wang, Huijun and Yu, Yanhao and Kazansky, Peter G. and Conklin, Bruce R. and Han, May H. and Mehta, Shalin B.},
170
+ title = {Permittivity tensor imaging: modular label-free imaging of 3D dry mass and 3D orientation at high resolution},
171
+ journal = {Nature Methods},
172
+ volume = {21},
173
+ number = {7},
174
+ pages = {1257--1274},
175
+ year = {2024},
176
+ month = jul,
177
+ issn = {1548-7105},
178
+ publisher = {Nature Publishing Group},
179
+ doi = {10.1038/s41592-024-02291-w}
180
+ }
181
+ </code></pre>
182
+ </details>
183
+
184
+
185
+ ### Quantitative phase imaging (QPI) from defocus
186
+ __phase__ from a volumetric brightfield acquisition ([2D phase](https://www.osapublishing.org/ao/abstract.cfm?uri=ao-54-28-8566)/[3D phase](https://www.osapublishing.org/ao/abstract.cfm?uri=ao-57-1-a205))
187
+
188
+ ![Image](https://github.com/user-attachments/assets/caf7714b-59ee-40bb-9ee4-f13db4feece6)
189
+
190
+
191
+ <details>
192
+ <summary> Jenkins and Gaylord 2015 (2D QPI from defocus) </summary>
193
+ <pre><code>
194
+ @article{Jenkins:15,
195
+ author = {Micah H. Jenkins and Thomas K. Gaylord},
196
+ journal = {Appl. Opt.},
197
+ keywords = {Phase retrieval; Partial coherence in imaging; Interferometric imaging ; Imaging systems; Microlens arrays; Optical transfer functions; Phase contrast; Spatial resolution; Three dimensional imaging},
198
+ number = {28},
199
+ pages = {8566--8579},
200
+ publisher = {Optica Publishing Group},
201
+ title = {Quantitative phase microscopy via optimized inversion of the phase optical transfer function},
202
+ volume = {54},
203
+ month = {Oct},
204
+ year = {2015},
205
+ url = {https://opg.optica.org/ao/abstract.cfm?URI=ao-54-28-8566},
206
+ doi = {10.1364/AO.54.008566},
207
+ }
208
+ </code></pre>
209
+ </details>
210
+
211
+ <details>
212
+ <summary> Soto, Rodrigo, and Alieva 2018 (3D QPI from defocus) </summary>
213
+ <pre><code>
214
+ @article{Soto:18,
215
+ author = {Juan M. Soto and Jos\'{e} A. Rodrigo and Tatiana Alieva},
216
+ journal = {Appl. Opt.},
217
+ keywords = {Coherence and statistical optics; Image reconstruction techniques; Optical transfer functions; Optical inspection; Three-dimensional microscopy; Acoustooptic modulators; Illumination design; Inverse design; LED sources; Three dimensional imaging; Three dimensional reconstruction},
218
+ number = {1},
219
+ pages = {A205--A214},
220
+ publisher = {Optica Publishing Group},
221
+ title = {Optical diffraction tomography with fully and partially coherent illumination in high numerical aperture label-free microscopy \[Invited\]},
222
+ volume = {57},
223
+ month = {Jan},
224
+ year = {2018},
225
+ url = {https://opg.optica.org/ao/abstract.cfm?URI=ao-57-1-A205},
226
+ doi = {10.1364/AO.57.00A205},
227
+ }
228
+ </code></pre>
229
+ </details>
230
+
231
+ ### QPI with differential phase contrast
232
+ __phase__ from differential phase contrast
233
+
234
+ ***Work in progress***
235
+
236
+ * [2D](https://www.osapublishing.org/oe/fulltext.cfm?uri=oe-23-9-11394&id=315599) DPC
237
+ * [3D](https://www.osapublishing.org/boe/fulltext.cfm?uri=boe-7-10-3940&id=349951) DPC
238
+
239
+
240
+ ## Fluorescence microscopy
241
+
242
+ ### Widefield deconvolution microscopy
243
+ __fluorescence density__ from a widefield volumetric fluorescence acquisition.
244
+
245
+ <details>
246
+ <summary> Swedlow 2013 </summary>
247
+ <pre><code>
248
+ @article{Swedlow:13,
249
+ author = {Swedlow, John R.},
250
+ journal = {Methods Cell Biol.},
251
+ title = {Quantitative fluorescence microscopy and image deconvolution},
252
+ year = {2013},
253
+ volume = {114},
254
+ pages = {407--26},
255
+ doi = {10.1016/B978-0-12-407761-4.00017-8}
256
+ }
257
+ </code></pre>
258
+ </details>
259
+
260
+ ### Oblique plane light-sheet microscopy
261
+ __fluorescence density__ from oblique plane light-sheet microscopy.
262
+
263
+ <details>
264
+ <summary> Ivanov, Hirata-Miyasaki, Chandler et al. 2024 </summary>
265
+ <pre><code>
266
+ @article{ivanov_2024,
267
+ author = {Ivanov, Ivan E. and Hirata-Miyasaki, Eduardo and Chandler, Talon and Cheloor-Kovilakam, Rasmi and Liu, Ziwen and Pradeep, Soorya and Liu, Chad and Bhave, Madhura and Khadka, Sudip and Arias, Carolina and Leonetti, Manuel D. and Huang, Bo and Mehta, Shalin B.},
268
+ title = {Mantis: High-throughput 4D imaging and analysis of the molecular and physical architecture of cells},
269
+ journal = {PNAS Nexus},
270
+ volume = {3},
271
+ number = {9},
272
+ pages = {pgae323},
273
+ year = {2024},
274
+ doi = {10.1093/pnasnexus/pgae323}
275
+ </code></pre>
276
+ </details>
277
+
278
+
279
+ ## Citation
280
+
281
+ Please cite this repository, along with the relevant publications and preprints, if you use or adapt this code. The citation information can be found by clicking "Cite this repository" button in the About section in the right sidebar.
282
+
283
+ ## Installation
284
+
285
+ Create a virtual environment:
286
+
287
+ ```sh
288
+ conda create -y -n waveorder python=3.12
289
+ conda activate waveorder
290
+ ```
291
+
292
+ Install `waveorder` from PyPI:
293
+
294
+ ```sh
295
+ pip install waveorder
296
+ ```
297
+
298
+ (Optional) Install all visualization dependencies (napari, jupyter), clone the repository, and run an example script:
299
+ ```sh
300
+ pip install "waveorder[all]"
301
+ git clone https://github.com/mehta-lab/waveorder.git
302
+ python waveorder/examples/models/phase_thick_3d.py
303
+ ```
304
+
305
+ (M1 users) `pytorch` has [incomplete GPU support](https://github.com/pytorch/pytorch/issues/77764),
306
+ so please use `export PYTORCH_ENABLE_MPS_FALLBACK=1`
307
+ to allow some operators to fallback to CPU if you plan to use GPU acceleration for polarization reconstruction.
308
+
309
+
310
+ ## Examples
311
+ The [examples](https://github.com/mehta-lab/waveorder/tree/main/docs/examples) illustrate simulations and reconstruction for 2D QLIPP, 3D phase from brightfield, and 2D/3D PTI methods.