Merge branch 'master' into documentation_fix

Author: AadilLatif

docs/source/_autosummary/PyDSS.api.src.app.pydss.rst

@@ -3,21 +3,11 @@ pydss.api.src.app.pydss
 
 .. automodule:: pydss.api.src.app.pydss
 
-   
-   
-   
-
-   
-   
-   
-
-   
-   
    .. rubric:: Classes
 
    .. autosummary::
 
-      PyDSS
+      pydss
 
 
 

docs/source/_autosummary/PyDSS.rst

@@ -1,4 +1,5 @@
-pydss
+
+Pydss
 =====
 
 .. automodule:: pydss

docs/source/co-simulation_support.rst

@@ -1,7 +1,7 @@
 Co-simulation interfaces
 =========================
 
-PyDSS provides two pathways for configuring pydss for a co-simulation with external simulators. 
+Pydss provides two pathways for configuring pydss for a co-simulation with external simulators. 
 These interface help researchers cut lead time in setting up and configuring co-simulation setups to 
 simulate cyber phsical interactions by coupling multiple domain scepific tools. Each interface has 
 certain pros and cons detailed in the documentation pages.

docs/source/conf.py

@@ -16,15 +16,8 @@
 import re
 # import sys
 
-# my_path = os.path.abspath('../PyDSS')
-# print(f"{my_path=}")
-# sys.path.insert(0, os.path.abspath('../PyDSS'))
 
 import sphinx_rtd_theme
-# import pydss
-# import pydss
-# import pydss.simulation_input_models
-#from pydss.simulation_input_models import SimulationSettingsModel, ProjectModel
 
 # -- Project information -----------------------------------------------------
 

docs/source/hdf-data-format.rst

@@ -1,7 +1,7 @@
 ###############
 HDF Data Format
 ###############
-This page describes the format pydss uses to export data in an HDF file. PyDSS
+This page describes the format pydss uses to export data in an HDF file. Pydss
 contains code to convert the raw data to pandas.DataFrame objects or Python
 dictionaries, so normal users should not need to write their own tools to
 interpret the data.

docs/source/interfaces.rst

@@ -1,7 +1,7 @@
 Interfaces
 =========================
 
-PyDSS provides three easy to configure external interfaces. These interface help researchers cut lead time in setting up and configuring co-simulation setups to simulate cyber phsical interactions by coupling multiple domain scpific tools. The 'External_interfacing_example' project in the examples folder provides examples on how to set up and use each of these interfaces.
+Pydss provides three easy to configure external interfaces. These interface help researchers cut lead time in setting up and configuring co-simulation setups to simulate cyber phsical interactions by coupling multiple domain scpific tools. The 'External_interfacing_example' project in the examples folder provides examples on how to set up and use each of these interfaces.
 
 .. toctree::
    :maxdepth: 3

docs/source/project_layout.rst

@@ -1,7 +1,7 @@
 .. _pydss_project_layout:
 
 ********************
-PyDSS Project Layout
+Pydss Project Layout
 ********************
 A pydss project is made up of one or more scenarios that run simulations on a shared OpenDSS
 model. The purpose of scenarios is to allow users to customize inputs, outputs, or controls.

docs/source/quickstart.rst

@@ -5,14 +5,14 @@ Quick Start Guide
 *****************
 
 This page provides a short example to get pydss up and running. If you have not already installed
-PyDSS, please follow the instructions at :ref:`installation_label`.
+pydss, please follow the instructions at :ref:`installation_label`.
 
 The basic steps are to create an empty project, copy your OpenDSS model files into that project,
 customize the simuation settings, and then run the simulation.
 
 Create an empty project
 =======================
-PyDSS requires a specific directory structure with configuration files that specify how to run a
+Pydss requires a specific directory structure with configuration files that specify how to run a
 simulation. Run this command to create an empty project.
 
 .. code-block:: bash

docs/source/reports.rst

@@ -69,7 +69,7 @@ This can be useful for debugging purposes when you develop your own reports.
 ***********
 Output Data
 ***********
-PyDSS stores generated reports in ``<project-path>/Reports``.
+Pydss stores generated reports in ``<project-path>/Reports``.
 
 ******************
 Adding New Reports

docs/source/spec/swagger.yml

@@ -160,7 +160,7 @@ paths:
         required: true
         schema:
           type: string
-          example: C:/Users/alatif/Desktop/PyDSS_2.0/PyDSS/examples
+          example: C:/Users/alatif/Desktop/pydss_2.0/pydss/examples
         style: form
         explode: true
       responses:
@@ -205,7 +205,7 @@ paths:
         required: true
         schema:
           type: string
-          example: C:/Users/alatif/Desktop/PyDSS_2.0/PyDSS/examples
+          example: C:/Users/alatif/Desktop/pydss_2.0/pydss/examples
         style: form
         explode: true
       responses:
@@ -241,7 +241,7 @@ paths:
                     UUID: None
   "/simulators/pydss":
     put:
-      summary: Run a command on an active instance of PyDSS
+      summary: Run a command on an active instance of pydss
       tags:
       - Simulation
       requestBody:
@@ -330,15 +330,15 @@ paths:
                     Error tolerance: 0.001
                     Control mode: Static
                     Simulation Type: QSTS
-                    Project Path: C:/Users/alatif/Desktop/PyDSS_2.0/PyDSS/examples
+                    Project Path: C:/Users/alatif/Desktop/pydss_2.0/pydss/examples
                     Active Project: custom_contols
                     Active Scenario: base_case
                     DSS File: Master_Spohn_existing_VV.dss
                     Co-simulation Mode: false
                     Log Results: false
                     Export Data Tables: true
                     Export Data In Memory: true
-                    Federate name: PyDSS_x
+                    Federate name: pydss_x
         required: false
       responses:
         '200':
@@ -366,7 +366,7 @@ paths:
                     Message: Failed to create a pydss instance
                     UUID: None
     delete:
-      summary: Deletes an active instance of PyDSS
+      summary: Deletes an active instance of pydss
       tags:
       - Simulation
       parameters: