diff -r c7e64cfab199 -r b0ce0f140b0e readme.rst --- a/readme.rst Mon Feb 27 15:08:35 2017 +0200 +++ b/readme.rst Mon Feb 27 22:10:54 2017 +0200 @@ -7,6 +7,12 @@ The package provides a single command line tool, called licel2scc that can convert Licel binary files to the EARLINET's Single Calculus Chain NetCDF format. +Installation +============ + +The easiest way to install this module is from the python package index using ``pip``:: + + pip install atmospheric-lidar Using it as a Licel to SCC converter ==================================== @@ -20,13 +26,9 @@ Command line interface ---------------------- -The usage of the ``licel2scc`` program is described bellow:: +The usage of the ``licel2scc`` program is described below:: - usage: licel2scc [-h] [-i] [-m MEASUREMENT_ID] [-n MEASUREMENT_NUMBER] - [-t TEMPERATURE] [-p PRESSURE] [-d] [-s] - parameter_file [directory] [search_string] - - A program to convert LICEL binary files to the SCC NetCDF format. + A program to convert Licel binary files to the SCC NetCDF format. positional arguments: parameter_file The path to a parameter file linking licel and SCC @@ -51,7 +53,39 @@ using US Standard atmosphere -d, --debug Print dubuging information. -s, --silent Show only warning and error messages. + --version Show current version. +Similarly, the ``licel2scc-depol`` program can be used to convert +Licel files from Delta45 depolarization calibration measurements:: + + A program to convert Licel binary files from depolarization calibration + measurements to the SCC NetCDF format. + + positional arguments: + parameter_file The path to a parameter file linking licel and SCC + channels. + plus45_string Search string for plus 45 degree files (default '*.*') + minus45_string Search string for minus 45 degree files (default + '*.*') + + optional arguments: + -h, --help show this help message and exit + -i, --id_as_name Use transient digitizer ids as channel names, instead + of descriptive names + -m MEASUREMENT_ID, --measurement_id MEASUREMENT_ID + The new measurement id + -n MEASUREMENT_NUMBER, --measurement_number MEASUREMENT_NUMBER + The measurement number for the date from 00 to 99. + Used if no id is provided + -t TEMPERATURE, --temperature TEMPERATURE + The temperature (in C) at lidar level, required if + using US Standard atmosphere + -p PRESSURE, --pressure PRESSURE + The pressure (in hPa) at lidar level, required if + using US Standard atmosphere + -d, --debug Print dubuging information. + -s, --silent Show only warning and error messages. + --version Show current version. Usage in python code --------------------