Merge pull request #6 from singh96aman/merge-code

Enhance Documentation

README.md

@@ -34,6 +34,8 @@ LCLS on S3DF with default parameters:
 ipython lume-impact-live-demo.py -- -t "s3df"
 ```
 
+# Parameters
+
 All Parameters to run lume-impact-live-demo.py file -
 ```
 -d Debug=True/False
@@ -50,6 +52,33 @@ model=sc_inj
 host=sdf
 ```
 
+# Running Lume-Impact-Live-Demo on S3DF
+
+Please remember to follow all the above steps (including connecting to PVs). Please wait roughly 5-10 mins for job to complete one simulation. 
+```
+export LCLS_LATTICE=/sdf/group/ad/beamphysics/lcls-lattice
+export SCRATCH=/sdf/group/ad/beamphysics/lume-impact-live-demo/SCRATCH3 (Try not using the lscratch or scratch on S3DF. Somehow, it didn't work for me.)
+export LUME_IMPACT_CODEBASE_LOCATION=/sdf/group/ad/beamphysics/lume-impact-live-demo
+export LUME_OUTPUT_FOLDERS=/sdf/group/ad/beamphysics/lume-impact-live-demo/output
+export SCRATCH=/sdf/group/ad/beamphysics/lume-impact-live-demo/SCRATCH
+
+ipython /sdf/group/ad/beamphysics/lume-impact-live-demo/lume-impact-live-demo.py -- -t "s3df"
+```
+
+# Running Lume-Impact-Live-Demo on S3DF as a Service
+
+Easiest way to run lume-impact-live-demo on S3DF as a Service is through Cron Jobs.
+Please remember to check all the export variables in `cron_job_setup.sh`
+Saving below config should automatically trigger the job in background. Use logs to monitor the job. Otherwise, You can see the pid saved in ~/tmp/myprogram.pid which signifies the last pid that executed this program.
+```
+crontab -e
+
+#Opens a file. Please enter below details and save it. 
+SHELL=/bin/bash
+BASH_ENV=~/.bashrc
+* * * * * source /sdf/group/ad/beamphysics/lume-impact-live-demo/cron_job_setup.sh
+```
+
 ## TOML properties file
 
 Running the simulation requires definition of the following variables within a toml file: