Generated Python Root Surface
April 26, 2026 ยท View on GitHub
Generated by scripts/render_public_surface.py from src/surge-py/python/surge/__init__.pyi.
Root Functions
load(path: str | PathLike[str], format: str | None = None) -> Networkload_network(path: str | PathLike[str], format: str | None = None) -> Networksave(network: Network, path: str | PathLike[str]) -> Nonelist_builtin_cases() -> list[str]load_builtin_case(name: str) -> Networkbuiltin_case_rated_flags() -> list[tuple[str, bool]]solve_dc_pf(network: Network, options: DcPfOptions | None = None, /) -> DcPfResultsolve_ac_pf(network: Network, options: AcPfOptions | None = None, /) -> AcPfResultsolve_dc_opf(network: Network, options: DcOpfOptions | None = None, runtime: DcOpfRuntime | None = None) -> DcOpfResultsolve_ac_opf(network: Network, options: AcOpfOptions | None = None, runtime: AcOpfRuntime | None = None) -> AcOpfResultsolve_scopf(network: Network, options: ScopfOptions | None = None, runtime: ScopfRuntime | None = None) -> ScopfResultsolve_dispatch(network: Network, request: Mapping[str, Any] | str | None = None, *, lp_solver: str | None = None) -> DispatchResult
Public Namespaces
auditbatchcomposeconstructioncontingencycontingency_iodcdispatchiolossesmarketopfpowerflowsubsystemtransferunits
Root Re-Exports
AcAngleWarmStartModeAcOpfBendersSubproblemResultAcOpfOptionsAcOpfResultAcOpfRuntimeAcPfOptionsAcPfResultAmbiguousTopologyErrorAreaScheduleBayBindingContingencyBranchBreakerRatingBusBusbarSectionCollapsedBranchCombinedCycleConfigCombinedCyclePlantCombinedCycleTransitionConnectivityNodeConstraintScreeningContingencyContingencyAnalysisContingencyOptionsContingencyViolationConvergenceErrorDcBranchDcBusDcConverterDcCostModelDcLossModelDcOpfOptionsDcOpfResultDcOpfRuntimeDcPfOptionsDcPfResultDiscreteModeDispatchRequestDispatchResultDispatchableLoadFactsDeviceFailedContingencyEvaluationFixedShuntGeneratorGeneratorLimitModeHvdcHvdcDcBusSolutionHvdcLccDetailHvdcModeHvdcOpfLinkHvdcResultHvdcStationSolutionInfeasibleErrorLccHvdcLinkLoadLogReceiverMissingTopologyErrorNetworkNetworkErrorNodeBreakerTopologyOpfResultOutageEntryParSetpointPumpedHydroUnitReserveZoneScopfFormulationScopfModeScopfOptionsScopfResultScopfRuntimeScopfScreeningPolicyScopfScreeningStatsStaleTopologyErrorStorageParamsSubstationSurgeErrorSurgeIOErrorTerminalConnectionThermalRatingTopologyBusMergeTopologyBusSplitTopologyErrorTopologyIntegrityErrorTopologyMappingTopologyRebuildResultTopologyReportTopologySwitchUnsupportedFeatureErrorVirtualBidVoltageLevelVscHvdcLinkanalyze_contingenciesanalyze_n1_branchanalyze_n1_generatoranalyze_n2_branchattach_log_listenercase118case14case30case300case57case9detach_log_listenerget_max_threadsinit_loggingmarket30set_max_threadssolve_ac_opf_subproblemsolve_dispatchsolve_hvdcversion