Skip to content

Commit

Permalink
clarify examples/README.md
Browse files Browse the repository at this point in the history
  • Loading branch information
talonchandler committed Dec 21, 2024
1 parent 3ae8606 commit 888e29f
Showing 1 changed file with 1 addition and 1 deletion.
2 changes: 1 addition & 1 deletion examples/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,6 +5,6 @@ Some examples require `pip install waveorder[examples]` for `napari` and `jupyte
| Folder | Requires | Description |
|------------------|----------------------------|-------------------------------------------------------------------------------------------------------|
| `models/` | `pip install waveorder[examples]` | Demonstrates the latest functionality of `waveorder` through simulations and reconstructions using various models. |
| `maintenance/` | `pip install waveorder` | Showcases functionality planned for `models/` folder; scripts are maintained with automated tests. |
| `maintenance/` | `pip install waveorder` | Examples of computational imaging methods enabled by functionality of waveorder; scripts are maintained with automated tests. |
| `visuals/` | `pip install waveorder[examples]` | Visualizations of transfer functions and Green's tensors. |
| `documentation/` | `pip install waveorder`, complete datasets | Provides examples of real-data reconstructions; serves as documentation and is not actively maintained. |

0 comments on commit 888e29f

Please sign in to comment.