Skip to content

Commit

Permalink
add note to README in examples (#3014)
Browse files Browse the repository at this point in the history
  • Loading branch information
geograham authored Feb 12, 2024
1 parent 0966511 commit f914551
Showing 1 changed file with 12 additions and 0 deletions.
12 changes: 12 additions & 0 deletions examples/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -32,6 +32,18 @@ You should see a bunch of files, which correspond to what's in your bluemira dir

You can stop the Jupyter server by double-pressing `ctrl+c` in your terminal.

## Running Notebooks in Jupyter Notebook v7.x (nb7)

Previous versions of Jupyter Notebook (a.k.a nb classic) will open python scripts and markdown documents as notebooks by default. From v7 onwards, to open and run a text notebook (.py or .md extension) as a notebook in Jupyter:
- right-click on the file,
- select "Notebook" in the drop down menu.

Alternatively, you can change the default viewer to "Jupytext Notebook" if you would like particular file types to open as a notebook by default via a double click. This can be set via the command line, e.g., for .py and .md files, using:

```bash
jupytext-config set-default-viewer python markdown
```

## Maintaining the examples

To add a new example, or to edit an existing one, make your changes in an `.ex.py` file.
Expand Down

0 comments on commit f914551

Please sign in to comment.