update of documentation

meteoswiss-mdr · Dec 20, 2018 · ae36ed9 · ae36ed9
1 parent 6be0077
commit ae36ed9
Show file tree

Hide file tree

Showing 24 changed files with 264 additions and 21 deletions.
diff --git a/doc/20160624_fvj_malsgit-open_source_relations.docx b/doc/20160624_fvj_malsgit-open_source_relations.docx
diff --git a/doc/pyart-mch/library_reference_developers/source/aux_io.rst b/doc/pyart-mch/library_reference_developers/source/aux_io.rst
@@ -43,6 +43,13 @@
    :special-members:
    :inherited-members:
    :show-inheritance:
+.. automodule:: pyart.aux_io.metranet_reader
+   :members:
+   :undoc-members:
+   :private-members:
+   :special-members:
+   :inherited-members:
+   :show-inheritance:
 .. automodule:: pyart.aux_io.noxp_iphex_nc
    :members:
    :undoc-members:

diff --git a/doc/pyart-mch/library_reference_developers/source/graph.rst b/doc/pyart-mch/library_reference_developers/source/graph.rst
@@ -8,6 +8,13 @@
    :special-members:
    :inherited-members:
    :show-inheritance:
+.. automodule:: pyart.graph.cm_colorblind
+   :members:
+   :undoc-members:
+   :private-members:
+   :special-members:
+   :inherited-members:
+   :show-inheritance:
 .. automodule:: pyart.graph.common
    :members:
    :undoc-members:
@@ -43,6 +50,13 @@
    :special-members:
    :inherited-members:
    :show-inheritance:
+.. automodule:: pyart.graph.radarmapdisplay_cartopy
+   :members:
+   :undoc-members:
+   :private-members:
+   :special-members:
+   :inherited-members:
+   :show-inheritance:
 .. automodule:: pyart.graph._cm
    :members:
    :undoc-members:

diff --git a/doc/pyart-mch/library_reference_developers/source/index.rst b/doc/pyart-mch/library_reference_developers/source/index.rst
@@ -9,19 +9,23 @@ Welcome to pyart-mch's documentation!
 Contents:
 
 .. toctree::
-   :maxdepth: 2
+    :maxdepth: 2
 
-   io
-   aux_io
-   core
-   bridge
-   filters
-   correct
-   retrieve
-   map
-   graph
-   util
-   testing
+    core
+    io
+    aux_io
+    config
+    correct
+    exceptions
+    retrieve
+    graph
+    filters
+    lazydict
+    map
+    util
+    bridge
+    testing
+    _debug_info
 
 
 

diff --git a/doc/pyart-mch/library_reference_developers/source/io.rst b/doc/pyart-mch/library_reference_developers/source/io.rst
@@ -57,6 +57,13 @@
    :special-members:
    :inherited-members:
    :show-inheritance:
+.. automodule:: pyart.io.mdv_grid
+   :members:
+   :undoc-members:
+   :private-members:
+   :special-members:
+   :inherited-members:
+   :show-inheritance:
 .. automodule:: pyart.io.nexradl3_read
    :members:
    :undoc-members:

diff --git a/doc/pyart-mch/library_reference_developers/source/map.rst b/doc/pyart-mch/library_reference_developers/source/map.rst
@@ -15,6 +15,13 @@
    :special-members:
    :inherited-members:
    :show-inheritance:
+.. automodule:: pyart.map.polar_to_cartesian
+   :members:
+   :undoc-members:
+   :private-members:
+   :special-members:
+   :inherited-members:
+   :show-inheritance:
 .. automodule:: pyart.map._gate_to_grid_map
    :members:
    :undoc-members:

diff --git a/doc/pyart-mch/library_reference_developers/source/retrieve.rst b/doc/pyart-mch/library_reference_developers/source/retrieve.rst
@@ -29,13 +29,27 @@
    :special-members:
    :inherited-members:
    :show-inheritance:
+.. automodule:: pyart.retrieve.ml
+   :members:
+   :undoc-members:
+   :private-members:
+   :special-members:
+   :inherited-members:
+   :show-inheritance:
 .. automodule:: pyart.retrieve.simple_moment_calculations
    :members:
    :undoc-members:
    :private-members:
    :special-members:
    :inherited-members:
    :show-inheritance:
