Skip to content

Commit 983e900

Browse files
Merge pull request #8 from bcrawford39GT/update_readmen
add interactive example to README.md
2 parents e205c0c + 2e51b11 commit 983e900

File tree

1 file changed

+6
-0
lines changed

1 file changed

+6
-0
lines changed

README.md

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -36,6 +36,12 @@ The example is located here 'examples_to_run/examples.py'. The instructions to r
3636

3737
`python examples.py`
3838

39+
### Run the interactive example in Visual Studios Code (VScode)
40+
41+
This is the same example but running it as an interactive job (i.e., like a Jupyter notebook). The example is located here 'examples_to_run/interactive_examples.py'.
42+
43+
When using Visual Studios Code (VScode), the '# %%' above each section makes it a cell, which can be run individually by holding shift and pressing enter.
44+
3945

4046
### Run the test cases using pytest
4147

0 commit comments

Comments
 (0)