Skip to content

Commit

Permalink
Temporary code blocks fix
Browse files Browse the repository at this point in the history
  • Loading branch information
dwest77a committed Jan 30, 2024
1 parent 272bfe4 commit e0db3c5
Showing 1 changed file with 11 additions and 9 deletions.
20 changes: 11 additions & 9 deletions docs/source/start.rst
Original file line number Diff line number Diff line change
Expand Up @@ -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;
::

Check warning on line 12 in docs/source/start.rst

View workflow job for this annotation

GitHub Actions / build

Definition list ends without a blank line; unexpected unindent.

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:

Check warning on line 14 in docs/source/start.rst

View workflow job for this annotation

GitHub Actions / build

Literal block expected; none found.

.. 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;
::

Check warning on line 21 in docs/source/start.rst

View workflow job for this annotation

GitHub Actions / build

Definition list ends without a blank line; unexpected unindent.

Now you should be set up to run the pipeline properly. For any of the pipeline scripts, running ```python <script>.py -h # or --help``` will bring up a list of options to use for that script as well as the required parameters.

Check warning on line 23 in docs/source/start.rst

View workflow job for this annotation

GitHub Actions / build

Literal block expected; none found.

0 comments on commit e0db3c5

Please sign in to comment.