Merge pull request #138 from hgloeckner/doku_intro

Doku intro

docs/source/apidocs/halodrops/halodrops.helper.md

@@ -16,3 +16,209 @@
 halodrops.helper.rawreader
 halodrops.helper.paths
 ```
+
+## Package Contents
+
+### Functions
+
+````{list-table}
+:class: autosummary longtable
+:align: left
+
+* - {py:obj}`get_bool <halodrops.helper.get_bool>`
+  - ```{autodoc2-docstring} halodrops.helper.get_bool
+    :summary:
+    ```
+* - {py:obj}`convert_rh_to_si <halodrops.helper.convert_rh_to_si>`
+  - ```{autodoc2-docstring} halodrops.helper.convert_rh_to_si
+    :summary:
+    ```
+* - {py:obj}`convert_pres_to_si <halodrops.helper.convert_pres_to_si>`
+  - ```{autodoc2-docstring} halodrops.helper.convert_pres_to_si
+    :summary:
+    ```
+* - {py:obj}`convert_tdry_to_si <halodrops.helper.convert_tdry_to_si>`
+  - ```{autodoc2-docstring} halodrops.helper.convert_tdry_to_si
+    :summary:
+    ```
+* - {py:obj}`get_si_converter_function_based_on_var <halodrops.helper.get_si_converter_function_based_on_var>`
+  - ```{autodoc2-docstring} halodrops.helper.get_si_converter_function_based_on_var
+    :summary:
+    ```
+* - {py:obj}`calc_saturation_pressure <halodrops.helper.calc_saturation_pressure>`
+  - ```{autodoc2-docstring} halodrops.helper.calc_saturation_pressure
+    :summary:
+    ```
+* - {py:obj}`calc_q_from_rh <halodrops.helper.calc_q_from_rh>`
+  - ```{autodoc2-docstring} halodrops.helper.calc_q_from_rh
+    :summary:
+    ```
+* - {py:obj}`calc_theta_from_T <halodrops.helper.calc_theta_from_T>`
+  - ```{autodoc2-docstring} halodrops.helper.calc_theta_from_T
+    :summary:
+    ```
+````
+
+### Data
+
+````{list-table}
+:class: autosummary longtable
+:align: left
+
+* - {py:obj}`l2_variables <halodrops.helper.l2_variables>`
+  - ```{autodoc2-docstring} halodrops.helper.l2_variables
+    :summary:
+    ```
+* - {py:obj}`encoding_variables <halodrops.helper.encoding_variables>`
+  - ```{autodoc2-docstring} halodrops.helper.encoding_variables
+    :summary:
+    ```
+* - {py:obj}`variable_compression_properties <halodrops.helper.variable_compression_properties>`
+  - ```{autodoc2-docstring} halodrops.helper.variable_compression_properties
+    :summary:
+    ```
+* - {py:obj}`path_to_flight_ids <halodrops.helper.path_to_flight_ids>`
+  - ```{autodoc2-docstring} halodrops.helper.path_to_flight_ids
+    :summary:
+    ```
+* - {py:obj}`path_to_l0_files <halodrops.helper.path_to_l0_files>`
+  - ```{autodoc2-docstring} halodrops.helper.path_to_l0_files
+    :summary:
+    ```
+* - {py:obj}`l2_flight_attributes_map <halodrops.helper.l2_flight_attributes_map>`
+  - ```{autodoc2-docstring} halodrops.helper.l2_flight_attributes_map
+    :summary:
+    ```
+* - {py:obj}`l2_filename_template <halodrops.helper.l2_filename_template>`
+  - ```{autodoc2-docstring} halodrops.helper.l2_filename_template
+    :summary:
+    ```
+````
+
+### API
+
+````{py:data} l2_variables
+:canonical: halodrops.helper.l2_variables
+:value: >
+   None
+
+```{autodoc2-docstring} halodrops.helper.l2_variables
+```
+
+````
+
+````{py:data} encoding_variables
+:canonical: halodrops.helper.encoding_variables
+:value: >
+   None
+
+```{autodoc2-docstring} halodrops.helper.encoding_variables
+```
+
+````
+
+````{py:data} variable_compression_properties
+:canonical: halodrops.helper.variable_compression_properties
+:value: >
+   'dict(...)'
+
+```{autodoc2-docstring} halodrops.helper.variable_compression_properties
+```
+
+````
+
+````{py:data} path_to_flight_ids
+:canonical: halodrops.helper.path_to_flight_ids
+:value: >
+   '{platform}/Level_0'
+
+```{autodoc2-docstring} halodrops.helper.path_to_flight_ids
+```
+
+````
+
+````{py:data} path_to_l0_files
+:canonical: halodrops.helper.path_to_l0_files
+:value: >
+   '{platform}/Level_0/{flight_id}'
+
+```{autodoc2-docstring} halodrops.helper.path_to_l0_files
+```
+
+````
+
+````{py:data} l2_flight_attributes_map
+:canonical: halodrops.helper.l2_flight_attributes_map
+:value: >
+   None
+
+```{autodoc2-docstring} halodrops.helper.l2_flight_attributes_map
+```
+
+````
+
+````{py:data} l2_filename_template
+:canonical: halodrops.helper.l2_filename_template
+:value: >
+   '{platform}_{launch_time}_{flight_id}_{serial_id}_Level_2.nc'
+
+```{autodoc2-docstring} halodrops.helper.l2_filename_template
+```
+
+````
+
+````{py:function} get_bool(s)
+:canonical: halodrops.helper.get_bool
+
+```{autodoc2-docstring} halodrops.helper.get_bool
+```
+````
+
+````{py:function} convert_rh_to_si(value)
+:canonical: halodrops.helper.convert_rh_to_si
+
+```{autodoc2-docstring} halodrops.helper.convert_rh_to_si
+```
+````
+
+````{py:function} convert_pres_to_si(value)
+:canonical: halodrops.helper.convert_pres_to_si
+
+```{autodoc2-docstring} halodrops.helper.convert_pres_to_si
+```
+````
+
+````{py:function} convert_tdry_to_si(value)
+:canonical: halodrops.helper.convert_tdry_to_si
+
+```{autodoc2-docstring} halodrops.helper.convert_tdry_to_si
+```
+````
+
+````{py:function} get_si_converter_function_based_on_var(var_name)
+:canonical: halodrops.helper.get_si_converter_function_based_on_var
+
+```{autodoc2-docstring} halodrops.helper.get_si_converter_function_based_on_var
+```
+````
+
+````{py:function} calc_saturation_pressure(temperature_K, method='hardy1998')
+:canonical: halodrops.helper.calc_saturation_pressure
+
+```{autodoc2-docstring} halodrops.helper.calc_saturation_pressure
+```
+````
+
+````{py:function} calc_q_from_rh(ds)
+:canonical: halodrops.helper.calc_q_from_rh
+
+```{autodoc2-docstring} halodrops.helper.calc_q_from_rh
+```
+````
+
+````{py:function} calc_theta_from_T(dataset)
+:canonical: halodrops.helper.calc_theta_from_T
+
+```{autodoc2-docstring} halodrops.helper.calc_theta_from_T
+```
+````

docs/source/apidocs/halodrops/halodrops.helper.paths.md

@@ -15,8 +15,12 @@
 :class: autosummary longtable
 :align: left
 
-* - {py:obj}`Paths <halodrops.helper.paths.Paths>`
-  - ```{autodoc2-docstring} halodrops.helper.paths.Paths
+* - {py:obj}`Platform <halodrops.helper.paths.Platform>`
+  - ```{autodoc2-docstring} halodrops.helper.paths.Platform
+    :summary:
+    ```
+* - {py:obj}`Flight <halodrops.helper.paths.Flight>`
+  - ```{autodoc2-docstring} halodrops.helper.paths.Flight
     :summary:
     ```
 ````
