# HG changeset patch
# User Iannis <ulalume3@yahoo.com>
# Date 1478788500 -7200
# Node ID d55a57e732bef017a66b60c2b204905df5e382af
# Parent  ec9e68b53a3b49978c12c8b1eac8a7a5cff2a969
* Initial readme file.
* Minor doc changes in example system setting file.

diff -r ec9e68b53a3b -r d55a57e732be CHANGELOG.md
--- a/CHANGELOG.md	Thu Nov 10 16:18:17 2016 +0200
+++ b/CHANGELOG.md	Thu Nov 10 16:35:00 2016 +0200
@@ -3,9 +3,10 @@
 ## [Unreleased]
 - Moved changes to a separate CHANGELOG file.
 - Added EUPL licence file.
+- Renamed script files to lidar_correction_ghk*.
 
 ## 9-PollXT 
-- same as before
+- Same as before.
 
 ## 9-Ralph-6 
 - For POLLY_XT   RP = 1 - TP  RS = 1 - TS
diff -r ec9e68b53a3b -r d55a57e732be README.md
--- a/README.md	Thu Nov 10 16:18:17 2016 +0200
+++ b/README.md	Thu Nov 10 16:35:00 2016 +0200
@@ -1,1 +1,20 @@
-polarizatio_simulator
+Calculation of pollarization correction factors for atmospheric lidar system, developed by Volker Freudenthaler (LMU).
+
+# Theory
+The theoretical basis of the script is described in detail in :
+
+>Freudenthaler, V.: About the effects of polarising optics on lidar signals and the Δ90 calibration,
+Atmos. Meas. Tech., 9, 4181-4255, doi:10.5194/amt-9-4181-2016, 2016
+>http://www.atmos-meas-tech.net/9/4181/2016/
+
+
+# Use
+To run the script you need to:
+
+1. Create a file describing your system settings and parameters. You can find an example file in the "system_settings"
+   folder. Give a descriptive name and save it in the "system_settings" folder.
+
+2. Open the "lidar_correction_ghk.py" file, and set the variable InputFile to the filename you chose in step 1.
+
+3. Run "python lidar_correction_ghk.py"
+
diff -r ec9e68b53a3b -r d55a57e732be system_settings/optic_input_ver8c_PollyXT_RALPH_7.py
--- a/system_settings/optic_input_ver8c_PollyXT_RALPH_7.py	Thu Nov 10 16:18:17 2016 +0200
+++ b/system_settings/optic_input_ver8c_PollyXT_RALPH_7.py	Thu Nov 10 16:35:00 2016 +0200
@@ -1,6 +1,8 @@
-# This Python script will be executed from within the main calc_lidar_correction_parameters_G_H_K.py
-# Probably it will be better in the future to let the main script rather read a conguration file, which might improve the portability of the code within an executable.
-# Due to problems I had with some two letter variables, most variables are now with at least three letters mixed small and capital.
+# This Python script will be executed from within the main lidar_correction_ghk.py
+# Probably it will be better in the future to let the main script rather read a conguration file,
+# which might improve the portability of the code within an executable.
+# Due to problems I had with some two letter variables, most variables are now with at least
+# three letters mixed small and capital.
 
 # Header to identify the lidar system
 # Values of DO, DT, and DR etc. from fit to lamp calibrations in Leipzig (LampCalib_2_invers_c_D0=0.opj)