GridCal package

Subpackages

• GridCal.Engine package
  • Subpackages
    • GridCal.Engine.Core package
      • Subpackages
      • Submodules
      • GridCal.Engine.Core.admittance_matrices module
      • GridCal.Engine.Core.common_functions module
      • GridCal.Engine.Core.multi_circuit module
      • GridCal.Engine.Core.snapshot_opf_data module
      • GridCal.Engine.Core.snapshot_pf_data module
      • GridCal.Engine.Core.time_series_opf_data module
      • GridCal.Engine.Core.time_series_pf_data module
      • GridCal.Engine.Core.topology module
    • GridCal.Engine.Devices package
      • Submodules
      • GridCal.Engine.Devices.battery module
      • GridCal.Engine.Devices.branch module
      • GridCal.Engine.Devices.bus module
      • GridCal.Engine.Devices.dc_line module
      • GridCal.Engine.Devices.editable_device module
      • GridCal.Engine.Devices.enumerations module
      • GridCal.Engine.Devices.external_grid module
      • GridCal.Engine.Devices.generator module
      • GridCal.Engine.Devices.groupings module
      • GridCal.Engine.Devices.hvdc_line module
      • GridCal.Engine.Devices.line module
      • GridCal.Engine.Devices.load module
      • GridCal.Engine.Devices.measurement module
      • GridCal.Engine.Devices.shunt module
      • GridCal.Engine.Devices.static_generator module
      • GridCal.Engine.Devices.templates module
      • GridCal.Engine.Devices.tower module
      • GridCal.Engine.Devices.transformer module
      • GridCal.Engine.Devices.underground_line module
      • GridCal.Engine.Devices.upfc module
      • GridCal.Engine.Devices.vsc module
      • GridCal.Engine.Devices.wire module
    • GridCal.Engine.IO package
      • Submodules
      • GridCal.Engine.IO.cim_parser module
      • GridCal.Engine.IO.dgs_parser module
      • GridCal.Engine.IO.dpx_parser module
      • GridCal.Engine.IO.excel_interface module
      • GridCal.Engine.IO.export_results_driver module
      • GridCal.Engine.IO.file_handler module
      • GridCal.Engine.IO.file_system module
      • GridCal.Engine.IO.generic_io_functions module
      • GridCal.Engine.IO.h5_interface module
      • GridCal.Engine.IO.ipa_parser module
      • GridCal.Engine.IO.json_parser module
      • GridCal.Engine.IO.matpower_branch_definitions module
      • GridCal.Engine.IO.matpower_bus_definitions module
      • GridCal.Engine.IO.matpower_gen_definitions module
      • GridCal.Engine.IO.matpower_parser module
      • GridCal.Engine.IO.matpower_storage_definitions module
      • GridCal.Engine.IO.pack_unpack module
      • GridCal.Engine.IO.plexos module
      • GridCal.Engine.IO.psse_parser module
      • GridCal.Engine.IO.sqlite_interface module
      • GridCal.Engine.IO.synchronization_driver module
      • GridCal.Engine.IO.zip_interface module
    • GridCal.Engine.Replacements package
      • Submodules
      • GridCal.Engine.Replacements.mpiserve module
      • GridCal.Engine.Replacements.poap_controller module
      • GridCal.Engine.Replacements.strategy module
      • GridCal.Engine.Replacements.tcpserve module
    • GridCal.Engine.Simulations package
      • Subpackages
      • Submodules
      • GridCal.Engine.Simulations.result_types module
      • GridCal.Engine.Simulations.sparse_solve module
    • GridCal.Engine.Sparse package
      • Submodules
      • GridCal.Engine.Sparse.csc module
      • GridCal.Engine.Sparse.csc_numba module
      • GridCal.Engine.Sparse.utils module
    • GridCal.Engine.Visualization package
      • Submodules
      • GridCal.Engine.Visualization.visualization module
  • Submodules
  • GridCal.Engine.basic_structures module
  • GridCal.Engine.grid_analysis module
  • GridCal.Engine.plot_config module
