Installation

February 14, 2022 · View on GitHub

The stable release of TDcoSim can be installed from PyPI. The version under development can be installed from GitHub. The commands to be executed in the Windows command line interface for both options are included below:

You can install tdcosim by running the following command on command line.

pip install git+https://github.com/tdcosim/TDcoSim.git@master

In the event you do not have git installed on your machine, you can alternatively run the following from command line.

pip install https://github.com/tdcosim/TDcoSim/archive/master.zip

After installation open a new command prompt and run the following to set psse path,

tdcosim setconfig -p "path\to\psse_installation"

If PSSE 35 is being used the following may be used:

tdcosim setconfig -p "C:\Program Files\PTI\PSSE35\35.0\PSSPY37"

If PSSE 33 is being used the following may be used:

tdcosim setconfig -p "C:\Program Files (x86)\PTI\PSSE33\PSSBIN"

Due to the embedded compatibility requirements between PSSE and Python, please refer to the following compatibility table and the PSSE API document that located in the Doc folder on PSSE install location when paring PSSE with Python.

It should be noted that the table below is a subset of all successful combinations from our team’s development environment, and it is crucial to set the PSSE installation path properly so that the module PSSPY can be located.

Compatibility Table PSSE-Python

Note: Git needs to installed (in case it is not already available) before TDcoSim can be installed.

Post Installation

Get info about tdcosim

tdcosim describe

Test if tdcosim example simulations (dynamics and QSTS) are working,

tdcosim test

Dependencies:

The packages listed below must be installed separately:

Required

Python version = 2.7.5 for PSS®E, version = 33.3.0, version >= 3.5 for PSS®E, version = 35.0.0
Power system simulator: PSS®E, version = 33.3.0 or PSS®E, version = 35.0.0
Distribution system simulator: OpenDSS, version >= 8.6.1.1
DER simulator: Solar PV-DER simulation utility, version >= 0.5.1
Python packages for basic functionalities: SciPy, Numpy, Matlplotlib, Pywin32, XlsxWriter, Psutil
Python packages for visualization: Dash, Plotly

Note: Either demo (limited to 50 buses) or full version of PSS/E can be used. OpenDSS is an open source software and can be installed for free.

Note: PSS/E 35.0.0 and above support will support both 32 and 64 bit versions of Python.

Optional

For using the high performance ODE solver diffeqpy, version >= 1.1.0
For using the high performance ODE solver diffeqpy, version >= 1.1.0
- Install tdcosim with the diffeqpy flag as shown below.
```
   pip install tdcosim[diffeqpy]
```
- After installation open a new command prompt and run the script install_julia_diffeqpy.py available in the repository. It will install Julia (if not already installed), all the required libraries, and setup a Julia environment linked to the Python environment.
```
   python install_julia_diffeqpy.py
```
- Download and install Julia interpreter: Julia, version >= 1.5 (Optional)
- Add Julia to system PATH environment variables as shown here (Only for Windows OS) (Optional)

Note: If co-simulations involving more than 10 detailed DER models are needed to be run, it is recommended to select diffeqpy as the ODE solver.

Note: All Python packages can be installed with pip (e.g. pip install scipy)

Tested configurations :

PSS/E	OpenDSS	Python	diffeqpy/Julia	Tested
35	8.6.1.1	2.7.3	-	Yes
33	9.3.0.2	2.7.3	-	Yes
35	8.6.1.1	3.7	-	Yes
35	8.6.1.1	3.7	1.2 - Julia 1.5.3	Yes (till 75 feeders)
35	8.6.1.1	3.7	1.2 - Julia 1.6.1	Yes (till 50 feeders)
35	8.6.1.1	3.7	1.2 - Julia 1.7.0	Yes (till 50 feeders)