pyflow-acdc

Welcome to the pyflow-acdc documentation!

This is a python-based tool for the design and analysis of hybrid AC/DC grids

pyflow-acdc is a program worked on by ADOreD Project by CITCEA-UPC in collaboration with Youwind.

This project has received funding from the European Union’s Horizon Europe Research and Innovation programme under the Marie Skłodowska-Curie grant agreement No 101073554.

This documentation is under active development if any questions arise please contact the authors.

Introduction:

• Installation
  • Requirements
  • Install from PyPI
  • Install from source
  • Making Changes
  • Additional Dependencies
• Usage Guide
  • Creating a Grid
  • Adding Components
  • Running a Power Flow
  • Available test cases
  • Workflow guides
• Citing pyflow-acdc

API Documentation

Grid Management:

• System Modelling
  • AC System Modelling
    • AC node
    • AC branch
    • Transmission Expansion Planning Modelling
  • DC System Modelling
    • DC node
    • DC line
    • DC line expansion
    • DCDC converter
  • AC/DC Converter
    • AC_DC_converter
  • Sources and Price Zones
    • Renewable Source
    • Generator
    • Price Zone
• Grid Creation
  • Core Grid Class
    • Grid
    • Create Grid From Data
    • Create Grid From Matpower
    • Create Grid From Turbine Graph
    • Create Grid From Pickle
    • Extend Grid From Data
    • Reset All Classes
    • Change Base Power
    • Create Sub Grid
• CSV files for importing data
  • Required CSV Files
    • Data in per unit (pu)
    • Data in Ohms
    • Data in Real values
• Grid Modifications
  • Add Grid Components
    • Add AC Node
    • Add AC Line
    • Line sizing
    • Add DC Node
    • Add DC Line
    • Add AC/DC Converter
    • Add DC/DC Converter
    • Add Generator
    • Add DC Generator
    • Add External Grid
    • Add Renewable Source
    • Bulk Add Generators
  • Zones
    • Add Price Zone
    • Add MTDC Price Zone
    • Add Offshore Price Zone
    • Add Renewable Source Zone
  • Time Series and Investment Data
    • Add Time Series
    • Wire Time Series to Grid Elements
    • Add Investment Series
    • Add Generator Mix Limits
  • Assignments
    • Assign Node to Price Zone
    • Assign Converter to Price Zone
    • Assign Line to Cable Option
    • Assign Renewable to Zone
  • Template and Import Helpers
    • create_inv_csv_template()
    • create_gen_limit_csv_template()
  • Line Modifications
    • Change Line to Expandable
    • Change Line to Reconducting
    • Change Line to Transformer
• Cable Database
  • Import and Extend
    • import_orbit_cables()
    • expand_cable_database()
  • Summary
    • Aluminium test cables
    • ABB_extrapolated
    • CIGRE B4
    • ORBIT
    • XLPE Land Cable Systems User’s Guide
    • XLPE Submarine Cable Systems Attachment to XLPE Land Cable Systems -
• Grid Analysis
  • Coordinate Conversion Utilities
    • pol2cart()
    • cart2pol()
    • pol2cartz()
    • cartz2pol()
  • Electrical Parameter Utilities
    • cable_parameters()
    • converter_parameters()
  • Grid State and Analysis
    • grid_state()
    • analyse_grid()
    • current_fuel_type_distribution()
• Results
  • Class Reference
    • Results
  • Class Methods
    • Options
    • All
    • AC Specific Results
    • DC Specific Results
    • Optimization Results
    • Price Zone optimization
    • Treansmission expansion
    • Pyomo solve summary
    • Multi-scenario TEP results
    • Multi-period TEP results
    • Sequential STEP results
    • Clustering results
    • AC expansion line flows
    • Other Results

Power Flow Analysis:

• Power Flow Module
  • Running the Power Flow
    • power_flow()
  • AC Power Flow
    • Running the AC Power Flow
  • DC Power Flow
    • Running the DC Power Flow
  • Sequential AC/DC Power Flow
    • Running the Sequential AC/DC Power Flow
• Optimal Power Flow Module
  • AC/DC Hybrid Optimal Power Flow
    • Running the OPF
    • Creating the OPF model
    • Objective Functions
    • Solvers
    • Result Translation Helpers
• AC ‘dc linear’ Optimal Power Flow Module
  • AC ‘dc linear’ Optimal Power Flow
    • Running the OPF
    • Creating the Linear OPF model
    • TEP/REC/CT Parameters and Variables
    • Exporting Results
    • Solvers
    • References

