diff --git a/docs/source/start.rst b/docs/source/start.rst index 578ca74..6dc771f 100644 --- a/docs/source/start.rst +++ b/docs/source/start.rst @@ -5,17 +5,19 @@ Note: Ensure you have local modules enabled such that you have python 3.x instal Step 1 is to create a virtual environment and install the necessary packages with pip. -.. code-block:: - python -m venv name_of_venv - source name_of_venv/bin/activate - pip install -r requirements.txt +:: + 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: -.. code-block:: - export WORKDIR=/gws/nopw/j04/cmip6_prep_vol1/kerchunk-pipeline - export GROUPDIR=/gws/nopw/j04/cmip6_prep_vol1/kerchunk-pipeline/groups/CMIP6_rel1_6233 - export SRCDIR=/home/users/dwest77/Documents/kerchunk_dev/kerchunk-builder - export KVENV=/home/users/dwest77/Documents/kerchunk_dev/kerchunk-builder/build_venv +:: + export WORKDIR=/gws/nopw/j04/cmip6_prep_vol1/kerchunk-pipeline; + export GROUPDIR=/gws/nopw/j04/cmip6_prep_vol1/kerchunk-pipeline/groups/CMIP6_rel1_6233; + export SRCDIR=/home/users/dwest77/Documents/kerchunk_dev/kerchunk-builder; + export KVENV=/home/users/dwest77/Documents/kerchunk_dev/kerchunk-builder/build_venv; +:: Now you should be set up to run the pipeline properly. For any of the pipeline scripts, running ```python