Commit 98088333 authored by Matt Clarkson's avatar Matt Clarkson

Issue #45: Tidy up notebook instructions.

parent 75852010
{
"cells": [],
"metadata": {},
"nbformat": 4,
"nbformat_minor": 2
}
......@@ -6,18 +6,39 @@
"source": [
"# First notebook\n",
"\n",
"You can write up experiments in notebooks, and they automatically get generated into Sphinx docs, for example on readthedocs.\n",
"You can write up experiments in notebooks, and they can be generated into Sphinx docs using ```tox -e docs```, and for example set up to run on readthedocs.\n",
"\n",
"See [this](https://scikit-surgerytf.readthedocs.io/en/latest/notebooks/tutorial_reusable_code_design.html) and [this](https://scikit-surgerytf.readthedocs.io/en/latest/notebooks/tutorial_reusable_code_example.html) examples."
"See [this](https://scikit-surgerytf.readthedocs.io/en/latest/notebooks/tutorial_reusable_code_design.html) and [this](https://scikit-surgerytf.readthedocs.io/en/latest/notebooks/tutorial_reusable_code_example.html) examples.\n",
"\n",
"## NOTE:\n",
"\n",
"Getting jupyter to run your code in this package relies on 3 things:\n",
"\n",
"* You must ensure you start jupyter within the tox environment.\n",
"\n",
"```\n",
"# If not already done.\n",
"source .tox/py36/bin/activate\n",
"\n",
"# Then launch jupyter\n",
"jupyter notebook\n",
"```\n",
" \n",
"* Then when you navigate to and run this notebook, select the right kernel (named after your project) from the kernel menu item, in the web browser.\n",
"\n",
"* Add project folder to system path, as below."
]
},
{
"cell_type": "code",
"execution_count": null,
"execution_count": 1,
"metadata": {},
"outputs": [],
"source": [
"# To get code from this project to run."
"# Jupyter notebook sets the cwd to the folder containing the notebook.\n",
"# So, you want to add the root of the project to the sys path, so modules load correctly.\n",
"import sys\n",
"sys.path.append(\"../../\")"
]
}
],
......
Markdown is supported
0% or
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment