4pace

User Guide

  • Getting Started
    • Installation
    • Grid Configuration (YAML)
    • Quick Start: Microgrid Investment Planning & N-1 Security
    • Quick Start: The “One-Click” Ultimate Fault Analysis
    • Quick Start: Transient Stability & Critical Clearing Time (CCT)
  • Grid Configuration (YAML)
    • Global Settings
    • Buses & Components
      • Bus Attributes
      • Component Types
        • SynchronousMachine (Generators)
        • AsynchronousMachine (Induction Motor)
        • Inverter (Solar PV / Wind)
        • Battery (BESS)
        • Load
        • Shunt (Capacitors / Reactors)
    • Controllers (Nested in SynchronousMachine)
      • SEXS (AVR)
      • TGOV1 (Governor)
      • PSS1A (Power System Stabilizer)
    • FACTS Devices
      • CSVGN1 (SVC - Shunt FACTS)
      • STATCOM1 (Shunt FACTS)
      • TCSC1 (Series FACTS)
    • Branches
      • TransmissionLine
      • Transformer
    • Example: Modified IEEE 14 Bus System

API Reference

  • API Reference
    • Power System Base (psys & model)
      • Bus
        • Bus.P
        • Bus.Q
        • Bus.S
        • Bus.add_component()
        • Bus.add_components()
        • Bus.component()
        • Bus.components
        • Bus.get()
        • Bus.total_cost()
      • Grid
        • Grid.add_bus()
        • Grid.add_busses()
        • Grid.apply_profile()
        • Grid.attach_profile()
        • Grid.build_ybus()
        • Grid.build_ybus_pos()
        • Grid.build_ybus_zero()
        • Grid.bus()
        • Grid.buses
        • Grid.calculate_PQ()
        • Grid.check_overload()
        • Grid.connect()
        • Grid.get_peak_load_hour()
        • Grid.kron_reduction()
        • Grid.load()
        • Grid.loading_status()
        • Grid.result()
        • Grid.update_motor_slip()
      • AsynchronousMachine
        • AsynchronousMachine.cost()
        • AsynchronousMachine.incremental_cost()
        • AsynchronousMachine.update_pq_from_slip()
      • Battery
        • Battery.cost()
        • Battery.incremental_cost()
      • BranchComponent
      • BusComponent
        • BusComponent.S
        • BusComponent.cost()
        • BusComponent.incremental_cost()
      • Inverter
        • Inverter.cost()
        • Inverter.incremental_cost()
      • Load
        • Load.cost()
        • Load.incremental_cost()
        • Load.update_voltage_dependence()
      • Shunt
        • Shunt.cost()
        • Shunt.incremental_cost()
        • Shunt.update_voltage_dependence()
      • SynchronousMachine
        • SynchronousMachine.cost()
        • SynchronousMachine.incremental_cost()
      • Transformer
      • TransmissionLine
      • get_daily_capex_factor()
    • Fault & Protection (fault)
      • DoubleLineToGroundFault()
      • LineToGroundFault()
      • LineToLineFault()
      • OpenConductorFault()
      • ThreePhaseFault()
      • analyze_fault()
      • analyze_faults()
    • Transient Stability (dynamics & control)
      • analyze_transient()
      • find_cct()
      • get_state_indices()
      • ode_engine()
      • rk4_step()
      • AVR
        • AVR.get_Efd()
        • AVR.get_derivatives()
        • AVR.initialize()
      • Governor
        • Governor.get_Pm()
        • Governor.get_derivatives()
        • Governor.initialize()
      • PSS
        • PSS.get_Vpss()
        • PSS.get_derivatives()
        • PSS.initialize()
      • PSS1A
        • PSS1A.get_Vpss()
        • PSS1A.get_derivatives()
        • PSS1A.initialize()
      • SEXS
        • SEXS.get_Efd()
        • SEXS.get_derivatives()
        • SEXS.initialize()
      • TGOV1
        • TGOV1.get_Pm()
        • TGOV1.get_derivatives()
        • TGOV1.initialize()
    • FACTS Devices (facts)
      • CSVGN1
        • CSVGN1.get_derivatives()
        • CSVGN1.get_susceptance()
        • CSVGN1.initialize()
      • STATCOM1
        • STATCOM1.get_Iq()
        • STATCOM1.get_derivatives()
        • STATCOM1.get_susceptance()
        • STATCOM1.initialize()
      • SeriesFACTS
        • SeriesFACTS.get_derivatives()
        • SeriesFACTS.initialize()
      • ShuntFACTS
        • ShuntFACTS.cost()
        • ShuntFACTS.get_derivatives()
        • ShuntFACTS.get_susceptance()
        • ShuntFACTS.incremental_cost()
        • ShuntFACTS.initialize()
      • TCSC1
        • TCSC1.get_X_series()
        • TCSC1.get_derivatives()
        • TCSC1.initialize()
    • Optimization & Flow (pfa)
      • CEP()
      • MPOPF()
      • N1_Screening()
      • NR()
      • NumpyEncoder
        • NumpyEncoder.default()
      • SCOPF()
      • Validate_N1()
      • plan()
4pace
  • Search

© Copyright 2026, daniel-sakdinun.

Built with Sphinx using a theme provided by Read the Docs.