updating the DER documentation, adding some CDPSM sub-headings

docs/.gitignore

@@ -0,0 +1 @@
+gridappsd-python

docs/requirements.txt

@@ -1,4 +1,3 @@
-javasphinx
 sphinx
 sphinx-autobuild
 sphinx-rtd-theme

docs/source/api_docs/index.rst

@@ -28,6 +28,6 @@ GridLAB-D
 
 GridLAB-D is the distribution grid simulator within the platform; its overall design is described in [CIT8]_.
 
-.. include:: gridlabd-cim.rst
+gridlabd-cim.rst is not included, until we have a replacement for Javasphinx
 
 

docs/source/conf.py

@@ -36,7 +36,6 @@
 # ones.
 extensions = [
     'sphinx.ext.autodoc',
-    'javasphinx',
     'sphinx.ext.intersphinx',
     'sphinx.ext.todo',
     'sphinx.ext.coverage',
@@ -52,9 +51,6 @@
 from recommonmark.parser import CommonMarkParser
 
 # The suffix(es) of source filenames.
-# You can specify multiple suffix as a list of string:
-#
-# source_suffix = ['.rst', '.md']
 source_suffix = ['.rst', '.md']
 
 source_parsers = {
@@ -66,7 +62,7 @@
 
 # General information about the project.
 project = 'GridAPPS-D'
-copyright = '2017-2018, Battelle Memorial Institute All rights reserved.'
+copyright = '2017-2021, Battelle Memorial Institute All rights reserved.'
 author = 'The GridAPPS-D Team and Community'
 
 # The version info for the project you're documenting, acts as replacement for
@@ -258,7 +254,7 @@ def setup(app):
 
 
 def build_gridappsd_python_api(app):
-    repo_path = os.path.abspath('./griappsd-python')
+    repo_path = os.path.abspath('./gridappsd-python')
     from git import Repo
     import subprocess
     url = "https://github.com/gridappsd/gridappsd-python"

docs/source/developer_resources/CIM_Validation.rst

@@ -16,7 +16,7 @@ applications.
 
 To represent the model, CIM is written using the Unified Modeling 
 Language (UML) using Sparx Enterprise Architect. The model is stored 
-in a project file (*.eap extension file).  GridAPPS-D extends the CIM 
+in a project file (\*.eap extension file).  GridAPPS-D extends the CIM 
 to meet its application specific needs. UML (Object Management Group 
 UML 2.5 Specification) profiles are secondary models, derived from 
 the primary information model.  Profiles represent a portion of the 
@@ -77,7 +77,7 @@ report for CIM100 can be compared against the GridAPPS-D CIMv100.
 
 
 Well-Formed and Valid Profile 
-^^^^^^^^^^^^^^^^^^^
+^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
 CIMTool can not only create Resource Description Framework Schema (RDFS) 
 profiles from the CIM100 UML, it can also validate the generated profiles 
 or created RDF datasets against CIM100 schema.  GridAPPS-D has plans to 

docs/source/hosted_applications/NREL_APPS/Grid_Forecasting.rst

@@ -11,7 +11,7 @@ Design
 
 This application develops a high-resolution, short-term load forecasting method to accurately predict the power consumption of individual customers in distribution systems. Using historical load measurements as inputs, it trains a support vector regression model to forecast the future load. Based on the forecasted load in the short-term future, this application develops a three-phase AC optimal power flow problem to determine the predictive DLMPs in distribution systems. By accurately modeling the losses and the imbalances of distribution networks, it provides time- and location-specific pricing of individual resources.
 
-|nrel_OPF_image0|
+|nrel_OPF_image2|
 
 Operating/Running
 ~~~~~~~~~~~~~~~~~
@@ -25,4 +25,4 @@ References
 [2]	R. Yang and Y. Zhang, “Three-Phase AC Optimal Power Flow Based Distribution Locational Marginal Price,” IEEE Innovative Smart Grid Technologies, Arlington, VA, Apr. 2017.
 
 
-.. |nrel_OPF_image0| image:: NREL_APPS/media/Grid_Forecasting.png
+.. |nrel_OPF_image2| image:: NREL_APPS/media/Grid_Forecasting.png

docs/source/license/license.md

@@ -1,9 +1,7 @@
-# License
+License
+=======
 
-<div>
-Copyright &copy; 2017, Battelle Memorial Institute All rights reserved.
-</div>
-
+Copyright © 2017-2021, Battelle Memorial Institute All rights reserved.
 
 1. Battelle Memorial Institute (hereinafter Battelle) hereby grants permission to any person or entity lawfully obtaining a copy of this software and associated documentation files (hereinafter the Software) to redistribute and use the Software in source and binary forms, with or without modification. Such person or entity may use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and may permit others to do so, subject to the following conditions:
 
@@ -15,21 +13,18 @@ Copyright &copy; 2017, Battelle Memorial Institute All rights reserved.
 
 2. THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL BATTELLE OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
 
-General disclaimer for use with OSS licenses
+**General disclaimer for use with OSS licenses**
 
 This material was prepared as an account of work sponsored by an agency of the United States Government. Neither the United States Government nor the United States Department of Energy, nor Battelle, nor any of their employees, nor any jurisdiction or organization that has cooperated in the development of these materials, makes any warranty, express or implied, or assumes any legal liability or responsibility for the accuracy, completeness, or usefulness or any information, apparatus, product, software, or process disclosed, or represents that its use would not infringe privately owned rights.
 
 Reference herein to any specific commercial product, process, or service by trade name, trademark, manufacturer, or otherwise does not necessarily constitute or imply its endorsement, recommendation, or favoring by the United States Government or any agency thereof, or Battelle Memorial Institute. The views and opinions of authors expressed herein do not necessarily state or reflect those of the United States Government or any agency thereof.
 
-<p style="text-align: center;"> PACIFIC NORTHWEST NATIONAL LABORATORY</p>
+::
 
-<p style="text-align: center;">operated by</p>
-
-<p style="text-align: center;">BATTELLE</p>
-
-<p style="text-align: center;">for the</p>
-
-<p style="text-align: center;">UNITED STATES DEPARTMENT OF ENERGY</p>
-
-<p style="text-align: center;">under Contract DE-AC05-76RL01830  </p>
+ PACIFIC NORTHWEST NATIONAL LABORATORY
+             operated by
+              BATTELLE
+               for the
+  UNITED STATES DEPARTMENT OF ENERGY
+   under Contract DE-AC05-76RL01830
 

docs/source/overview/version_history.rst

@@ -653,7 +653,7 @@ Version 2020.04.0
 	- Corrected json parse method for TimeSeriesRequest class.
 	- Viz app: Updated to use simulation timestamp for voltage violation instead of current time.	
 	- Viz app: Show "Simulation starting" message before simulation is started and hide the Pause/Stop buttons.
-	- Powergrid model: Added scripts and *uuid.dat files to maintain persistent mRID values
+	- Powergrid model: Added scripts and \*uuid.dat files to maintain persistent mRID values
 	- Powergrid model: Supporting OverheadLineUnbalanced, ganged regulators and unknown spacings for 1-phase and 2-phase line. 
 	- Integration testing infrastructure create with PyTest and Travis. 
 

docs/source/using_gridappsd/Developing_Apps.rst

@@ -190,7 +190,8 @@ Following is the recommended structure for services working with gridappsd using
 Config file is used by GridAPPS-D platform to register and launch the service. 
 Here is the config file example using gridappsd-state-estimator:
 
-:: 
+::
+
 	{
 		"id":"state-estimator",
 		"description":"State Estimator",

docs/source/using_gridappsd/api_examples/config_data_manager.rst

@@ -83,7 +83,8 @@ Request:  goss.gridappsd.process.request.config
 
 Response:
 ::
-{"feeders":[
+
+  {"feeders":[
   {"name":"ieee123",
     "mRID":"_C1C3E687-6FFD-C753-582B-632A27E28507",
     "substation":"IEEE123",
@@ -157,8 +158,8 @@ Response:
 ::
 
   {"feeders":[
-{"name":"test9500new","mRID":"_AAE94E4A-2465-6F5E-37B1-3E72183A4E44","substationName":"ThreeSubs","substationID":"_40485321-9B2C-1B8C-EC33-39D2F7948163","subregionName":"Large","subregionID":"_A1170111-942A-6ABD-D325-C64886DC4D7D","regionName":"IEEE","regionID":"_73C512BD-7249-4F50-50DA-D93849B89C43"},
-{"name":"ieee123","mRID":"_C1C3E687-6FFD-C753-582B-632A27E28507","substationName":"IEEE123","substationID":"_FE44B314-385E-C2BF-3983-3A10C6060022","subregionName":"Medium","subregionID":"_1CD7D2EE-3C91-3248-5662-A43EFEFAC224","regionName":"IEEE","regionID":"_73C512BD-7249-4F50-50DA-D93849B89C43"},
+  {"name":"test9500new","mRID":"_AAE94E4A-2465-6F5E-37B1-3E72183A4E44","substationName":"ThreeSubs","substationID":"_40485321-9B2C-1B8C-EC33-39D2F7948163","subregionName":"Large","subregionID":"_A1170111-942A-6ABD-D325-C64886DC4D7D","regionName":"IEEE","regionID":"_73C512BD-7249-4F50-50DA-D93849B89C43"},
+  {"name":"ieee123","mRID":"_C1C3E687-6FFD-C753-582B-632A27E28507","substationName":"IEEE123","substationID":"_FE44B314-385E-C2BF-3983-3A10C6060022","subregionName":"Medium","subregionID":"_1CD7D2EE-3C91-3248-5662-A43EFEFAC224","regionName":"IEEE","regionID":"_73C512BD-7249-4F50-50DA-D93849B89C43"},
   .......
   ]}
 
@@ -272,7 +273,7 @@ Response:
   .......
 
 Request OpenDSS Coordinates File
-^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
+^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
 Generates the symbols file with XY coordinates used by the OpenDSS simulator
 
 - Required: configurationType, parameters[model_id]
@@ -291,27 +292,27 @@ Request:  goss.gridappsd.process.request.config
 Response:
 ::
 
-88,2950.0,1300.0
-89,2775.0,1125.0
-197,3525.0,2200.0
-110,4275.0,3050.0
-111,4275.0,3625.0
-112,4275.0,2925.0
-113,4800.0,2925.0
-114,5125.0,2925.0
-90,2775.0,900.0
-61s,3175.0,1300.0
-91,2550.0,1125.0
-92,2550.0,825.0
-93,2325.0,1125.0
-94,2325.0,850.0
-95,2025.0,1125.0
-96,2025.0,925.0
-97,3525.0,2100.0
-98,3800.0,2100.0
-10,1450.0,2150.0
-99,4350.0,2100.0
-11,950.0,2150.0
+  88,2950.0,1300.0
+  89,2775.0,1125.0
+  197,3525.0,2200.0
+  110,4275.0,3050.0
+  111,4275.0,3625.0
+  112,4275.0,2925.0
+  113,4800.0,2925.0
+  114,5125.0,2925.0
+  90,2775.0,900.0
+  61s,3175.0,1300.0
+  91,2550.0,1125.0
+  92,2550.0,825.0
+  93,2325.0,1125.0
+  94,2325.0,850.0
+  95,2025.0,1125.0
+  96,2025.0,925.0
+  97,3525.0,2100.0
+  98,3800.0,2100.0
+  10,1450.0,2150.0
+  99,4350.0,2100.0
+  11,950.0,2150.0
   .......
 
 

docs/source/using_gridappsd/api_examples/timeseries_data_api.rst

@@ -127,8 +127,9 @@ Allowed values for queryFilter are:
 	object [string]
 	value [number]
 
-Please find some sample requests with various query filters
+Please find some sample requests with various query filters:
 ::
+
 	{"queryMeasurement": "simulation",
  	"queryFilter": {"simulation_id": "582881157", "hasSimulationMessageType": "INPUT"},
 	"responseFormat": "JSON"}
@@ -155,8 +156,9 @@ Example Request:
 	"responseFormat": "JSON"}
 
 Example Response for result format JSON:
-::	
-		{
+::
+
+	{
 			"data": {
 			"measurements": [
 				{

docs/source/using_gridappsd/index.rst

@@ -60,6 +60,8 @@ Simulation API
 Timeseries API
 --------------
 
+.. include:: Query_Timeseries.rst
+
 .. include:: api_examples/timeseries_data_api.rst
 
 Services