Merge 011b234 into ff72a56

docs/api.rst

@@ -0,0 +1,42 @@
+.. currentmodule:: pvanalytics
+
+#############
+API Reference
+#############
+
+Quality
+=======
+
+Irradiance
+----------
+
+The ``check_*_limits_qcrad`` functions use the QCRad algorithm [1]_ to
+identify irradiance measurements that are beyond physical limits.
+
+.. autosummary::
+   :toctree: generated/
+
+   quality.irradiance.check_ghi_limits_qcrad
+   quality.irradiance.check_dhi_limits_qcrad
+   quality.irradiance.check_dni_limits_qcrad
+
+All three checks can be combined into a single function call.
+
+.. autosummary::
+   :toctree: generated/
+
+   quality.irradiance.check_irradiance_limits_qcrad
+
+Irradiance measurements can also be checked for consistency.
+
+.. autosummary::
+   :toctree: generated/
+
+   quality.irradiance.check_irradiance_consistency_qcrad
+
+.. rubric:: References
+
+.. [1]  C. N. Long and Y. Shi, An Automated Quality Assessment and Control
+        Algorithm for Surface Radiation Measurements, The Open Atmospheric
+        Science Journal 2, pp. 23-37, 2008.
+

docs/conf.py

@@ -10,9 +10,9 @@
 # add these directories to sys.path here. If the directory is relative to the
 # documentation root, use os.path.abspath to make it absolute, like shown here.
 #
-# import os
-# import sys
-# sys.path.insert(0, os.path.abspath('.'))
+import os
+import sys
+sys.path.insert(0, os.path.abspath('..'))
 
 
 # -- Project information -----------------------------------------------------
@@ -28,8 +28,13 @@
 # extensions coming with Sphinx (named 'sphinx.ext.*') or your custom
 # ones.
 extensions = [
+    'sphinx.ext.autodoc',
+    'sphinx.ext.autosummary',
+    'sphinx.ext.napoleon'
 ]
 
+autosummary_generate = True
+
 # Add any paths that contain templates here, relative to this directory.
 templates_path = ['_templates']
 

docs/index.rst

@@ -21,6 +21,9 @@ Contents
    :maxdepth: 2
    :caption: Contents:
 
+   api
+   licenses
+
 
 
 Indices and tables

docs/licenses.rst

@@ -0,0 +1,27 @@
+Licenses
+========
+
+* The implementation of the QCRad algorithm in
+  :py:mod:`pvanalytics.quality.irradiance` is derived from `solarforecastarbiter
+  <https://github.com/SolarArbiter/solarforecastarbiter-core>`_ under the
+  terms of the MIT License
+
+  Copyright (c) 2019 SolarArbiter
+
+  Permission is hereby granted, free of charge, to any person obtaining a copy
+  of this software and associated documentation files (the "Software"), to deal
+  in the Software without restriction, including without limitation the rights
+  to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+  copies of the Software, and to permit persons to whom the Software is
+  furnished to do so, subject to the following conditions:
+
+  The above copyright notice and this permission notice shall be included in all
+  copies or substantial portions of the Software.
+
+  THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+  IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+  FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+  AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+  LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+  OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+  SOFTWARE.