deploy: 1e8d87e

_sources/start.rst.txt

@@ -3,15 +3,27 @@ Getting Started
 
 Note: Ensure you have local modules enabled such that you have python 3.x installed in your local environment.
 
-Step 1 is to create a virtual environment and install the necessary packages with pip.
+Step 0: Git clone the repository
+--------------------------------
+The Kerchunk builder will soon be updated to version 1.0.1, which you can clone using:
+
+::
+    git clone [email protected]:cedadev/kerchunk-builder.git --branch v1.0.1
+::
+Step 1: Set up Virtual Environment
+----------------------------------
+
+Step 1 is to create a virtual environment and install the necessary packages with pip. This can be done inside the local repo you've cloned as ```local``` or ```build_venv``` which will be ignored by the repository, or you can create a venv elsewhere in your home directory i.e ```~/venvs/build_venv```
 
 ::
     python -m venv name_of_venv;
     source name_of_venv/bin/activate;
     pip install -r requirements.txt;
 ::
 
-Step 2: create a config file to set necessary environment variables. (Suggested to place these in a local `templates/` folder as this will be ignored by git). Eg:
+Step 2: Environment configuration
+---------------------------------
+Create a config file to set necessary environment variables. (Suggested to place these in a local `templates/` folder as this will be ignored by git). Eg:
 
 ::
     export WORKDIR=/gws/nopw/j04/cmip6_prep_vol1/kerchunk-pipeline;

index.html

@@ -97,7 +97,11 @@ <h1>Welcome to the Kerchunk Pipeline documentation!<a class="headerlink" href="#
 <div class="toctree-wrapper compound">
 <p class="caption" role="heading"><span class="caption-text">Contents:</span></p>
 <ul>
-<li class="toctree-l1"><a class="reference internal" href="start.html">Getting Started</a></li>
+<li class="toctree-l1"><a class="reference internal" href="start.html">Getting Started</a><ul>
+<li class="toctree-l2"><a class="reference internal" href="start.html#step-0-git-clone-the-repository">Step 0: Git clone the repository</a></li>
+<li class="toctree-l2"><a class="reference internal" href="start.html#step-2-environment-configuration">Step 2: Environment configuration</a></li>
+</ul>
+</li>
 <li class="toctree-l1"><a class="reference internal" href="execution.html">Running the Pipeline</a><ul>
 <li class="toctree-l2"><a class="reference internal" href="execution.html#running-for-a-single-dataset">Running for a single dataset</a></li>
 <li class="toctree-l2"><a class="reference internal" href="execution.html#running-for-a-group-of-datasets">Running for a group of datasets</a></li>