Skip to content

Commit

Permalink
lower casing pydss
Browse files Browse the repository at this point in the history
  • Loading branch information
@AadilLatif
AadilLatif committed Mar 22, 2024
1 parent 44f01b5 commit 7f10380
Show file tree
Hide file tree
Showing 73 changed files with 209 additions and 209 deletions.
12 changes: 6 additions & 6 deletions DESCRIPTION.rst
View file
Original file line number Diff line number Diff line change
@@ -1,20 +1,20 @@
# Welcome to the PyDSS Repository!
# Welcome to the pydss Repository!

**PyDSS** is a high level python interface for **OpenDSS** and provides the following functionalities

**1] Object oriented programming -** OpenDSS is a text based simulation environment. To improve upon the usability of the Python interface, PyDSS wraps each element (PD elements, PC elements, Bus and Circuits) as a object in python. Each of these objects have functions that facilitate
**1] Object oriented programming -** OpenDSS is a text based simulation environment. To improve upon the usability of the Python interface, pydss wraps each element (PD elements, PC elements, Bus and Circuits) as a object in python. Each of these objects have functions that facilitate

**2] Dynamic visualization -** PyDSS uses **Bokeh** to render dynamic plots during simulation runs. The current version includes six plots. These include
**2] Dynamic visualization -** pydss uses **Bokeh** to render dynamic plots during simulation runs. The current version includes six plots. These include

- time series plots
- XY plots
- Voltage distance plots
- Topology plots
- GIS overlay plots
- Histograms
**3] Custom controls -** The main idea behind PyDSS was to come up with a modular approach for adding custom controls to model real systems. New controllers can be added to PyDSS using very little effort. The tool uses outer loop iteration to converge to a steady state solution.
**3] Custom controls -** The main idea behind pydss was to come up with a modular approach for adding custom controls to model real systems. New controllers can be added to pydss using very little effort. The tool uses outer loop iteration to converge to a steady state solution.

**4] Simulation parallelization -** PyDSS also facilitates simulating multiple scenarios in parallel thus reducing total computation time
**4] Simulation parallelization -** pydss also facilitates simulating multiple scenarios in parallel thus reducing total computation time

**5] Exporting results -** The tool provides multiple options for exporting simulation results. These include options like exporting as a single file or separate files, exporting by element or by class etc.

Expand All @@ -41,7 +41,7 @@ Additionally, GIS overlay maps require installation of PyProj and a Google maps

# Bokeh rendering bug fix

Some users have experinced PyDSS halting when Bokeh visulation is used. In all cases tornado and bokeh compatability has been the culprit (until now). The following steps have been able to fix the problem
Some users have experinced pydss halting when Bokeh visulation is used. In all cases tornado and bokeh compatability has been the culprit (until now). The following steps have been able to fix the problem

