D.1 Directory Layout and Documentation Files

Some of these files appear at the top level of the distribution and others in the docs directory.

Table D-1:Matpower Directory Layout and Documentation Files

name

description

data/

Matpower cases (see Section D.3)

docker/

files related to Matpower Docker image

  Dockerfile

commands for building Docker image

  MATPOWER-Docker.md

documentation for Matpower Docker image

  docker-compose.test.yml

configuration for Docker Hub auto test

  matpower_desktop.py

Python script for use with Matpower Docker

  matpower_docker_tests.sh

script for Docker Hub auto test

docs/

Matpower documentation

  MATPOWER-dev-guide.md

Matpower Developer’s Guide

  MATPOWER-manual.pdf

Matpower User’s Manual

  relnotes/

Matpower release notes

  src/

LATEX source for Matpower User’s Manual

  TN1-OPF-Auctions.pdf

Matpower Technical Note 1 “Uniform Price Auctions and Optimal Power Flow” [48]

  TN2-OPF-Derivatives.pdf

Matpower Technical Note 2 “AC Power Flows, Generalized OPF Costs and their Derivatives using Complex Matrix Notation” [38]

  TN3-More-OPF-Derivatives.pdf

Matpower Technical Note 3 “Addendum to AC Power Flows and their Derivatives using Complex Matrix Notation: Nodal Current Balance” [39]

  TN4-OPF-Derivatives-Cartesian.pdf

Matpower Technical Note 4 “AC Power Flows and their Derivatives using Complex Matrix Notation and Cartesian Coordinate Voltages” [40]

lib/

Matpower software (see Section D.2)

  caseformat.m

help file documenting Matpower case format (i.e. at the command prompt, type help caseformat to see details)

  t/

Matpower tests and examples (see Section D.4)

mips/

integrated MIPS distribution

most/

integrated MOST distribution

mptest/

integrated MP-Test distribution (see Table D-24)

AUTHORS

list of Matpower authors

CHANGES.md

Matpower change history

CITATION

info on how to cite Matpower

CONTRIBUTING.md

Matpower Contributors Guide

LICENSE

license file

README.md

basic introduction to Matpower

install_matpower.m

Matpower installer script

The MIPS User’s Manual and MOST User’s Manual are found in <MATPOWER>/mips/docs and <MATPOWER>/most/docs, respectively.