• GridCal.Gui package
  • Subpackages
    • GridCal.Gui.Analysis package
      • Submodules
      • GridCal.Gui.Analysis.AnalysisDialogue module
      • GridCal.Gui.Analysis.gui module
      • GridCal.Gui.Analysis.matplotlibwidget module
      • GridCal.Gui.Analysis.update_gui_file module
    • GridCal.Gui.GIS package
      • Submodules
      • GridCal.Gui.GIS.gis_dialogue module
      • GridCal.Gui.GIS.gui module
      • GridCal.Gui.GIS.icons_rc module
      • GridCal.Gui.GIS.update_gui_file module
    • GridCal.Gui.GridEditorWidget package
      • Submodules
      • GridCal.Gui.GridEditorWidget.battery_graphics module
      • GridCal.Gui.GridEditorWidget.bus_graphics module
      • GridCal.Gui.GridEditorWidget.dc_line_graphics module
      • GridCal.Gui.GridEditorWidget.editor module
      • GridCal.Gui.GridEditorWidget.generator_graphics module
      • GridCal.Gui.GridEditorWidget.generic_graphics module
      • GridCal.Gui.GridEditorWidget.hvdc_graphics module
      • GridCal.Gui.GridEditorWidget.line_graphics module
      • GridCal.Gui.GridEditorWidget.load_graphics module
      • GridCal.Gui.GridEditorWidget.matplotlibwidget module
      • GridCal.Gui.GridEditorWidget.messages module
      • GridCal.Gui.GridEditorWidget.shunt_graphics module
      • GridCal.Gui.GridEditorWidget.static_generator_graphics module
      • GridCal.Gui.GridEditorWidget.terminal_item module
      • GridCal.Gui.GridEditorWidget.transformer2w_graphics module
      • GridCal.Gui.GridEditorWidget.upfc_graphics module
      • GridCal.Gui.GridEditorWidget.vsc_graphics module
    • GridCal.Gui.LoadDesigner package
      • Submodules
      • GridCal.Gui.LoadDesigner.gui module
      • GridCal.Gui.LoadDesigner.icons_rc module
      • GridCal.Gui.LoadDesigner.load_designer module
      • GridCal.Gui.LoadDesigner.matplotlibwidget module
      • GridCal.Gui.LoadDesigner.update_gui_file module
    • GridCal.Gui.Main package
      • Submodules
      • GridCal.Gui.Main.ConsoleLog module
      • GridCal.Gui.Main.ConsoleLogController module
      • GridCal.Gui.Main.GridCalMain module
      • GridCal.Gui.Main.MainWindow module
      • GridCal.Gui.Main.banner module
      • GridCal.Gui.Main.grid_paint_driver module
      • GridCal.Gui.Main.icons_rc module
      • GridCal.Gui.Main.matplotlibwidget module
      • GridCal.Gui.Main.update_gui_file module
    • GridCal.Gui.ProfilesInput package
      • Submodules
      • GridCal.Gui.ProfilesInput.excel_dialog module
      • GridCal.Gui.ProfilesInput.excel_sheet_selection module
      • GridCal.Gui.ProfilesInput.gui module
      • GridCal.Gui.ProfilesInput.icons_rc module
      • GridCal.Gui.ProfilesInput.matplotlibwidget module
      • GridCal.Gui.ProfilesInput.profile_dialogue module
      • GridCal.Gui.ProfilesInput.update_gui_file module
    • GridCal.Gui.SigmaAnalysis package
      • Submodules
      • GridCal.Gui.SigmaAnalysis.gui module
      • GridCal.Gui.SigmaAnalysis.icons_rc module
      • GridCal.Gui.SigmaAnalysis.matplotlibwidget module
      • GridCal.Gui.SigmaAnalysis.sigma_analysis_dialogue module
      • GridCal.Gui.SigmaAnalysis.update_gui_file module
    • GridCal.Gui.SyncDialogue package
      • Submodules
      • GridCal.Gui.SyncDialogue.gui module
      • GridCal.Gui.SyncDialogue.icons_rc module
      • GridCal.Gui.SyncDialogue.sync_dialogue module
      • GridCal.Gui.SyncDialogue.update_gui_file module
    • GridCal.Gui.TowerBuilder package
      • Submodules
      • GridCal.Gui.TowerBuilder.LineBuilderDialogue module
      • GridCal.Gui.TowerBuilder.gui module
      • GridCal.Gui.TowerBuilder.icons_rc module
      • GridCal.Gui.TowerBuilder.matplotlibwidget module
      • GridCal.Gui.TowerBuilder.test_ module
      • GridCal.Gui.TowerBuilder.tower_model module
      • GridCal.Gui.TowerBuilder.update_gui_file module
  • Submodules
  • GridCal.Gui.ConsoleWidget module
  • GridCal.Gui.GeneralDialogues module
  • GridCal.Gui.GuiFunctions module
• GridCal.ThirdParty package
  • Subpackages
    • GridCal.ThirdParty.pulp package
      • Subpackages
      • Submodules
      • GridCal.ThirdParty.pulp.amply module
      • GridCal.ThirdParty.pulp.constants module
      • GridCal.ThirdParty.pulp.pulp module
      • GridCal.ThirdParty.pulp.pulp_extra module
      • GridCal.ThirdParty.pulp.solvers module
      • GridCal.ThirdParty.pulp.sparse module
      • GridCal.ThirdParty.pulp.tests module
• GridCal.data package

Submodules

GridCal.ExecuteGridCal module

GridCal.update module

GridCal.update.check_version()

Check package version :return: version status code, pipy version string

version status code: -2: failure -1: this is a newer version

0: we are ok

+1: we are behind pipy, we can update

GridCal.update.find_latest_version(name='GridCal')

Find the latest version of a package :param name: name of the Package :return: version string

GridCal.update.get_upgrade_command(latest_version=None)

Get GridCal update command :return: