Moving demos and progress on sphinx

docs/sphinx/source/api.rst

@@ -1,5 +1,5 @@
-API
-===
+Other Functions
+===============
 
 .. autosummary::
     :toctree: generated

docs/sphinx/source/cmv.rst

@@ -1,7 +1,5 @@
-solartoolbox.cmv module
------------------------
+Cloud Motion Vector Identification
+----------------------------------
 
 .. automodule:: solartoolbox.cmv
-   :members:
-   :undoc-members:
-   :show-inheritance:
+   :members: compute_cmv, optimum_subset

docs/sphinx/source/conf.py

@@ -25,6 +25,7 @@
               'sphinx.ext.autodoc',
               'sphinx.ext.autosummary',
               'sphinx.ext.intersphinx',
+              'nbsphinx',
               ]
 
 intersphinx_mapping = {
@@ -39,9 +40,12 @@
 # -- Options for HTML output -------------------------------------------------
 # https://www.sphinx-doc.org/en/master/usage/configuration.html#options-for-html-output
 
-html_theme = 'alabaster'
+html_theme = 'sphinx_rtd_theme'
 html_static_path = ['_static']
 
+# Control the display of class members
+autodoc_member_order = 'bysource'
 
 # -- Options for EPUB output
-epub_show_urls = 'footnote'
+epub_show_urls = 'footnote'
+

demos/automate_cmv_demo.ipynb → docs/sphinx/source/demos/automate_cmv_demo.ipynb

@@ -4,7 +4,8 @@
    "metadata": {},
    "cell_type": "markdown",
    "source": [
-    "# Automation of CMV Detection for Large Time Series\n",
+    "# CMV Automation\n",
+    "## CMV Process for Large Time Series\n",
     "\n",
     "When applying the field analysis methodology, there is often an extensive dataset available showing, e.g. time series data for a plant over the course of an entire year or longer. In order to apply the method, it is necessary to obtain reduce the CMVs to a subset for which the method can be applied, because simply calculating for every possible cloud motion vector pair is computationally intractable. \n",
     "\n",
@@ -272,7 +273,7 @@
    "metadata": {},
    "cell_type": "markdown",
    "source": [
-    "# Downselect to High Quality CMVs\n",
+    "## Downselect to High Quality CMVs\n",
     "We can now downselect to only the highest quality CMVs. The limits shown here are just for reference based off this dataset. They probably need to be tuned to each specific dataset to appropriately limit the CMVs. The printout shows the ones that failed the QC."
    ],
    "id": "c379e843cd5efa35"

demos/field_demo_detailed.ipynb → docs/sphinx/source/demos/field_demo_detailed.ipynb

@@ -66,7 +66,7 @@
     "\n",
     "The second component is the dataframes for the two one hour periods. These dataframes consist of a single column for each combiner containing the time series for a one hour period period during which the cloud motion vector was relatively constant. The CMVs are manually specified here to save on computational time, with `cmv_a` corresponding to `data_a` and so on.  \n",
     "\n",
-    "# Calculation Process\n",
+    "## Calculation Process\n",
     "The calculation is carried out for a single combiner at a time. We will term this combiner of interest the target, $P_1$. Our goal is to compute a prediction, $P'_1$, of the target's location. The process is as follows:\n",
     "1. Isolate time period of a fixed CMV, $V_A$. \n",
     "2. Compute the delay, $\\tau_{A,i}$, between target time series and that for each other combiner, $P_{2,i}$. \n",

demos/field_reassignment_demo.ipynb → docs/sphinx/source/demos/field_reassignment_demo.ipynb

@@ -4,7 +4,8 @@
    "metadata": {},
    "cell_type": "markdown",
    "source": [
-    "# Automatic Position Reassignment\n",
+    "# Field Analysis Automated Reassignment\n",
+    "\n",
     "This demo will show the method for automatically reassigning the position of combiners within a plant, based on the output of the `field` routines. The automated method described here was reported in a conference article: \n",
     "- J. Ranalli and W. Hobbs, \"Automating Methods for Validating PV Plant Equipment Labels\", 2024, IEEE PV Specialists Conference.  \n",
     "\n",

demos/plant_digitization_example.ipynb → docs/sphinx/source/demos/plant_digitization_example.ipynb

@@ -4,7 +4,7 @@
    "cell_type": "markdown",
    "metadata": {},
    "source": [
-    "# Digitising plant layout data\n",
+    "# Digitizing Plant Layout Data\n",
     "\n",
     "There are serveral possible ways to digitize the plant's combiner layout data. Here is a partial overview of one way to do it using the open-source geographic information system (GIS) tool QGIS [1, 2]. There are also commercial GIS tools, as well as web-based tools like https://geojson.io/ that could possibly work. \n",
     "\n",

docs/sphinx/source/examples.rst

@@ -0,0 +1,26 @@
+CMV Examples
+------------
+
+.. toctree::
+   :maxdepth: 1
+
+   demos/cmv_demo
+   demos/automate_cmv_demo
+
+Field Analysis Examples
+-----------------------
+
+.. toctree::
+   :maxdepth: 1
+
+   demos/field_demo
+   demos/field_demo_detailed
+   demos/field_reassignment_demo
+
+Other Examples
+--------------
+
+.. toctree::
+   :maxdepth: 1
+
+   demos/plant_digitization_example

docs/sphinx/source/field.rst

@@ -1,7 +1,5 @@
-solartoolbox.field module
--------------------------
+Plant Field Validation
+----------------------
 
 .. automodule:: solartoolbox.field
-   :members:
-   :undoc-members:
-   :show-inheritance:
+   :members: compute_predicted_position, compute_delays, assign_positions, remap_positions, cascade_remap

docs/sphinx/source/index.rst

@@ -3,14 +3,36 @@
    You can adapt this file completely to your liking, but it should at least
    contain the root `toctree` directive.
 
-solartoolbox documentation
+SolarToolbox documentation
 ==========================
 
+``solartoolbox`` is a python package containing implementations of various spatial algorithms for solar energy data. While excellent open source solar energy packages already exist (e.g. `pvlib-python <https://github.com/pvlib/pvlib-python>`_ and `pvanalytics <https://github.com/pvlib/pvanalytics>`_), the complexity of some high-level analyses found in the academic literature makes them as a poor fit for the scope of existing packages. This package fills that gap by implementing techniques that we hope can facilitate common spatial tasks for solar energy researchers and provide a platform for consistency and efficiency improvements in these calculations.
+
+
+Installation
+------------
+The package can be most easily installed via `PyPi <https://pypi.org/project/solartoolbox/>`_ with the following command::
+
+        pip install solartoolbox
+
+
+
+
 Add your content using ``reStructuredText`` syntax. See the
 `reStructuredText <https://www.sphinx-doc.org/en/master/usage/restructuredtext/index.html>`_
 documentation for details.
 
-
 .. toctree::
+   :maxdepth: 1
+   :caption: API Reference
+
+   cmv
+   field
    api
 
+.. toctree::
+   :maxdepth: 2
+   :caption: Examples
+
+   examples
+