- pip uninstall bokeh
- pip uninstall tornado
Expand Down
36 changes: 18 additions & 18 deletions PyDSS/api/schema/PyDSS.v1.json
View file
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
{
"info": {
"description": "The API enables creating PyDSS instances, running simulations and creation of new projects.",
"description": "The API enables creating pydss instances, running simulations and creation of new projects.",
"title": "PyDSS RESTful API documentation",
"version": "2.0.0"
},
Expand Down Expand Up @@ -29,7 +29,7 @@
"examples": {
"get_instance_status": {
"value": {
"Message": "Successfully deleted a PyDSS instance",
"Message": "Successfully deleted a pydss instance",
"Status": 200,
"UUID": "96c21e00-cd3c-4943-a914-14451f5f7ab6"
}
Expand All @@ -48,7 +48,7 @@
"examples": {
"get_instance_status": {
"value": {
"Message": "Error closing PyDSS instance",
"Message": "Error closing pydss instance",
"Status": 403,
"UUID": "None"
}
Expand Down Expand Up @@ -118,7 +118,7 @@
"examples": {
"get_instance_status": {
"value": {
"Message": "Starting a PyDSS instance",
"Message": "Starting a pydss instance",
"Status": 200,
"UUID": "96c21e00-cd3c-4943-a914-14451f5f7ab6"
}
Expand All @@ -137,7 +137,7 @@
"examples": {
"get_instance_status": {
"value": {
"Message": "Failed to create a PyDSS instance",
"Message": "Failed to create a pydss instance",
"Status": 500,
"UUID": "None"
}
Expand All @@ -151,7 +151,7 @@
"description": "Provided path does not exist"
}
},
"summary": "Creates an instance of PyDSS and runs the simulation",
"summary": "Creates an instance of pydss and runs the simulation",
"tags": [
"Simulation"
]
Expand Down Expand Up @@ -235,7 +235,7 @@
"examples": {
"get_instance_status": {
"value": {
"Message": "Provided UUID is not valid PyDSS instance id",
"Message": "Provided UUID is not valid pydss instance id",
"Status": 403,
"UUID": "None"
}
Expand Down Expand Up @@ -263,7 +263,7 @@
"schema": {
"properties": {
"controller_types": {
"description": "comma separated list of PyDSS controller names",
"description": "comma separated list of pydss controller names",
"example": "PvController,StorageController",
"type": "string"
},
Expand All @@ -280,7 +280,7 @@
"type": "string"
},
"scenarios": {
"description": "comma separated list of PyDSS scenarios to be created",
"description": "comma separated list of pydss scenarios to be created",
"example": "base_case,pv_scenario",
"type": "string"
}
Expand Down Expand Up @@ -332,7 +332,7 @@
"description": "Provided path does not exist"
}
},
"summary": "Creates a new project for PyDSS (User uploads a zipped OpenDSS model)",
"summary": "Creates a new project for pydss (User uploads a zipped OpenDSS model)",
"tags": [
"PyDSS project"
]
Expand Down Expand Up @@ -485,7 +485,7 @@
"examples": {
"get_instance_status": {
"value": {
"Message": "2 PyDSS instances currently running",
"Message": "2 pydss instances currently running",
"Status": 200,
"UUID": []
}
Expand All @@ -496,15 +496,15 @@
}
}
},
"description": "UUIDs of all currently running PyDSS instances have been returned"
"description": "UUIDs of all currently running pydss instances have been returned"
},
"204": {
"content": {
"application/json": {
"examples": {
"get_instance_status": {
"value": {
"Message": "No PyDSS instance currently running",
"Message": "No pydss instance currently running",
"Status": 204,
"UUID": [
"96c21e00-cd3c-4943-a914-14451f5f7ab6",
Expand All @@ -518,7 +518,7 @@
}
}
},
"description": "No active PyDSS instance found"
"description": "No active pydss instance found"
}
},
"summary": "Returns UUIDs of all the instances currently running on the server",
Expand All @@ -534,7 +534,7 @@
"examples": {
"get_instance_status": {
"value": {
"Message": "2 PyDSS instances currently running",
"Message": "2 pydss instances currently running",
"Status": 200,
"UUID": []
}
Expand All @@ -545,15 +545,15 @@
}
}
},
"description": "UUIDs of all currently running PyDSS instances have been returned"
"description": "UUIDs of all currently running pydss instances have been returned"
},
"204": {
"content": {
"application/json": {
"examples": {
"get_instance_status": {
"value": {
"Message": "No PyDSS instance currently running",
"Message": "No pydss instance currently running",
"Status": 204,
"UUID": [
"96c21e00-cd3c-4943-a914-14451f5f7ab6",
Expand All @@ -567,7 +567,7 @@
}
}
},
"description": "No active PyDSS instance found"
"description": "No active pydss instance found"
}
},
"summary": "Returns UUIDs of all the instances currently running on the server",
Expand Down
2 changes: 1 addition & 1 deletion PyDSS/api/server.py
View file
Original file line number Diff line number Diff line change
Expand Up @@ -51,7 +51,7 @@ def __init__(self, host, port):
self.app,
title="PyDSS RESTful API documentation",
version=find_version("__init__.py"),
description = "The API enables creating PyDSS instances, running simulations and creation of new projects.",
description = "The API enables creating pydss instances, running simulations and creation of new projects.",
swagger_ui_settings=SwaggerUiSettings(path="/docs/"),
# components="components.yaml"
)
Expand Down
6 changes: 3 additions & 3 deletions PyDSS/api/src/app/pydss.py
View file
Original file line number Diff line number Diff line change
Expand Up @@ -34,7 +34,7 @@ def __init__(self, event=None, queue=None, parameters=None):
self.a_writer = JSONwriter(export_path, Steps)
self.initalized = True
except:
result = {"Status": 500, "Message": f"Failed to create a PyDSS instance"}
result = {"Status": 500, "Message": f"Failed to create a pydss instance"}
self.queue.put(result)
return

Expand Down Expand Up @@ -71,8 +71,8 @@ def run_process(self):
status, msg = func(parameters)
result = {"Status": status, "Message": msg, "UUID": self.uuid}
else:
logger.info(f"{command} is not a valid PyDSS command")
result = {"Status": 500, "Message": f"{command} is not a valid PyDSS command"}
logger.info(f"{command} is not a valid pydss command")
result = {"Status": 500, "Message": f"{command} is not a valid pydss command"}
self.queue.put(result)

except Empty:
Expand Down
Loading

0 comments on commit 7f10380

Please sign in to comment.