Skip to content

Commit e0c3cab

Browse files
Matt-CarreTBThomas56
authored andcommitted
docs(readme): updates readme to include an index
1 parent 01611a0 commit e0c3cab

1 file changed

Lines changed: 5 additions & 0 deletions

File tree

‎README.md‎

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -16,6 +16,11 @@ Docker | `docker run ghcr.io/diamondlightsource/python-interface-to-wor
1616
Releases | <https://github.com/DiamondLightSource/python-interface-to-workflows/releases>
1717

1818

19+
# Examples
20+
What | Where
21+
:---: | :---:
22+
A basic example showing a file being mounted from a folder and a notebook running in a pod | <https://github.com/DiamondLightSource/python-interface-to-workflows/blob/main/src/python_interface_to_workflows/workflow_definitions/create_notebook_in_image.py>
23+
A more advanced example showing a visr recon workflow, converting an .nxs to a .hdf5 file. | <https://github.com/DiamondLightSource/python-interface-to-workflows/blob/main/src/python_interface_to_workflows/workflow_definitions/visr_notebook_example/visr-recon.ipynb>
1924
# Using Copier
2025
```bash
2126
mkdir new_directory_path

0 commit comments

Comments
 (0)