@@ -38,45 +42,67 @@
 ````{py:data} module_logger
 :canonical: halodrops.helper.paths.module_logger
 :value: >
-   None
+   'getLogger(...)'
 
 ```{autodoc2-docstring} halodrops.helper.paths.module_logger
 ```
 
 ````
 
-`````{py:class} Paths(directory, flightdir)
-:canonical: halodrops.helper.paths.Paths
+`````{py:class} Platform(data_directory, platform_id, platform_directory_name=None, path_structure=path_to_flight_ids)
+:canonical: halodrops.helper.paths.Platform
+
+```{autodoc2-docstring} halodrops.helper.paths.Platform
+```
+
+```{rubric} Initialization
+```
+
+```{autodoc2-docstring} halodrops.helper.paths.Platform.__init__
+```
+
+````{py:method} get_flight_ids()
+:canonical: halodrops.helper.paths.Platform.get_flight_ids
+
+```{autodoc2-docstring} halodrops.helper.paths.Platform.get_flight_ids
+```
+
+````
+
+`````
+
+`````{py:class} Flight(data_directory, flight_id, platform_id, path_structure=path_to_l0_files)
+:canonical: halodrops.helper.paths.Flight
 
-```{autodoc2-docstring} halodrops.helper.paths.Paths
+```{autodoc2-docstring} halodrops.helper.paths.Flight
 ```
 
 ```{rubric} Initialization
 ```
 
-```{autodoc2-docstring} halodrops.helper.paths.Paths.__init__
+```{autodoc2-docstring} halodrops.helper.paths.Flight.__init__
 ```
 
 ````{py:method} get_all_afiles()