+.. automodule:: pyart.retrieve.wind
+   :members:
+   :undoc-members:
+   :private-members:
+   :special-members:
+   :inherited-members:
+   :show-inheritance:
 .. automodule:: pyart.retrieve._kdp_proc
    :members:
    :undoc-members:

diff --git a/doc/pyart-mch_library_reference_dev.pdf b/doc/pyart-mch_library_reference_dev.pdf
diff --git a/doc/pyart-mch_library_reference_users.pdf b/doc/pyart-mch_library_reference_users.pdf
diff --git a/doc/pyrad/library_reference_developers/source/flow.rst b/doc/pyrad/library_reference_developers/source/flow.rst
@@ -1,6 +1,13 @@
 :mod: `pyrad.flow`
 ==================
 
+.. automodule:: pyrad.flow.flow_aux
+   :members:
+   :undoc-members:
+   :private-members:
+   :special-members:
+   :inherited-members:
+   :show-inheritance:
 .. automodule:: pyrad.flow.flow_control
    :members:
    :undoc-members:

diff --git a/doc/pyrad/library_reference_developers/source/graph.rst b/doc/pyrad/library_reference_developers/source/graph.rst
@@ -1,10 +1,38 @@
 :mod: `pyrad.graph`
 ===================
 
+.. automodule:: pyrad.graph.plots_aux
+   :members:
+   :undoc-members:
+   :private-members:
+   :special-members:
+   :inherited-members:
+   :show-inheritance:
 .. automodule:: pyrad.graph.plots
    :members:
    :undoc-members:
    :private-members:
    :special-members:
    :inherited-members:
    :show-inheritance:
+.. automodule:: pyrad.graph.plots_vol
+   :members:
+   :undoc-members:
+   :private-members:
+   :special-members:
+   :inherited-members:
+   :show-inheritance:
+.. automodule:: pyrad.graph.plots_grid
+   :members:
+   :undoc-members:
+   :private-members:
+   :special-members:
+   :inherited-members:
+   :show-inheritance:
+.. automodule:: pyrad.graph.plots_timeseries
+   :members:
+   :undoc-members:
+   :private-members:
+   :special-members:
+   :inherited-members:
+   :show-inheritance:
diff --git a/doc/pyrad/library_reference_developers/source/io.rst b/doc/pyrad/library_reference_developers/source/io.rst
@@ -1,13 +1,69 @@
 :mod: `pyrad.io`
 ================
 
+.. automodule:: pyrad.io.io_aux
+   :members:
+   :undoc-members:
+   :private-members:
+   :special-members:
+   :inherited-members:
+   :show-inheritance:
+.. automodule:: pyrad.io.config
+   :members:
+   :undoc-members:
+   :private-members:
+   :special-members:
+   :inherited-members:
+   :show-inheritance:
 .. automodule:: pyrad.io.read_data_radar
    :members:
    :undoc-members:
    :private-members:
    :special-members:
    :inherited-members:
    :show-inheritance:
+.. automodule:: pyrad.io.read_data_mxpol
+   :members:
+   :undoc-members:
+   :private-members:
+   :special-members:
+   :inherited-members:
+   :show-inheritance:
+.. automodule:: pyrad.io.mxpol_config
+   :members:
+   :undoc-members:
+   :private-members:
+   :special-members:
+   :inherited-members:
+   :show-inheritance:
+.. automodule:: pyrad.io.read_data_cosmo
+   :members:
+   :undoc-members:
+   :private-members:
+   :special-members:
+   :inherited-members:
+   :show-inheritance:
+.. automodule:: pyrad.io.read_data_hzt
+   :members:
+   :undoc-members:
+   :private-members:
+   :special-members:
+   :inherited-members:
+   :show-inheritance:
+.. automodule:: pyrad.io.read_data_sensor
+   :members:
+   :undoc-members:
+   :private-members:
+   :special-members:
+   :inherited-members:
+   :show-inheritance:
+.. automodule:: pyrad.io.read_data_sun
+   :members:
+   :undoc-members:
+   :private-members:
+   :special-members:
+   :inherited-members:
+   :show-inheritance:
 .. automodule:: pyrad.io.read_data_other
    :members:
    :undoc-members:
@@ -22,7 +78,14 @@
    :special-members:
    :inherited-members:
    :show-inheritance:
-.. automodule:: pyrad.io.io_aux
+.. automodule:: pyrad.io.timeseries
+   :members:
+   :undoc-members:
+   :private-members:
+   :special-members:
+   :inherited-members:
+   :show-inheritance:
+.. automodule:: pyrad.io.trajectory
    :members:
    :undoc-members:
    :private-members:

