PFNET Python Documentation

Welcome! This is the documentation for the Python wrapper of PFNET, last updated Jun 22, 2017.

What is PFNET?

PFNET is a library for modeling and analyzing electric power networks. It provides data parsers, network visualization routines, and fast and customizable constraint and objective function evaluators for constructing network optimization problems.

License

PFNET is released under the BSD 2-clause license.

Documentation Contents

• 1. Getting Started
  • 1.1. Dependencies
  • 1.2. Download
  • 1.3. Installation
  • 1.4. Example
  • 1.5. Documentation
• 2. Data Parsers
  • 2.1. Overview
  • 2.2. MATPOWER Data Files
  • 2.3. ARTERE Data Files
  • 2.4. RAW Data Files
• 3. Power Networks
  • 3.1. Overview
  • 3.2. Components
    • 3.2.1. Buses
    • 3.2.2. Branches
    • 3.2.3. Generators
    • 3.2.4. Shunt Devices
    • 3.2.5. Loads
    • 3.2.6. Variable Generators
    • 3.2.7. Batteries
  • 3.3. Properties
  • 3.4. Variables
  • 3.5. Projections
  • 3.6. Contingencies
  • 3.7. Multiple Time Periods
• 4. Visualization
  • 4.1. Overview
• 5. Optimization Problems
  • 5.1. Objective Function
    • 5.1.1. Active power generation cost
    • 5.1.2. Active power consumption utility
    • 5.1.3. Net Active Power Consumption Cost
    • 5.1.4. Voltage magnitude regularization
    • 5.1.5. Voltage angle regularization
    • 5.1.6. Generator powers regularization
    • 5.1.7. Transformer tap ratio regularization
    • 5.1.8. Transformer phase shift regularization
    • 5.1.9. Switched shunt susceptance regularization
    • 5.1.10. Voltage magnitude soft limit penalty
    • 5.1.11. Sparsity inducing penalty for controls
  • 5.2. Constraints
    • 5.2.1. AC Power balance
    • 5.2.2. DC Power balance
    • 5.2.3. Linearized AC Power balance
    • 5.2.4. DC branch flow limits
    • 5.2.5. AC branch flow limits
    • 5.2.6. Variable fixing
    • 5.2.7. Variable bounds
    • 5.2.8. Generator participation
    • 5.2.9. Voltage set-point regulation by generators
    • 5.2.10. Voltage band regulation by transformers
    • 5.2.11. Voltage band regulation by switched shunts
    • 5.2.12. Generator active power ramp limits
  • 5.3. Problems
• 6. Extensions
  • 6.1. Adding a Parser
  • 6.2. Adding a Function
  • 6.3. Adding a Constraint
• 7. API Reference
  • 7.1. Vector
  • 7.2. Matrix
  • 7.3. Parser
  • 7.4. Bus
    • 7.4.1. Bus Properties
    • 7.4.2. Bus Quantities
    • 7.4.3. Bus Sensitivities
    • 7.4.4. Bus Power Mismatches
    • 7.4.5. Bus Class
  • 7.5. Branch
    • 7.5.1. Branch Properties
    • 7.5.2. Branch Quantities
    • 7.5.3. Branch Class
  • 7.6. Generator
    • 7.6.1. Generator Properties
    • 7.6.2. Generator Quantities
    • 7.6.3. Generator Class
  • 7.7. Shunt
    • 7.7.1. Shunt Properties
    • 7.7.2. Shunt Quantities
    • 7.7.3. Shunt Class
  • 7.8. Load
    • 7.8.1. Load Properties
    • 7.8.2. Load Quantities
    • 7.8.3. Load Class
  • 7.9. Variable Generator
    • 7.9.1. Variable Generator Properties
    • 7.9.2. Variable Generator Quantities
    • 7.9.3. Variable Generator Class
  • 7.10. Battery
    • 7.10.1. Battery Properties
    • 7.10.2. Battery Quantities
    • 7.10.3. Battery Class
  • 7.11. Network
    • 7.11.1. Component Names
    • 7.11.2. Flags
    • 7.11.3. Variable Value Options
    • 7.11.4. Network Class
  • 7.12. Contingency
  • 7.13. Graph
  • 7.14. Function
    • 7.14.1. Function Names
    • 7.14.2. Function Classes
  • 7.15. Constraint
    • 7.15.1. Constraint Names
    • 7.15.2. Constraint Classes
  • 7.16. Optimization Problem
    • 7.16.1. Problem Class
  • 7.17. References

Contributors (alphabetical)

• Tomas Tinoco De Rubira
• Adam Wigington
• Martin Zellner

Indices and tables

• Index
• Module Index
• Search Page