Create documentation skeleton

Documentation skeleton

.readthedocs.yaml

@@ -0,0 +1,12 @@
+# Required, this config file format version
+version: 2
+
+sphinx:
+  configuration: doc/OnlineDocs/source/conf.py
+
+formats: all
+
+# Set the version of Python and requirements required to build the docs
+python:
+  version: 3
+

doc/OnlineDocs/Makefile

@@ -0,0 +1,20 @@
+# Minimal makefile for Sphinx documentation
+#
+
+# You can set these variables from the command line, and also
+# from the environment for the first two.
+SPHINXOPTS    ?=
+SPHINXBUILD   ?= sphinx-build
+SOURCEDIR     = source
+BUILDDIR      = build
+
+# Put it first so that "make" without argument is like "make help".
+help:
+	@$(SPHINXBUILD) -M help "$(SOURCEDIR)" "$(BUILDDIR)" $(SPHINXOPTS) $(O)
+
+.PHONY: help Makefile
+
+# Catch-all target: route all unknown targets to Sphinx using the new
+# "make mode" option.  $(O) is meant as a shortcut for $(SPHINXOPTS).
+%: Makefile
+	@$(SPHINXBUILD) -M $@ "$(SOURCEDIR)" "$(BUILDDIR)" $(SPHINXOPTS) $(O)

doc/OnlineDocs/make.bat

@@ -0,0 +1,35 @@
+@ECHO OFF
+
+pushd %~dp0
+
+REM Command file for Sphinx documentation
+
+if "%SPHINXBUILD%" == "" (
+	set SPHINXBUILD=sphinx-build
+)
+set SOURCEDIR=source
+set BUILDDIR=build
+
+if "%1" == "" goto help
+
+%SPHINXBUILD% >NUL 2>NUL
+if errorlevel 9009 (
+	echo.
+	echo.The 'sphinx-build' command was not found. Make sure you have Sphinx
+	echo.installed, then set the SPHINXBUILD environment variable to point
+	echo.to the full path of the 'sphinx-build' executable. Alternatively you
+	echo.may add the Sphinx directory to PATH.
+	echo.
+	echo.If you don't have Sphinx installed, grab it from
+	echo.http://sphinx-doc.org/
+	exit /b 1
+)
+
+%SPHINXBUILD% -M %1 %SOURCEDIR% %BUILDDIR% %SPHINXOPTS% %O%
+goto end
+
+:help
+%SPHINXBUILD% -M help %SOURCEDIR% %BUILDDIR% %SPHINXOPTS% %O%
+
+:end
+popd

doc/OnlineDocs/source/_static/css/custom.css

@@ -0,0 +1,18 @@
+.wy-nav-content {
+    max-width: none;
+}
+
+.wy-table-responsive table td, .wy-table-responsive table th {
+    white-space: inherit;
+}
+
+.rst-content table.table-top-align-cells td,
+.rst-content table.table-top-align-cells th {
+    vertical-align: top;
+    word-break: break-word;
+}
+
+.rst-content table.table-wrap-headers th {
+    white-space: normal;
+    word-break: break-word;
+}

doc/OnlineDocs/source/concepts/index.rst

@@ -0,0 +1,9 @@
+Modeling Concepts
+-----------------
+
+.. toctree::
+   :maxdepth: 2
+
+   ruc_sced_cycle.rst
+   reserves.rst
+   markets.rst

doc/OnlineDocs/source/concepts/markets.rst

@@ -0,0 +1,3 @@
+Energy Markets and Pricing
+==========================
+

doc/OnlineDocs/source/concepts/reserves.rst

@@ -0,0 +1,2 @@
+Reserves and Ancillary Services
+===============================

doc/OnlineDocs/source/concepts/ruc_sced_cycle.rst

