Update documentation

.buildinfo

@@ -1,4 +1,4 @@
 # Sphinx build info version 1
 # This file hashes the configuration used when building these files. When it is not found, a full rebuild will be done.
-config: b9497a4d5474a1e28047f6c2a5c33ed3
+config: 83253fec17ece1dedba3a94941658e6b
 tags: 645f666f9bcd5a90fca523b33c5a78b7

README.html

@@ -400,8 +400,8 @@ <h2> Contents </h2>
 <h1>Cluster club workshop on Accelerating Scientific Code in Python<a class="headerlink" href="#cluster-club-workshop-on-accelerating-scientific-code-in-python" title="Link to this heading">#</a></h1>
 <p>This repository contains the material (notes, exercises and a challenge) for the cluster-club workshop on <em>Accelerating Scientific Code in Python</em> run by UCL-ARC.</p>
 <section id="setting-up-an-isolated-python-environment">
-<h2>Setting up an isolated python environment<a class="headerlink" href="#setting-up-an-isolated-python-environment" title="Link to this heading">#</a></h2>
-<p>We recommend to set up a separate python environment that is isolated from your system’s installation of python or any other version in your other projects. This is so that we can obtain a deterministic development environment with only the relevant python libraries and packages that are essential for this project.</p>
+<span id="setup-devenv"></span><h2>Setting up an isolated python environment<a class="headerlink" href="#setting-up-an-isolated-python-environment" title="Link to this heading">#</a></h2>
+<p>We recommend to set up a separate python environment that is isolated from your system’s installation of python or any other installation of python configured for your other projects. This is so that we can obtain a deterministic development environment with a streamlined set of relevant python libraries and packages that are essential for this project.</p>
 <p>You may use any tool to obtain a suitable python virtual environment, although the instructions here shall use <code class="docutils literal notranslate"><span class="pre">conda</span></code>.</p>
 <div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="n">conda</span> <span class="n">create</span> <span class="o">-</span><span class="n">n</span> <span class="n">condaenv_arc_clusterclub</span> <span class="n">python</span><span class="o">=</span><span class="mf">3.12</span>
 <span class="n">conda</span> <span class="n">activate</span> <span class="n">condaenv_arc_clusterclub</span>
@@ -411,8 +411,15 @@ <h2>Setting up an isolated python environment<a class="headerlink" href="#settin
 </section>
 <section id="usage">
 <h2>Usage<a class="headerlink" href="#usage" title="Link to this heading">#</a></h2>
-<p>For working on the exercises, please clone (or download) this repository and invoke the command <code class="docutils literal notranslate"><span class="pre">jupyter</span> <span class="pre">lab</span></code> session to access the computational notebooks from the relevant directory. The challenge problem at the end is to be worked on as a python script using your preferred text editor/IDE.</p>
-<p>A web version of the materials can be found online at <a class="reference external" href="https://github-pages.arc.ucl.ac.uk/cluster_club_accelerated_python/">https://github-pages.arc.ucl.ac.uk/cluster_club_accelerated_python/</a>. To view a local copy of the materials as rendered HTML pages, please clone (or download) this repository and run <code class="docutils literal notranslate"><span class="pre">jupyter</span> <span class="pre">book</span> <span class="pre">build</span> <span class="pre">.</span></code>. The static web pages shall be created in the <code class="docutils literal notranslate"><span class="pre">_build/html/</span></code> directory, and the main landing page can be accessed by opening <code class="docutils literal notranslate"><span class="pre">_build/html/index.html</span></code> in a web browser.</p>
+<p>For working on the exercises, please clone (or download) this repository and invoke the command <code class="docutils literal notranslate"><span class="pre">jupyter</span> <span class="pre">lab</span></code> to access the computational notebooks from the relevant directory. The challenge problem towards the last hour of the workshop is intended to be worked on as a python script using your preferred text editor/IDE.</p>
+<p>A web version of the materials can be found online at <a class="reference external" href="https://github-pages.arc.ucl.ac.uk/cluster_club_accelerated_python/">https://github-pages.arc.ucl.ac.uk/cluster_club_accelerated_python/</a>. To view a local copy of the materials as rendered HTML pages, please follow the steps below:</p>
+<ul class="simple">
+<li><p>clone (or download) this repository</p></li>
+<li><p>navigate to the root of the repository</p></li>
+<li><p>set up the development environment as outlined <a class="reference internal" href="#setup-devenv"><span class="std std-ref">above</span></a></p></li>
+<li><p>run <code class="docutils literal notranslate"><span class="pre">jupyter</span> <span class="pre">book</span> <span class="pre">build</span> <span class="pre">.</span></code>.</p></li>
+</ul>
+<p>The static web pages shall be created in the <code class="docutils literal notranslate"><span class="pre">_build/html/</span></code> directory, and the main landing page can be accessed by opening <code class="docutils literal notranslate"><span class="pre">_build/html/index.html</span></code> in a web browser.</p>
 </section>
 <section id="contributors">
 <h2>Contributors<a class="headerlink" href="#contributors" title="Link to this heading">#</a></h2>

_sources/README.md

@@ -2,9 +2,10 @@
 
 This repository contains the material (notes, exercises and a challenge) for the cluster-club workshop on _Accelerating Scientific Code in Python_ run by UCL-ARC.
 
+(setup-devenv)=
 ## Setting up an isolated python environment
 
-We recommend to set up a separate python environment that is isolated from your system's installation of python or any other version in your other projects. This is so that we can obtain a deterministic development environment with only the relevant python libraries and packages that are essential for this project.
+We recommend to set up a separate python environment that is isolated from your system's installation of python or any other installation of python configured for your other projects. This is so that we can obtain a deterministic development environment with a streamlined set of relevant python libraries and packages that are essential for this project.
 
 You may use any tool to obtain a suitable python virtual environment, although the instructions here shall use `conda`.
 
@@ -16,9 +17,15 @@ pip install -r requirements.txt
 
 ## Usage
 
-For working on the exercises, please clone (or download) this repository and invoke the command `jupyter lab` session to access the computational notebooks from the relevant directory. The challenge problem at the end is to be worked on as a python script using your preferred text editor/IDE.
+For working on the exercises, please clone (or download) this repository and invoke the command `jupyter lab` to access the computational notebooks from the relevant directory. The challenge problem towards the last hour of the workshop is intended to be worked on as a python script using your preferred text editor/IDE.
 
-A web version of the materials can be found online at [https://github-pages.arc.ucl.ac.uk/cluster_club_accelerated_python/](https://github-pages.arc.ucl.ac.uk/cluster_club_accelerated_python/). To view a local copy of the materials as rendered HTML pages, please clone (or download) this repository and run `jupyter book build .`. The static web pages shall be created in the `_build/html/` directory, and the main landing page can be accessed by opening `_build/html/index.html` in a web browser.
+A web version of the materials can be found online at [https://github-pages.arc.ucl.ac.uk/cluster_club_accelerated_python/](https://github-pages.arc.ucl.ac.uk/cluster_club_accelerated_python/). To view a local copy of the materials as rendered HTML pages, please follow the steps below:
+* clone (or download) this repository
+* navigate to the root of the repository
+* set up the development environment as outlined [above](setup-devenv)
+* run `jupyter book build .`.
+
+The static web pages shall be created in the `_build/html/` directory, and the main landing page can be accessed by opening `_build/html/index.html` in a web browser.
 
 ## Contributors