Status: Expect regular updates and bug fixes.
Technical support: support.tdcosim@anl.gov
TDcoSim (T & D co-simulation tool) is a Python package that can be used to perform co-simulations containing a transmission system simulator (TSS), multiple distribution system simulator (DSS) instances, and multiple solar PV-DER instances.
For a more detailed introduction of TDcosim, please refer to introduction flyer and introduction video.
The key features include:
- Transmission system modeling using PSS®E
- Distribution system modeling using OpenDSS
- Detailed dynamic DER modeling using PVDER
- Support for static and dynamic simulation
- Built-in data visualization and data analytics tools
- Capable of simulating large interconnections (250K+ T&D nodes).
It is capable of both static and dynamic co-simulations for power systems models containing hundreds of transmission buses, distribution feeder nodes, and DERs.
The example cases include:
- Study impact of aggregated DER model parameters
- Study impact of DER penetration on T&D systems
- Post-contingency analysis of faults involving DER
- Study impact of DER interconnection standards
- Source Code Repository: https://github.com/tdcosim/TDcoSim
- User Guide: Markdown, PDF, DOCX
- API Documentation: API doc
- Introduction Flyer: Flyer PDF
- Introduction Video: Youtube Link
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.
The config.json file provided in the examples folder can be used to do a co-simulation after editing the path names (with any text editor). Then open a command line prompt and use the following commands to to run a co-simulation. Note that config_td.json could be replaced by the name of any other configuration file.
tdcosim run -c ".\examples\config_td.json"
To visualize the co-simulation results using the dashboard, please refer to visualization and analytics section
Detailed documentation on running a co-simulation may be found within the user guide. Additional examples are available here.
Technical information on the package can be found here:
Please feel free to raise an issue for bugs or feature requests or reach out to support.tdcosim@anl.gov.
Project PI:
- Karthikeyan Balasubramaniam kbalasubramaniam@anl.gov (September 2019 to present)
Core developers:
- Karthikeyan Balasubramaniam kbalasubramaniam@anl.gov
- Sang-il Yim yim@anl.gov
Co-developers:
- Siby Jose Plathottam splathottam@anl.gov
Previous contributors:
- Ning Kang ning.kang@inl.gov (January 2018 to August 2019)
- Rojan Bhattarai rbhattarai@anl.gov
We want to acknowledge Shrirang Abhyankar for his contributions to the code base development.
We would like to recognize the support of the EPRI technical team led by Roger Dugan and Davis Montenegro and the use of the EPRI OpenDSS open source software.
This project is supported by Ali Ghassemian and Dan Ton, U.S. DOE Office of Electricity, Advanced Grid Research and Development.
If you use this code please cite it as:
@misc{TDcoSim,
title = {Transmission and Distribution System Co-simulation Tool}: A co-simulation utility},
author = "{Karthikeyan Balasubramaniam, Sang-il Yim, Ning Kang}",
howpublished = {\url{https://github.com/tdcosim/TDcoSim}},
url = "https://github.com/tdcosim/TDcoSim",
year = 2019,
note = "[Online; accessed 23-August-2019]"
}
Copyright © 2019, UChicago Argonne, LLC
Transmission and Distribution System Co-simulation Tool (TDcoSim) is distributed under the terms of BSD-3 OSS License.

