.. toctree::
   :maxdepth: 3
   :caption: MHI Packages:
   :hidden:

   common/index
   cosim/index
   enerplot/index
   pscad/index
   psout/index
   xml/index

.. pscad/extras/index

MHI Packages
============

Python packages authored by Manitoba Hydro International include:

.. list-table::
  :header-rows: 1

  * - Package
    - Description
    - Revision
  * - :mod:`mhi.common`
    - the MHI Common Library
    - |common-ver|
  * - :mod:`mhi.cosim`
    - for running PSCAD cosimulations with Python
    - |cosim-ver|
  * - :mod:`mhi.enerplot`
    - the Enerplot Automation Library
    - |enerplot-ver|
  * - :mod:`mhi.pscad`
    - the PSCAD Automation Library
    - |pscad-ver|
  * - :mod:`mhi.psout`
    - read ``*.psout`` files
    - |psout-ver|
  * - :mod:`mhi.xml`
    - read & write ``*.pscx``, ``*.pslx`` and ``*.pswx`` files
    - |xml-ver|
.. * - :mod:`mhi.pscad.extras`
     - additional PSCAD automation actions
     - |common-ver|

.. only:: embed

    Additional documentation may be found on the web for
    `PSCAD <x_pscad_>`_ and
    `Enerplot <x_enerplot_>`_.

.. _x_pscad: https://www.pscad.com/webhelp-v502-al/index.html
.. _x_enerplot: https://www.pscad.com/enerplot/automation/index.html


.. warning::

    The ``mhi`` package on PyPI is the
    "**M**\ ail **H**\ andler for **I**\ MAP".
    It is unrelated to **M**\ anitoba **H**\ ydro **I**\ nternational
    and may interfere with PSCAD operation.
    **Do not install it**.
    If you have accidentally installed it, please remove it using
    one (or more) of the following commands::

        py -m pip uninstall -y mhi
        py -3.7 -m pip uninstall -y mhi
        py -3.13 -m pip uninstall -y mhi

.. warning::

    The ``PSCAD`` package on PyPI is the
    "**P**\ ython **S**\ ervices **C**\ hecker & **A**\ nomaly **D**\ etector".
    It is unrelated to Manitoba Hydro International's **PSCAD**.
    **Do not install it**.
    If you have accidentally installed it, please remove it using
    one (or more) of the following commands::

        py -m pip uninstall -y pscad
        py -3.7 -m pip uninstall -y pscad
        py -3.13 -m pip uninstall -y pscad

Indices and tables
==================

* :ref:`genindex`
* :ref:`modindex`
* :ref:`search`
