mehta-lab / waveorder

Wave optical models and inverse algorithms for label-agnostic imaging of density & orientation.
BSD 3-Clause "New" or "Revised" License
12 stars 3 forks source link

PTI example jupyter notebook to script and .html #160

Closed talonchandler closed 3 months ago

talonchandler commented 4 months ago

This PR moves the PTI spoke-pattern data example from a jupyter notebook to a script and a static .html file.

This PR also includes several suggestions from @mattersoflight to match the names to the most recent PTI submission:

Some other TODOs/questions:

talonchandler commented 4 months ago

One disadvantage of the .html file is that github doesn't render it, and there doesn't seem to be an easy way to open it in another tab. For comparison here's a saved .pdf of the .html file.
PTI_Experiment_Recon3D_anisotropic_target_small.pdf

ziw-liu commented 4 months ago

GitHub doesn't render it because it's too large. But we can link to a third party one e.g. https://html-preview.github.io/?url=https://github.com/mehta-lab/waveorder/blob/a93fd512c6d66cb1b4bd8b983b288195cbb67fe5/examples/documentation/PTI_experiment/PTI_Experiment_Recon3D_anisotropic_target_small.html

mattersoflight commented 4 months ago

@talonchandler @ziw-liu thanks! Are you using vscode's Jupyter extension for PDF export? Does it require TexLive in the backend?

image

I get the following PDF after running two cells. test.pdf

I will be able to do the proper review of the script tomorrow and can export a more complete PDF in the process. @ziw-liu's solution of rendering via https://html-preview.github.io/ also works. We can link the HTML in the README via that service.

talonchandler commented 4 months ago

Aha, thanks. I got jupyter nbconvert (what vscode's convert uses) to run (I needed conda install pandoc) and the pdf looks good. I think I prefer the pdf over the html, so I updated to the pdf.

talonchandler commented 3 months ago

Thanks Shalin:

Screenshot 2024-03-11 at 5 57 27 PM
talonchandler commented 3 months ago

P.S. I tested that all of the cells run...only thing that needs to change is the path to the data.

talonchandler commented 3 months ago

Thanks for the fixes! Merging and releasing now.