-:canonical: halodrops.helper.paths.Paths.get_all_afiles
+:canonical: halodrops.helper.paths.Flight.get_all_afiles
 
-```{autodoc2-docstring} halodrops.helper.paths.Paths.get_all_afiles
+```{autodoc2-docstring} halodrops.helper.paths.Flight.get_all_afiles
 ```
 
 ````
 
 ````{py:method} quicklooks_path()
-:canonical: halodrops.helper.paths.Paths.quicklooks_path
+:canonical: halodrops.helper.paths.Flight.quicklooks_path
 
-```{autodoc2-docstring} halodrops.helper.paths.Paths.quicklooks_path
+```{autodoc2-docstring} halodrops.helper.paths.Flight.quicklooks_path
 ```
 
 ````
 
 ````{py:method} populate_sonde_instances() -> typing.Dict
-:canonical: halodrops.helper.paths.Paths.populate_sonde_instances
+:canonical: halodrops.helper.paths.Flight.populate_sonde_instances
 
-```{autodoc2-docstring} halodrops.helper.paths.Paths.populate_sonde_instances
+```{autodoc2-docstring} halodrops.helper.paths.Flight.populate_sonde_instances
 ```
 
 ````

docs/source/apidocs/halodrops/halodrops.helper.rawreader.md

@@ -50,7 +50,7 @@
 ````{py:data} module_logger
 :canonical: halodrops.helper.rawreader.module_logger
 :value: >
-   None
+   'getLogger(...)'
 
 ```{autodoc2-docstring} halodrops.helper.rawreader.module_logger
 ```

docs/source/apidocs/halodrops/halodrops.md

@@ -22,11 +22,24 @@ halodrops.helper
 :titlesonly:
 :maxdepth: 1
 
-halodrops.sonde
+halodrops.processor
+halodrops.pipeline
 ```
 
 ## Package Contents
 
+### Functions
+
+````{list-table}
+:class: autosummary longtable
+:align: left
+
+* - {py:obj}`main <halodrops.main>`
+  - ```{autodoc2-docstring} halodrops.main
+    :summary:
+    ```
+````
+
 ### Data
 
 ````{list-table}
@@ -64,7 +77,7 @@ halodrops.sonde
 ````{py:data} logger
 :canonical: halodrops.logger
 :value: >
-   None
+   'getLogger(...)'
 
 ```{autodoc2-docstring} halodrops.logger
 ```
@@ -74,7 +87,7 @@ halodrops.sonde
 ````{py:data} fh_info
 :canonical: halodrops.fh_info
 :value: >
-   None
+   'FileHandler(...)'
 
 ```{autodoc2-docstring} halodrops.fh_info
 ```
@@ -84,7 +97,7 @@ halodrops.sonde
 ````{py:data} fh_debug
 :canonical: halodrops.fh_debug
 :value: >
-   None
+   'FileHandler(...)'
 
 ```{autodoc2-docstring} halodrops.fh_debug
 ```
@@ -94,7 +107,7 @@ halodrops.sonde
 ````{py:data} ch
 :canonical: halodrops.ch
 :value: >
-   None
+   'StreamHandler(...)'
 
 ```{autodoc2-docstring} halodrops.ch
 ```
@@ -113,9 +126,16 @@ halodrops.sonde
 ````{py:data} formatter
 :canonical: halodrops.formatter
 :value: >
-   None
+   'Formatter(...)'
 
 ```{autodoc2-docstring} halodrops.formatter
 ```
 
 ````
+
+````{py:function} main()
+:canonical: halodrops.main
+
+```{autodoc2-docstring} halodrops.main
+```
+````