MANIFEST.in

# 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 

**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.
 
**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.
 
**6]	Improved Error logging -**  The tool uses a custom logger that can be used to efficiently debug errors 


# Installations requirements

The code has been test using Python 3.6+ and requires installation of a number of additional libraries. The code uses 'OpenDSSdirect.py' to interface with OpenDSS. documantation for the library can be found at https://github.com/NREL/OpenDSSDirect.py. The library can be installed using the following command

 **-pip install 'OpenDSSDirect.py[extras]'**

The code has been tested using Bokeh version 0.12.5 and can be installed using

 **-pip install bokeh==0.12.5**
 

Additionally, GIS overlay maps require installation of PyProj and a Google maps API key. Google maps API key can be generated at https://developers.google.com/maps/documentation/embed/get-api-key. PyProj is a coordinate transformation package and can be installed using the following command

 **-pip install pyproj**
 
 
 All other requirements can be satisfied by installing a Python package like **Anaconda**.

# 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
	
	 - pip uninstall bokeh
	 - pip uninstall tornado
	 - conda install tornado==4.5.3
	 - conda install bokeh==0.12.5