New documentation pages (#58)

* Change authors and copyright * New documentation proposal * Add motion docs * Add nowcasts docs * Add noise docs * Add utils docs * Add visualization docs * Add verification docs * Add timeseries docs * Add postprocessing docs * Fix doc strings * Remove sphinx warnings and fix style issues. * Remove repeated title
pySTEPS · Mar 19, 2019 · df090c0 · df090c0
1 parent d508bf0
commit df090c0
Show file tree

Hide file tree

Showing 88 changed files with 1,148 additions and 819 deletions.
diff --git a/doc/.gitignore b/doc/.gitignore
@@ -1,3 +1,2 @@
 _build/
-_static/
-_templates/
+generated
diff --git a/doc/_static/pysteps.css b/doc/_static/pysteps.css
@@ -0,0 +1,24 @@
+
+.section h1 {
+    border-bottom: 2px solid #0099ff;
+    display: inline-block;
+}
+
+.section h2 {
+    border-bottom: 2px solid #ccebff;
+    display: inline-block;
+}
+
+/* override table width restrictions */
+@media screen and (min-width: 767px) {
+
+   .wy-table-responsive table td {
+      /* !important prevents the common CSS stylesheets from overriding
+         this as on RTD they are loaded after this stylesheet */
+      white-space: normal !important;
+   }
+
+   .wy-table-responsive {
+      overflow: visible !important;
+   }
+}
diff --git a/doc/_templates/layout.html b/doc/_templates/layout.html
@@ -0,0 +1,2 @@
+{% extends "!layout.html" %}
+{% set css_files = css_files + ["_static/pysteps.css"] %}
diff --git a/doc/conf.py b/doc/conf.py
@@ -19,7 +19,6 @@
 # documentation root, use os.path.abspath to make it absolute, like shown here.
 #
 import os
-import re
 
 sys.path.insert(0, os.path.abspath('../'))
 
@@ -38,8 +37,9 @@
               'sphinx.ext.mathjax',
               'sphinx.ext.githubpages',
               'numpydoc',
-              'sphinxcontrib.bibtex']
-
+              'sphinxcontrib.bibtex'
+              ]
+#numpydoc_show_class_members = False
 # Add any paths that contain templates here, relative to this directory.
 templates_path = ['_templates']
 
@@ -54,8 +54,8 @@
 
 # General information about the project.
 project = u'pysteps'
-copyright = u'2018-2019, PySteps collaborators'
-author = u'PySteps collaborators'
+copyright = u'2018-2019, PySteps developers'
+author = u'PySteps developers'
 
 
 # The version info for the project you're documenting, acts as replacement for
@@ -106,7 +106,8 @@ def get_version():
 # a list of builtin themes.
 #
 # html_theme = 'alabaster'
-html_theme = 'classic'
+#html_theme = 'classic'
+html_theme = 'sphinx_rtd_theme'
 
 # Theme options are theme-specific and customize the look and feel of a theme
 # further.  For a list of options available for each theme, see the
@@ -133,6 +134,8 @@ def get_version():
 
 html_domain_indices = True
 
+autosummary_generate = True
+
 # -- Options for HTMLHelp output ------------------------------------------
 
 # Output file base name for HTML help builder.

