Installation

October 8, 2021 · 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"  

For example, something similar to, tdcosim setconfig -p "C:\Program Files\PTI\PSSE35\35.0\PSSPY37"


Note: Git needs to installed (incase 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


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

    • Install tdcosim with the diffeqpy flag as shown below.

         pip install tdcosim[diffeqpy]
      
    • Download and install Julia interpreter: Julia, version >= 1.5

    • Add Julia to system PATH environment variables as shown here (Only for Windows OS).


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)