From 03fc0b7a1c16a4f5f9d63eeda9cfe1e6851d77cf Mon Sep 17 00:00:00 2001 From: epi Date: Mon, 2 Sep 2019 15:25:09 -0500 Subject: [PATCH] small changes to README --- README.md | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) diff --git a/README.md b/README.md index 670431c..74e8307 100644 --- a/README.md +++ b/README.md @@ -5,7 +5,7 @@ ### PYTHONPATH To run the pipelines, you need to set your `PYTHONPATH` environment variable to the path of this project on disk. This can be accomplished in a few ways, two solutions are offered. -1. Prepend PYTHONPATH=/path/to/recon-pipline to any luigi pipeline command being run. +1. Prepend `PYTHONPATH=/path/to/recon-pipline` to any luigi pipeline command being run. 2. Add `export PYTHONPATH=/path/to/recon-pipeline` to your `.bashrc` ### Scheduler @@ -34,7 +34,7 @@ The pipeline expects a file that describes the project scope to be in the curren ### luigi command structure -With the PYTHONPATH setup, luigi commands take on the following structure (prepend PYTHONPATH if not exported from .bashrc): +With the `PYTHONPATH` setup, luigi commands take on the following structure (prepend `PYTHONPATH` if not exported from `.bashrc`): `luigi --module PACKAGENAME.MODULENAME CLASSNAME *args` @@ -62,7 +62,7 @@ optional arguments: --target-file TARGET_FILE ``` -example scope file command where `tesla` is the name of the file and it is located in the current directory. +An example scope file command, where `tesla` is the name of the file and it is located in the current directory. `PYTHONPATH=$(pwd) luigi --local-scheduler --module recon.targets TargetList --target-file tesla`