PFNET Python Interface Documentation

Welcome! This is the documentation for the Python interface of PFNET version 1.3.5, last updated Dec 28, 2019.

What is PFNET?

PFNET is a C library for modeling and analyzing electric power networks. It provides the following:

• Data parsers.
• Network analysis and manipulation routines.
• Fast and customizable constraint and objective function evaluators for constructing network optimization problems.

License

PFNET is released under the BSD 2-clause license.

Contents

• 1. Getting Started
  • 1.1. Prerequisites
  • 1.2. Installation
  • 1.3. Example
• 2. Data Parsers
  • 2.1. Overview
  • 2.2. JSON
  • 2.3. MATPOWER
• 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.2.8. FACTS Devices
    • 3.2.9. HVDC Voltage-Source Converters
    • 3.2.10. HVDC Current-Source Converters
    • 3.2.11. HVDC Buses
    • 3.2.12. HVDC Branches
  • 3.3. Properties
  • 3.4. Variables
  • 3.5. Projections
  • 3.6. Outages and Contingencies
  • 3.7. Multiple Time Periods
  • 3.8. Subnetworks
  • 3.9. Network Modifications
• 4. Optimization Problems
  • 4.1. Objective Function
    • 4.1.1. Active power generation cost
    • 4.1.2. Active power consumption utility
    • 4.1.3. Net Active Power Consumption Cost
    • 4.1.4. Voltage magnitude regularization
    • 4.1.5. Voltage angle regularization
    • 4.1.6. Generator powers regularization
    • 4.1.7. Transformer tap ratio regularization
    • 4.1.8. Transformer phase shift regularization
    • 4.1.9. Switched shunt susceptance regularization
    • 4.1.10. Voltage magnitude soft limit penalty
    • 4.1.11. Sparsity inducing penalty for controls
    • 4.1.12. General Variable Regularization
  • 4.2. Constraints
    • 4.2.1. AC Power balance
    • 4.2.2. DC Power balance
    • 4.2.3. Linearized AC Power balance
    • 4.2.4. DC branch flow limits
    • 4.2.5. AC branch flow limits
    • 4.2.6. Linearized AC branch flow limits
    • 4.2.7. Variable fixing
    • 4.2.8. Variable bounds
    • 4.2.9. Generator participation
    • 4.2.10. Voltage set-point regulation by generators
    • 4.2.11. Voltage band regulation by transformers
    • 4.2.12. Voltage band regulation by switched shunts
    • 4.2.13. Generator active power ramp limits
    • 4.2.14. Battery dynamics
    • 4.2.15. Load Constant Power Factor
  • 4.3. Heuristics
  • 4.4. Problems
• 5. Extensions
  • 5.1. Adding a Function
  • 5.2. Adding a Constraint
• 6. API Reference
  • 6.1. Parser
  • 6.2. Bus
    • 6.2.1. Bus Properties
    • 6.2.2. Bus Quantities
    • 6.2.3. Bus Class
  • 6.3. Branch
    • 6.3.1. Branch Properties
    • 6.3.2. Branch Quantities
    • 6.3.3. Branch Class
    • 6.3.4. Branch Y Correction Class
  • 6.4. Generator
    • 6.4.1. Generator Properties
    • 6.4.2. Generator Quantities
    • 6.4.3. Generator Class
  • 6.5. Shunt
    • 6.5.1. Shunt Properties
    • 6.5.2. Shunt Quantities
    • 6.5.3. Shunt Class
  • 6.6. Load
    • 6.6.1. Load Properties
    • 6.6.2. Load Quantities
    • 6.6.3. Load Class
  • 6.7. Variable Generator
    • 6.7.1. Variable Generator Properties
    • 6.7.2. Variable Generator Quantities
    • 6.7.3. Variable Generator Class
  • 6.8. Battery
    • 6.8.1. Battery Properties
    • 6.8.2. Battery Quantities
    • 6.8.3. Battery Class
  • 6.9. FACTS
    • 6.9.1. FACTS Properties
    • 6.9.2. FACTS Quantities
    • 6.9.3. FACTS Class
  • 6.10. HVDC VSC
    • 6.10.1. HVDC VSC Properties
    • 6.10.2. HVDC VSC Quantities
    • 6.10.3. HVDC VSC Class
  • 6.11. HVDC CSC
    • 6.11.1. HVDC CSC Properties
    • 6.11.2. HVDC CSC Quantities
    • 6.11.3. HVDC CSC Class
  • 6.12. HVDC Bus
    • 6.12.1. HVDC Bus Properties
    • 6.12.2. HVDC Bus Quantities
    • 6.12.3. HVDC Bus Class
  • 6.13. HVDC Branch
    • 6.13.1. HVDC Branch Properties
    • 6.13.2. HVDC Branch Quantities
    • 6.13.3. HVDC Branch Class
  • 6.14. Network
    • 6.14.1. Component Types
    • 6.14.2. Flag Types
    • 6.14.3. Variable Value Options
    • 6.14.4. Network Class
  • 6.15. Contingency
  • 6.16. Function
    • 6.16.1. Function Names
    • 6.16.2. Function Classes
  • 6.17. Constraint
    • 6.17.1. Constraint Names
    • 6.17.2. Constraint Classes
  • 6.18. Heuristic
    • 6.18.1. Heuristic Names
    • 6.18.2. Heuristic Classes
  • 6.19. Optimization Problem
    • 6.19.1. Problem Class
  • 6.20. Test Utilities
• 7. Related Papers

Indices and tables

• Index
• Module Index
• Search Page