diff --git a/doc/rebuild_docs.sh b/doc/rebuild_docs.sh
@@ -0,0 +1,7 @@
+# Build documentation from scratch.
+
+rm -r source/generated
+
+make clean
+
+make html
diff --git a/doc/requirements.txt b/doc/requirements.txt
@@ -0,0 +1,6 @@
+
+python>=3.6
+sphinx
+numpydoc
+sphinxcontrib.bibtex
+sphinx_rtd_theme
diff --git a/doc/source/_static/.gitignore b/doc/source/_static/.gitignore
diff --git a/doc/source/_templates/.gitignore b/doc/source/_templates/.gitignore
diff --git a/doc/source/cascade.rst b/doc/source/cascade.rst
diff --git a/doc/source/developer_reference/cascade.rst b/doc/source/developer_reference/cascade.rst
@@ -0,0 +1,12 @@
+===============
+pysteps.cascade
+===============
+
+Methods for constructing bandpass filters and decomposing 2d precipitation
+fields into different spatial scales.
+
+.. automodule:: pysteps.cascade.interface
+.. automodule:: pysteps.cascade.bandpass_filters
+.. automodule:: pysteps.cascade.decomposition
+
+
diff --git a/doc/source/developer_reference/extrapolation.rst b/doc/source/developer_reference/extrapolation.rst
@@ -0,0 +1,9 @@
+=====================
+pysteps.extrapolation
+=====================
+
+Extrapolation module functions and interfaces.
+
+.. automodule:: pysteps.extrapolation.interface
+.. automodule:: pysteps.extrapolation.semilagrangian
+
diff --git a/doc/source/developer_reference/index.rst b/doc/source/developer_reference/index.rst
@@ -0,0 +1,43 @@
+    .. _developer-reference:
+
+===================
+Developer reference
+===================
+
+:Release: |version|
+:Date: |today|
+
+This developer reference manual gives a detailed description of the modules,
+functions and objects included in pysteps.
+
+.. toctree::
+    :maxdepth: 2
+    :caption: Pysteps modules
+
+    cascade
+    extrapolation
+    io
+    motion
+    noise
+    nowcasts
+    postprocessing
+    timeseries
+    utils
+    verification
+    visualization
+
+.. only:: html
+
+    Indices and tables
+    ==================
+
+    * :ref:`genindex`
+    * :ref:`modindex`
+    * :ref:`search`
+
+.. only:: html
+
+    Bibliography
+    ------------
+
+    * :ref:`bibliography`
diff --git a/doc/source/developer_reference/io.rst b/doc/source/developer_reference/io.rst
@@ -0,0 +1,13 @@
+==========
+pysteps.io
+==========
+
+Methods for browsing data archives, reading 2d precipitation fields and writing 
+forecasts into files.
+
+.. automodule:: pysteps.io.interface
+.. automodule:: pysteps.io.archive
+.. automodule:: pysteps.io.importers
+.. automodule:: pysteps.io.nowcast_importers
+.. automodule:: pysteps.io.exporters
+.. automodule:: pysteps.io.readers
diff --git a/doc/source/developer_reference/motion.rst b/doc/source/developer_reference/motion.rst
@@ -0,0 +1,11 @@
+==============
+pysteps.motion
+==============
+
+Implementations of optical flow methods.
+
+
+.. automodule:: pysteps.motion.interface
+.. automodule:: pysteps.motion.darts
+.. automodule:: pysteps.motion.lucaskanade
+.. automodule:: pysteps.motion.vet
diff --git a/doc/source/developer_reference/noise.rst b/doc/source/developer_reference/noise.rst
@@ -0,0 +1,12 @@
+=============
+pysteps.noise
+=============
+
+Implementation of deterministic and ensemble nowcasting methods.
+
+
+.. automodule:: pysteps.noise.interface
+.. automodule:: pysteps.noise.fftgenerators
+.. automodule:: pysteps.nowcasts.sprog
+.. automodule:: pysteps.noise.motion
+.. automodule:: pysteps.noise.utils
diff --git a/doc/source/developer_reference/nowcasts.rst b/doc/source/developer_reference/nowcasts.rst
@@ -0,0 +1,13 @@
+================
+pysteps.nowcasts
+================
+
+Implementation of deterministic and ensemble nowcasting methods.
+
+
+.. automodule:: pysteps.nowcasts.interface
+.. automodule:: pysteps.nowcasts.extrapolation
+.. automodule:: pysteps.nowcasts.sprog
+.. automodule:: pysteps.nowcasts.sseps
+.. automodule:: pysteps.nowcasts.steps
+.. automodule:: pysteps.nowcasts.utils
diff --git a/doc/source/developer_reference/postprocessing.rst b/doc/source/developer_reference/postprocessing.rst
@@ -0,0 +1,10 @@
+======================
+pysteps.postprocessing
+======================
+
+Methods for post-processing of forecasts.
+
+
+.. automodule:: pysteps.postprocessing.ensemblestats
+.. automodule:: pysteps.postprocessing.probmatching
+
diff --git a/doc/source/developer_reference/timeseries.rst b/doc/source/developer_reference/timeseries.rst
@@ -0,0 +1,10 @@
+==================
+pysteps.timeseries
+==================
+
+Methods and models for time series analysis.
+
+
+.. automodule:: pysteps.timeseries.autoregression
+.. automodule:: pysteps.timeseries.correlation
+
diff --git a/doc/source/developer_reference/utils.rst b/doc/source/developer_reference/utils.rst
@@ -0,0 +1,14 @@
+=============
+pysteps.utils
+=============
+
+Implementation of miscellaneous utility functions.
+
+
+.. automodule:: pysteps.utils.interface
+.. automodule:: pysteps.utils.arrays
+.. automodule:: pysteps.utils.conversion
+.. automodule:: pysteps.utils.dimension
+.. automodule:: pysteps.utils.fft
+.. automodule:: pysteps.utils.spectral
+.. automodule:: pysteps.utils.transformation
diff --git a/doc/source/developer_reference/verification.rst b/doc/source/developer_reference/verification.rst
@@ -0,0 +1,14 @@
+====================
+pysteps.verification
+====================
+
+Methods for verification of deterministic, probabilistic and ensemble forecasts.
+
+.. automodule:: pysteps.verification.interface
+.. automodule:: pysteps.verification.detcatscores
+.. automodule:: pysteps.verification.detcontscores
+.. automodule:: pysteps.verification.ensscores
+.. automodule:: pysteps.verification.lifetime
+.. automodule:: pysteps.verification.plots
+.. automodule:: pysteps.verification.probscores
+.. automodule:: pysteps.verification.spatialscores
diff --git a/doc/source/developer_reference/visualization.rst b/doc/source/developer_reference/visualization.rst
@@ -0,0 +1,11 @@
+=====================
+pysteps.visualization
+=====================
+
+Methods for plotting precipitation and motion fields.
+
+.. automodule:: pysteps.visualization.animate
+.. automodule:: pysteps.visualization.motionfields
+.. automodule:: pysteps.visualization.precipfields
+.. automodule:: pysteps.visualization.spectral
+.. automodule:: pysteps.visualization.utils
diff --git a/doc/source/extrapolation.rst b/doc/source/extrapolation.rst