Welcome to GridCal’s documentation!

GridCal (abbreviation of Grid Calculator) is a power systems software that has been used for research and power systems consultancy since 2015.

GridCal aims at being a fully usable software product by end users, while allowing power users to tweak it and extend it at will. GridCal is designed as a software library with a graphical user interface, and because of this you can use GridCal as a conventional software, or you may embed it into your own programs.

You may also check out the power systems theory used in GridCal along with interesting information in the author’s simulation guide.

• About GridCal
• Contact
• License
• License of the dependencies
• Getting Started
  • Standalone setup
  • Python Package Installation
  • PySide2 vs. PyQt5
  • Installing python and GridCal from scratch
  • Make Miniconda work under Windows
  • Video tutorial
  • Running GridCal
    • Windows
    • Linux / OSX
  • Using GridCal as a library
    • Power systems scripting
• Tutorials
  • 5-node grid creation script
  • Create a grid and run a time series power flow
    • Node voltage results
    • Branch results
    • Time series voltage results
  • Definition of a line from the wire configuration
  • Script Cheat Sheet
    • Importing the Library
    • Opening GridCal File
    • Saving GridCal File
    • Creating a New GridCal Model
    • View GridCal Model
    • Running a Power Flow
    • Running a Time Series Power Flow
    • Results
  • Distribution Grid
    • Step 0: System Overview
    • Step 1: Create a Transformer
    • Step 2: Create Lines of Different Lengths
    • Step 3: Add More Lines and Buses
    • Step 4: Create Loads
    • Step 5: Create House 1 and House 2
    • Step 6: Defining the Main Transformer
    • Step 7: Defining Load Transformers
    • Step 8: Defining Other Transformers
    • Step 9: Defining Wires and Overhead Lines
    • Step 10: Importing Load Profiles
    • Step 10: Set Power Flow From A Profile
    • Step 11: Running a Power Flow
    • Step 12: Results & Features
  • Distribution Grid Library
    • Step 0: System Overview
    • Step 0: Import GridCal and create model
    • Step 1: Create a Transfomer
    • Step 2: Create Lines of Different Lengths
    • Step 3: Add More Lines and Buses
    • Step 4: Create Loads
    • Step 5: Create House 1 and House 2
    • Step 6: Defining the Main Transformer
    • Step 7: Defining Load Transformers
    • Step 8: Defining Other Transformers
    • Step 9: Defining Wires and Overhead Lines
    • Step 10: Importing Load Profiles
    • Step 11: Save File
  • Example Files
• Data sheets
  • Wire data
  • Cable Data
  • Transformer data
• Theory behind GridCal
  • The assets manager: from objects to matrices
    • Structure
  • Universal Branch Model
    • Temperature correction
    • Embedded Tap changer
  • Transformer definition from SC test values
    • Inverse definition of SC values from π model
  • Power Flow
    • Newton-Raphson
    • Levenberg-Marquardt
    • Fast Decoupled
    • DC approximation
    • Linear AC Power Flow
    • Holomorphic Embedding
    • Post Power Flow (Loading and Losses)
    • Continuation power flow
    • Distributed Slack
  • Optimal power flow
    • Linear optimal power flow
    • Linear DC optimal power flow time series
    • AC Linear optimal power flow time series
  • Short Circuit
    • 3-Phase Short Circuit
  • PTDF (Power Transmission Distribution Factors)
    • PTDF (Power Transmission Distribution Factors)
    • VTDF (Voltage Transmission Distribution Factors)
    • PTDF and VTDF times series
• Graphical User Interface
  • Model view
    • Schematic editor
    • Tabular editor
    • Grid analysis and diagnostic
    • Templates
    • Overhead line editor
    • Time series
    • Profiles importer
    • Array viewer
    • Comments editor
  • Results
    • Tabular view
  • Console
  • Settings
    • Power flow
    • Optimal power flow
    • Voltage stability
    • Stochastic power flow
    • Topology
• Development
  • Contributing
  • Testing with pytest
• Benchmarks
  • Linear algebra frameworks benchmark
    • IEEE 39 1-year time series
    • 2869 Pegase 1-week time series
• GridCal
  • GridCal package
    • Subpackages
    • Submodules
    • GridCal.ExecuteGridCal module
    • GridCal.update module
• Change log
  • Version 4.7.0
  • Version 4.5.1
  • Version 4.5.0
  • Version 4.4.5
  • Version 4.4.3
  • Version 4.4.2
  • Version 4.3.5
  • Version 4.2.8
  • Version 4.2.7
  • Version 4.2.5
  • Version 4.2.4
  • Version 4.2.3
  • Version 4.2.2
  • Version 4.2.1
  • Version 4.2.0
  • Version 4.1.2
  • Version 4.1.1
  • Version 4.1.0
  • Version 4.0.2
  • Version 4.0.0 (multi-terminal DC Grids)
  • Version 3.7.1
  • Version 3.7.0 (HELM)
  • Version 3.6.7
  • Version 3.6.6
  • Version 3.6.5
  • Version 3.6.4
  • Version 3.6.3
  • Version 3.6.2
  • Version 3.6.1
  • Version 3.6.0
  • Version 3.5.9
  • Version 3.5.8
  • Version 3.5.7
  • Version 3.5.6
  • Version 3.5.5
  • Version 3.5.4
  • Version 3.5.3
  • Version 3.5.2
  • Version 3.5.1
  • Version 3.5.0 (commemorating the 100 GitHub stars)
  • Version 3.4.2
  • Version 3.4.1
  • Version 3.4.0
  • Version 3.3.9
  • Version 3.3.7
  • Version 3.3.6
  • Version 3.3.5
  • Version 3.3.4
  • Version 3.3.0

This documentation is generated using Sphinx and autodoc.