Mercurial > public > atmospheric_lidar / changeset

--- a/.hgignore	Tue Oct 09 11:45:28 2012 +0200
+++ b/.hgignore	Tue Oct 09 11:48:01 2012 +0200
@@ -1,3 +1,4 @@
 syntax: glob
 *.pyc
 *.py~
+*.rst~

--- a/readme.rst	Tue Oct 09 11:45:28 2012 +0200
+++ b/readme.rst	Tue Oct 09 11:48:01 2012 +0200
@@ -18,55 +18,52 @@
 ~~~~~~~~~~
 The next thing you need to create a class that describes you system. This is very simple if your lidar data are in the Licel format, as you only need to specify the external file with the extra SCC parameters. You can use as an example the file “cf_raymetrics.py”::
 
-from licel import LicelLidarMeasurement
-
-import cf_netcdf_parameters
+   from licel import LicelLidarMeasurement
+   import cf_netcdf_parameters
 
-class CfLidarMeasurement(LicelLidarMeasurement):
-    
-    extra_netcdf_parameters = cf_netcdf_parameters
+   class CfLidarMeasurement(LicelLidarMeasurement):
+      extra_netcdf_parameters = cf_netcdf_parameters
+
 
 Using the class
 ------------------
 
-Once you have made the above setup you can start using it. The best way to understand how it works is through an interactive shell (I suggest ipython(http://ipython.org/)).  In the following example I use the cf_raymetrics setup.
-
-import glob # This is needed to read a list of filenames
-from lidar import cf_raymetrics #If you have saved the files in a directrory called “lidar”
+Once you have made the above setup you can start using it. The best way to understand how it works is through an interactive shell (I suggest ipython(http://ipython.org/)).  In the following example I use the cf_raymetrics setup::
+    import glob # This is needed to read a list of filenames
+    from lidar import cf_raymetrics #If you have saved the files in a directrory called “lidar”
 
-# Go to the folder where you files are stored
-cd /path/to/lidar/files
+    # Go to the folder where you files are stored
+    cd /path/to/lidar/files
 
-# Read the filenames
-files  = glob.glob('*') # The * reads all the files in the folder.
+    # Read the filenames
+    files  = glob.glob('*') # The * reads all the files in the folder.
 
-#Read the files
-my_measurement = cf_raymetrics.CfLidarMeasurement(files)
+    #Read the files
+    my_measurement = cf_raymetrics.CfLidarMeasurement(files)
 
-#Now the data have been read, and you have a measurement object to work with:
-# See what channels are present
-print my_measurement.channels
+    #Now the data have been read, and you have a measurement object to work with:
+    # See what channels are present
+    print my_measurement.channels
 
-#Quicklooks of all the channels
+    #Quicklooks of all the channels
 
-my_measurements.plot()
+    my_measurements.plot()
 
 Converting to SCC format
 --------------------------------
 
 There are some extra info you need to put in before converting to SCC format, 'Measurement_ID', 'Temperature', 'Pressure'::
+    my_measurement.info['Measurement_ID'] = “20101229op00”
+    my_measurement.info['Temperature'] = “14”
+    my_measurement.info['Pressure'] = “1010”
 
-my_measurement.info['Measurement_ID'] = “20101229op00”
-my_measurement.info['Temperature'] = “14”
-my_measurement.info['Pressure'] = “1010”
-
-You can use standard values of temperature and pressure by just calling:
-my_measurement.get_PT() 
+You can use standard values of temperature and pressure by just calling::
+    my_measurement.get_PT() 
 
 The standard values can be changed in generic.py. Search the  get_PT method and change of what is appropriate for your station. If you have an external source of temperature and pressure information (a meteorological station) you can automate this by overriding the get_PT method in your system's class (in our example in the cf_raymetrics.py file).
 
-After you have used this extra input, you save the file using this command:
-my_measurement.save_as_netcdf(“filename”)
+After you have used this extra input, you save the file using this command::
+    my_measurement.save_as_netcdf(“filename”)
 
 where you change the filename to the filename you want to use.