Mercurial > public > atmospheric_lidar / file comparison
comparison: readme.rst
readme.rst
- changeset 82
- 01fdb725ca59
- parent 75
- 33826498a125
- child 85
- fc270953f14b
equal
deleted
inserted
replaced
| 81:b6602134d40f | 82:01fdb725ca59 |
|---|---|
| 5 The main format supported are Licel binary files (including the Raymetrics modified format). | 5 The main format supported are Licel binary files (including the Raymetrics modified format). |
| 6 | 6 |
| 7 The package provides a single command line tool, called licel2scc that can convert Licel binary files to the | 7 The package provides a single command line tool, called licel2scc that can convert Licel binary files to the |
| 8 EARLINET's Single Calculus Chain NetCDF format. | 8 EARLINET's Single Calculus Chain NetCDF format. |
| 9 | 9 |
| 10 Installation | |
| 11 ============ | |
| 12 | |
| 13 The easiest way to install this module is from the python package index using ``pip``:: | |
| 14 | |
| 15 pip install atmospheric-lidar | |
| 10 | 16 |
| 11 Using it as a Licel to SCC converter | 17 Using it as a Licel to SCC converter |
| 12 ==================================== | 18 ==================================== |
| 13 | 19 |
| 14 Parameter file | 20 Parameter file |
| 18 As an example, you can start by changing the file “cf_netcdf_parameters.py” that describe such | 24 As an example, you can start by changing the file “cf_netcdf_parameters.py” that describe such |
| 19 parameters for the Clermont Ferrand lidar. | 25 parameters for the Clermont Ferrand lidar. |
| 20 | 26 |
| 21 Command line interface | 27 Command line interface |
| 22 ---------------------- | 28 ---------------------- |
| 23 The usage of the ``licel2scc`` program is described bellow:: | 29 The usage of the ``licel2scc`` program is described below:: |
| 24 | 30 |
| 25 usage: licel2scc [-h] [-i] [-m MEASUREMENT_ID] [-n MEASUREMENT_NUMBER] | 31 A program to convert Licel binary files to the SCC NetCDF format. |
| 26 [-t TEMPERATURE] [-p PRESSURE] [-d] [-s] | |
| 27 parameter_file [directory] [search_string] | |
| 28 | |
| 29 A program to convert LICEL binary files to the SCC NetCDF format. | |
| 30 | 32 |
| 31 positional arguments: | 33 positional arguments: |
| 32 parameter_file The path to a parameter file linking licel and SCC | 34 parameter_file The path to a parameter file linking licel and SCC |
| 33 channels. | 35 channels. |
| 34 directory Directory containing licel files (default '.') | 36 files Location of licel files. Use relative path and |
| 35 search_string Search string for files in directory (default '*.*') | 37 filename wildcards. (default './*.*') |
| 36 | 38 |
| 37 optional arguments: | 39 optional arguments: |
| 38 -h, --help show this help message and exit | 40 -h, --help show this help message and exit |
| 39 -i, --id_as_name Use transient digitizer ids as channel names, instead | 41 -i, --id_as_name Use transient digitizer ids as channel names, instead |
| 40 of descriptive names | 42 of descriptive names |
| 49 -p PRESSURE, --pressure PRESSURE | 51 -p PRESSURE, --pressure PRESSURE |
| 50 The pressure (in hPa) at lidar level, required if | 52 The pressure (in hPa) at lidar level, required if |
| 51 using US Standard atmosphere | 53 using US Standard atmosphere |
| 52 -d, --debug Print dubuging information. | 54 -d, --debug Print dubuging information. |
| 53 -s, --silent Show only warning and error messages. | 55 -s, --silent Show only warning and error messages. |
| 56 --version Show current version. | |
| 54 | 57 |
| 58 Similarly, the ``licel2scc-depol`` program can be used to convert | |
| 59 Licel files from Delta45 depolarization calibration measurements:: | |
| 60 | |
| 61 A program to convert Licel binary files from depolarization calibration | |
| 62 measurements to the SCC NetCDF format. | |
| 63 | |
| 64 positional arguments: | |
| 65 parameter_file The path to a parameter file linking licel and SCC | |
| 66 channels. | |
| 67 plus45_string Search string for plus 45 degree files (default '*.*') | |
| 68 minus45_string Search string for minus 45 degree files (default | |
| 69 '*.*') | |
| 70 | |
| 71 optional arguments: | |
| 72 -h, --help show this help message and exit | |
| 73 -i, --id_as_name Use transient digitizer ids as channel names, instead | |
| 74 of descriptive names | |
| 75 -m MEASUREMENT_ID, --measurement_id MEASUREMENT_ID | |
| 76 The new measurement id | |
| 77 -n MEASUREMENT_NUMBER, --measurement_number MEASUREMENT_NUMBER | |
| 78 The measurement number for the date from 00 to 99. | |
| 79 Used if no id is provided | |
| 80 -t TEMPERATURE, --temperature TEMPERATURE | |
| 81 The temperature (in C) at lidar level, required if | |
| 82 using US Standard atmosphere | |
| 83 -p PRESSURE, --pressure PRESSURE | |
| 84 The pressure (in hPa) at lidar level, required if | |
| 85 using US Standard atmosphere | |
| 86 -d, --debug Print dubuging information. | |
| 87 -s, --silent Show only warning and error messages. | |
| 88 --version Show current version. | |
| 55 | 89 |
| 56 Usage in python code | 90 Usage in python code |
| 57 -------------------- | 91 -------------------- |
| 58 System class | 92 System class |
| 59 ~~~~~~~~~~~~ | 93 ~~~~~~~~~~~~ |