diff --git a/doc/pyrad/library_reference_developers/source/proc.rst b/doc/pyrad/library_reference_developers/source/proc.rst
@@ -8,13 +8,48 @@
    :special-members:
    :inherited-members:
    :show-inheritance:
+.. automodule:: pyrad.proc.process_calib
+   :members:
+   :undoc-members:
+   :private-members:
+   :special-members:
+   :inherited-members:
+   :show-inheritance:
+.. automodule:: pyrad.proc.process_cosmo
+   :members:
+   :undoc-members:
+   :private-members:
+   :special-members:
+   :inherited-members:
+   :show-inheritance:
+.. automodule:: pyrad.proc.process_Doppler
+   :members:
+   :undoc-members:
+   :private-members:
+   :special-members:
+   :inherited-members:
+   :show-inheritance:
 .. automodule:: pyrad.proc.process_echoclass
    :members:
    :undoc-members:
    :private-members:
    :special-members:
    :inherited-members:
    :show-inheritance:
+.. automodule:: pyrad.proc.process_intercomp
+   :members:
+   :undoc-members:
+   :private-members:
+   :special-members:
+   :inherited-members:
+   :show-inheritance:
+.. automodule:: pyrad.proc.process_monitoring
+   :members:
+   :undoc-members:
+   :private-members:
+   :special-members:
+   :inherited-members:
+   :show-inheritance:
 .. automodule:: pyrad.proc.process_phase
    :members:
    :undoc-members:
@@ -29,7 +64,14 @@
    :special-members:
    :inherited-members:
    :show-inheritance:
-.. automodule:: pyrad.proc.process_calib
+.. automodule:: pyrad.proc.process_timeseries
+   :members:
+   :undoc-members:
+   :private-members:
+   :special-members:
+   :inherited-members:
+   :show-inheritance:
+.. automodule:: pyrad.proc.process_traj
    :members:
    :undoc-members:
    :private-members:

diff --git a/doc/pyrad/library_reference_developers/source/prod.rst b/doc/pyrad/library_reference_developers/source/prod.rst
@@ -15,3 +15,45 @@
    :special-members:
    :inherited-members:
    :show-inheritance:
+.. automodule:: pyrad.prod.process_vol_products
+   :members:
+   :undoc-members:
+   :private-members:
+   :special-members:
+   :inherited-members:
+   :show-inheritance:
+.. automodule:: pyrad.prod.process_grid_products
+   :members:
+   :undoc-members:
+   :private-members:
+   :special-members:
+   :inherited-members:
+   :show-inheritance:
+.. automodule:: pyrad.prod.process_timeseries_products
+   :members:
+   :undoc-members:
+   :private-members:
+   :special-members:
+   :inherited-members:
+   :show-inheritance:
+.. automodule:: pyrad.prod.process_monitoring_products
+   :members:
+   :undoc-members:
+   :private-members:
+   :special-members:
+   :inherited-members:
+   :show-inheritance:
+.. automodule:: pyrad.prod.process_intercomp_products
+   :members:
+   :undoc-members:
+   :private-members:
+   :special-members:
+   :inherited-members:
+   :show-inheritance:
+.. automodule:: pyrad.prod.process_traj_products
+   :members:
+   :undoc-members:
+   :private-members:
+   :special-members:
+   :inherited-members:
+   :show-inheritance:
diff --git a/doc/pyrad/library_reference_developers/source/util.rst b/doc/pyrad/library_reference_developers/source/util.rst
@@ -8,3 +8,10 @@
    :special-members:
    :inherited-members:
    :show-inheritance:
+.. automodule:: pyrad.util.stat_utils
+   :members:
+   :undoc-members:
+   :private-members:
+   :special-members:
+   :inherited-members:
+   :show-inheritance:
diff --git a/doc/pyrad_library_reference_dev.pdf b/doc/pyrad_library_reference_dev.pdf
diff --git a/doc/pyrad_library_reference_users.pdf b/doc/pyrad_library_reference_users.pdf
diff --git a/doc/pyrad_user_manual.docx b/doc/pyrad_user_manual.docx
diff --git a/doc/pyrad_user_manual.pdf b/doc/pyrad_user_manual.pdf
diff --git a/src/pyart b/src/pyart