From a55c7f95896cec8c4eb0fbbac122a23d8aca714c Mon Sep 17 00:00:00 2001 From: Will Usher Date: Wed, 11 Nov 2020 14:05:13 +0100 Subject: [PATCH] Update readme --- README.rst | 18 ++++++++++++++++++ 1 file changed, 18 insertions(+) diff --git a/README.rst b/README.rst index fbb3afe..2703781 100644 --- a/README.rst +++ b/README.rst @@ -30,3 +30,21 @@ Lab 3: conda activate osemosys conda install nbstripout nbstripout --install + +Hints +~~~~~ + +Add a hyperlink to a file to edit by prepending `.../edit` to the relative path of the file. +For example:: + + Edit this [CSV file](../edit/model/gas/data/CapitalCost.csv) + +Link to the view of a folder by prepending `../tree` to the relative path. For example:: + + View the results [here](../tree/results) + +When using `!` to run shell commands, you can include Python variables by prepending them with a `$`. +For example:: + + my_python_variables = 'a_string' + !echo $my_python_variables | wc \ No newline at end of file