Installation

Users can install the current version of OpenDSSDirect.py with pip.

Recommended: Use Miniconda or Anaconda to install Python

With pip

pip install 'OpenDSSDirect.py[extras]'

On Windows, if you get an error, you may need to use double quotes instead:

pip install "OpenDSSDirect.py[extras]"

Note: The Python package pandas is now an optional dependency of OpenDSSDirect.py. If you are unable to install pandas using pip, try conda install pandas. If you are unable to install pandas please open an issue on GitHub. Alternatively, you can try the following, to not install the extras dependency.

pip install OpenDSSDirect.py

To upgrade an existing installation:

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

Development

If you wish to develop OpenDSSDirect.py, first clone the repository from GitHub.

git clone https://github.com/dss-extensions/OpenDSSDirect.py.git

(Optional: Set up a virtual environment or a conda environment.)

Next install an editable version of OpenDSSDirect.py:

pip install -e '.[extras,dev]' --upgrade

Depending on you system/user shell, you may have to escape the brackets

pip install -e '.\[extras,dev\]' --upgrade

Support

OpenDSSDirect.py is currently tested and supported on Windows (x86, x64), Mac (x64, M1 and later) and Linux (x86, x64, ARM) machines.