Time Series & Analysis:

• Time Series Modifications
  • Renewable Source Zone
    • add_RenSource_zone()
    • Assign Renewable to Zone
  • Price Zone
  • Time Series Data
    • add_TimeSeries()
  • TimeSeries Object
    • TimeSeries
  • References
• Time-Series Clustering
  • clustering_options
  • Examples
    • Precomputed clusters
    • Live clustering
    • Exploratory sweep
  • Cluster analysis
    • cluster_analysis()
    • cluster_TS()
    • identify_correlations()
  • Precomputed clusters
    • load_precomputed_clusters_to_grid()
  • Exploratory analysis
    • run_clustering_analysis()
    • run_clustering_analysis_and_plot()
• Time Series Module
  • Sequential AC/DC Time Series Power Flow
    • General time series
    • Grid Data Update Helper
  • Optimal Power Flow Time Series
    • Time series
  • Data handling
    • Statistical Analysis
    • Results Export
• Market coefficients
  • Workflow (EPEX order book)
    • EPEX CSV format
  • API reference
    • Price zone coefficients
    • Visualization
  • ENTSO-E data cleaning
    • Directory layout

Transmission Expansion Planning:

• Transmission Expansion Planning Module
  • Transmission Expansion Planning
    • Running one state transmission expansion planning
    • Running multiple scenario based transmission expansion planning
    • Linear and Sensitivity Utilities
    • Element Expansion Helpers
    • Transmission Expansion Planning objectives
    • Export Results
• Sequential STEP
  • sequential_STEP()
  • sequential_MS_STEP()
• Pymoo Transmission Expansion Planning Module
  • Transmission Expansion (pymoo)
    • transmission_expansion_pymoo()
    • References
• Multi period Transmission Expansion Planning Module
  • Multi-period Multi-scenario Dynamic TEP
    • multi_period_transmission_expansion()
    • multi_period_MS_TEP()
  • Export Dynamic Investment Period Plots
    • export_and_save_inv_period_svgs()
  • Run OPF on One Investment Period
    • run_opf_for_investment_period()
  • Run OPF on All Investment Periods
    • run_opf_for_all_investment_periods()
  • Run TS-OPF on One Investment Period
    • run_ts_opf_for_investment_period()
  • Export Multi-scenario TEP Time Series
• Wind Farm Array Sizing Module
  • Recommended workflow
  • Solver and install matrix
  • CssMode.PF vs CssMode.OPF
  • Internal helpers
  • Sequential Cable Sizing (CSS)
    • sequential_CSS()
  • MIP Path Selection (Array)
    • MIP_path_graph()
  • Cable Size Selection (CSS)
    • wind_farm_CSS()
    • simple_assign_cable_types()
  • Linear CSS Solver (OR-Tools)
    • optimal_l_css_ortools()
    • References

Visualization & Export:

• Plotting Module
  • Time Series
    • Time series results
    • Time series probability
  • Network Graph Visualization
    • Full grid visualization as a network graph
    • Neighbor Graph
    • Saving the Network Graph
  • Solver Diagnostics
    • plot_model_feasibility()
  • 3D Grid Plot
    • plot_3D()
• Dashboards
  • Interactive Dashboard
    • run_dash()
    • run_ts_dash()
    • run_mp_ts_dash()
  • Plot Helpers
    • plot_TS_res_from_ts()
    • plot_TS_res_dash()
  • Multi-Period Dash Builder
    • create_mp_ts_dash()
• Mapping
  • Interactive map
    • plot_folium()
    • Network map (static topology)
    • Time-series and investment maps (under development)
• Export Files Module
  • Grid Data Export
    • save_grid_to_file()
  • MATLAB Export
    • save_grid_to_matlab
  • Pickle Export
    • save_pickle()
  • Solver Progress Export
    • export_solver_progress_to_excel()

Development:

• Architecture
• Testing
• Constants and enums
• Solver Utilities
• Wind-Farm Case Loader

Quick Start

Basic installation:

pip install pyflow-acdc

import pyflow_acdc as pyf
#Use pre saved grids to familiarize yourself with the package
[grid,res]=pyf.cases['PEI_grid']()
pyf.acdc_sequential(grid,QLimit=False)
res.all()

Indices and tables

• Index

• Module Index

• Search Page