@@ -0,0 +1,42 @@
+The Prescient Simulation Cycle
+=============================================
+
+.. note::
+
+   This was taken from a previous write-up and needs to be revisited.
+
+Prescient simulates the operation of the network throughout a study horizon, finding
+the set of operational choices that satisfy demand at the lowest possible cost.
+
+Prescient loops through two repeating phases, the reliability unit commitment (RUC) phase and 
+the security constrained economic dispatch (SCED) phase.  The RUC phase determines which
+dispatchable generators will be active in upcoming operational time periods. For each operational
+period within a RUC cycle, the SCED phase selects the dispatch level of each committed thermal 
+generator.
+
+The RUC phase occurs one or more times per day.  Each time the RUC phase occurs, Prescient generates
+a unit commitment schedule that indicates which generators will be brought online or taken offline
+within the RUC's time horizon. The SCED phase occurs one or more times per hour.  Each SCED selects
+a thermal dispatch level for each committed generator.
+
+The RUC Phase
+-------------
+More detailed description of the RUC... 
+
+The RUC phase occurs one or more times per day.  Each time the RUC phase occurs, Prescient generates
+a unit commitment schedule that indicates which generators will be brought online or taken offline
+within the RUC's time horizon.  The RUC schedule may begin immediately, or it may begin a number of
+hours after the RUC is generated.
+
+The SCED Phase
+----------------
+More detailed description of the SCED, including a high level description of the optimization problem
+being solved, and possibly a conversational description of some things that can be tweaked (such as
+how often a SCED runs).
+
+.. _future-times-in-sceds:
+
+Future Values in SCEDs
+``````````````````````
+.. warning::
+   Coming soon.

doc/OnlineDocs/source/conf.py

@@ -0,0 +1,64 @@
+# Configuration file for the Sphinx documentation builder.
+#
+# This file only contains a selection of the most common options. For a full
+# list see the documentation:
+# https://www.sphinx-doc.org/en/master/usage/configuration.html
+
+# -- Path setup --------------------------------------------------------------
+
+# If extensions (or modules to document with autodoc) are in another directory,
+# 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('.'))
+
+
+# -- Project information -----------------------------------------------------
+
+project = 'Prescient'
+copyright = "Copyright 2020 National Technology & Engineering Solutions of Sandia, LLC" \
+            " (NTESS). Under the terms of Contract DE-NA0003525 with NTESS, the U.S." \
+            " Government retains certain rights in this software."
+author = 'Prescient Developers'
+
+# The full version, including alpha/beta/rc tags
+release = '2.0.2'
+
+
+# -- General configuration ---------------------------------------------------
+
+# Add any Sphinx extension module names here, as strings. They can be
+# extensions coming with Sphinx (named 'sphinx.ext.*') or your custom
+# ones.
+extensions = [
+]
+
+# Add any paths that contain templates here, relative to this directory.
+templates_path = ['_templates']
+
+# List of patterns, relative to source directory, that match files and
+# directories to ignore when looking for source files.
+# This pattern also affects html_static_path and html_extra_path.
+exclude_patterns = []
+
+
+# -- Options for HTML output -------------------------------------------------
+
+# The theme to use for HTML and HTML Help pages.  See the documentation for
+# a list of builtin themes.
+#
+# Comment this out to use the default.
+# To enable readthedocs theme on local builds, see https://readthedocsorg.readthedocs.io/en/latest/theme.html
+import sphinx_rtd_theme
+html_theme = 'sphinx_rtd_theme'
+
+# Add any paths that contain custom static files (such as style sheets) here,
+# relative to this directory. They are copied after the builtin static files,
+# so a file named "default.css" will overwrite the builtin "default.css".
+html_static_path = ['_static']
+
+html_css_files = [
+    'css/custom.css',
+]

doc/OnlineDocs/source/examples/index.rst

@@ -0,0 +1,2 @@
+Examples and Tutorials
+----------------------

doc/OnlineDocs/source/index.rst

@@ -0,0 +1,18 @@
+Prescient Documentation
+=======================
+
+.. toctree::
+   :maxdepth: 2
+   :caption: Contents:
+
+   tasks/index.rst
+   concepts/index.rst
+   examples/index.rst
+   reference/index.rst
+
+Indices and tables
+==================
+
+* :ref:`genindex`
+* :ref:`modindex`
+* :ref:`search`

doc/OnlineDocs/source/reference/code.rst

@@ -0,0 +1,2 @@
+Python Classes and Functions
+----------------------------

doc/OnlineDocs/source/reference/file_formats.rst

@@ -0,0 +1,10 @@
+File Formats
+------------
+
+RTS-GMLC
+~~~~~~~~
+This is the main input format.
+
+Pyomo DAT Files
+~~~~~~~~~~~~~~~
+Old way to do it.

doc/OnlineDocs/source/reference/index.rst

@@ -0,0 +1,9 @@
+Reference
+---------
+
+.. toctree::
+   :maxdepth: 2
+
+   file_formats.rst
+   code.rst
+