From 02c4625cfd4b86a21b5de2d4ed0c042d780b4be7 Mon Sep 17 00:00:00 2001 From: Geoffrey Woollard Date: Fri, 24 Jun 2022 10:41:33 -0400 Subject: [PATCH] docs for paths and directories in path_config.yaml --- notebooks/tem_tutorial.ipynb | 15 ++++++++++++++- 1 file changed, 14 insertions(+), 1 deletion(-) diff --git a/notebooks/tem_tutorial.ipynb b/notebooks/tem_tutorial.ipynb index 0f1cd0e6..c1c34978 100644 --- a/notebooks/tem_tutorial.ipynb +++ b/notebooks/tem_tutorial.ipynb @@ -188,6 +188,19 @@ "sim_config = \"simSPI/sim_config.yaml\"" ] }, + { + "cell_type": "markdown", + "id": "48db9352", + "metadata": {}, + "source": [ + "Note that `path_config.yaml` contains the fields\n", + "```bash\n", + "output_dir: './simSPI/temp_workspace/output/'\n", + "local_sim_dir: '/Users/gw/software/TEM-simulator_1.3/src/TEM-simulator'\n", + "```\n", + "These paths must exist, so create them or change them to where you want the output files to go and where the local install of the TEM-simulator lives." + ] + }, { "cell_type": "markdown", "id": "bc231b9e", @@ -502,7 +515,7 @@ "name": "python", "nbconvert_exporter": "python", "pygments_lexer": "ipython3", - "version": "3.9.12" + "version": "3.9.10" } }, "nbformat": 4,