MHI PSCAD Automation Library

Contents:

• Quick Start
  • Documentation
  • IDLE Editor
  • Python Version
  • Launch & Run PSCAD
• Upgrading
  • Version 2.x to version 3.x
  • Version 1.x to version 2.x
    • Name Space
    • Coordinate System
    • Deprecated Commands
• Tutorial
  • Requirements
    • Applications
    • Automation Library
  • My First Automation Script
    • Running the Tutorial
    • Finding the Tutorial
    • Logging
    • Error Handling
    • Launch Options
      • Minimize PSCAD
      • PSCAD Version
      • User Profile
    • PSCAD Settings
      • Fortran Version
      • Matlab Version
      • All Settings
    • Projects
    • Simulation Sets
  • Event Monitoring
    • Event Handlers
    • Removing Handlers
    • Automatic Removal
    • Build Events
  • Build & Run Messages
    • Build Messages
    • Run Messages
• Reference Manual
  • Connection Methods
    • New Instance
      • launch()
    • Existing Instance
      • connect()
    • Existing or New
      • application()
  • Product Versions
    • PSCAD
      • versions()
    • Fortran & Matlab
      • fortran_versions()
      • matlab_versions()
  • The PSCAD Application
    • PSCAD
    • Configuration
      • Application Settings
      • Application Flags
    • Properties
      • PSCAD.version
      • PSCAD.examples_folder
      • PSCAD.is_busy()
    • Licensing
      • Certificate
      • Legacy
    • Workspace Commands
      • PSCAD.new_workspace()
      • PSCAD.save_workspace()
      • PSCAD.workspace_dir
      • PSCAD.workspace_name
      • PSCAD.workspace_path
      • PSCAD.is_dirty()
      • PSCAD.load()
      • PSCAD.projects()
      • PSCAD.project_names()
      • PSCAD.cases()
      • PSCAD.libraries()
      • PSCAD.project()
      • PSCAD.create_library()
      • PSCAD.create_case()
    • Build & Run Commands
      • PSCAD.build_all()
      • PSCAD.build_modified()
      • PSCAD.build_current()
      • PSCAD.pause_run()
      • PSCAD.stop_run()
      • PSCAD.clean_all()
    • Simulation Sets
      • PSCAD.simulation_sets()
      • PSCAD.create_simulation_set()
      • PSCAD.simulation_set()
      • PSCAD.remove_simulation_set()
      • PSCAD.run_all_simulation_sets()
    • Parameter Grid
      • PSCAD.parameter_grid
      • ParameterGrid.view()
      • ParameterGrid.view_cases()
      • ParameterGrid.view_libraries()
      • ParameterGrid.view_simulation_sets()
      • ParameterGrid.view_simulation_tasks()
      • ParameterGrid.view_simulation_task_overrides()
      • ParameterGrid.view_simulation_task_layers()
      • ParameterGrid.save()
      • ParameterGrid.load()
    • Search Results
      • PSCAD.search_results()
    • Navigation
      • PSCAD.navigate()
      • PSCAD.navigate_to()
      • PSCAD.navigate_up()
      • PSCAD.navigate_dismiss()
      • PSCAD.focused()
    • Subscriptions
      • PSCAD.subscriptions()
      • PSCAD.subscribed()
      • PSCAD.subscribe()
      • PSCAD.unsubscribe()
      • PSCAD.unsubscribe_all()
      • PSCAD.subscription()
    • Keys & Mouse
      • Keystroke Events
      • Mouse Events
    • Termination
      • PSCAD.quit()
  • Projects
    • Project
    • Properties
      • Project.name
      • Project.filename
      • Project.temp_folder
      • Project.parameters()
      • Project.parameter_range()
    • Management
      • Load & Save
      • Navigation
      • Search
      • Scenarios
    • Build & Run
      • Project.build()
      • Project.run()
      • Project.run_status()
      • Project.pause()
      • Project.stop()
      • Project.messages()
      • Project.output()
      • Project.clean()
      • Project.compile_library()
    • Definitions
      • Project.definitions()
      • Project.definition()
      • Project.create_definition()
      • Project.delete_definition()
      • Project.delete_definition_instances()
      • PSCAD.copy_definitions()
      • Project.paste_definitions()
      • Project.paste_definitions_with_dependents()
      • Project.remap_definitions()
    • Components
      • Finding
      • Finding By Id
      • Parameter Grid
      • Names In Use
    • Global Substitutions
      • Project.global_substitution
      • Sets
      • Variables
      • Load / Save
    • Layers
      • Project.layers()
      • Project.create_layer()
      • Project.set_layer_state()
      • Project.delete_layer()
      • Project.layer()
      • Project.layer_states()
      • Properties
    • Resources
      • Project.resources()
      • Project.create_resource()
      • Project.remove_resource()
      • Project.resource()
      • Properties
  • Canvas
    • Canvas
    • Properties
      • Canvas.scope
      • Canvas.name
      • Canvas.parameters()
      • Canvas.parameter_range()
      • Canvas.size
    • Finding Components
      • Canvas.find()
      • Canvas.find_first()
      • Canvas.find_all()
      • Canvas.components()
      • Canvas.bounds()
      • Finding By Id
      • Names In Use
    • Finding Empty Spaces on Canvas
      • Canvas.get_empty_rects()
      • Canvas.closest_empty_rect()
    • Creating Components
      • Canvas.create_component()
      • Canvas.add_component()
    • Clipboard Operations
      • Canvas.select()
      • Canvas.select_components()
      • Canvas.clear_selection()
      • Canvas.copy()
      • Canvas.cut()
      • Canvas.paste()
      • Canvas.delete()
    • Transformations
      • Canvas.mirror()
      • Canvas.flip()
      • Canvas.rotate_right()
      • Canvas.rotate_left()
      • Canvas.rotate_180()
    • Navigation
      • Canvas.navigate_up()
  • User Canvas
    • UserCanvas
    • Parameters
      • UserCanvas.parameters()
      • UserCanvas.parameter_range()
    • Smart Clipboard
      • UserCanvas.paste_transfer()
      • UserCanvas.paste_rename()
    • Composition
      • UserCanvas.group()
      • UserCanvas.compose_wires()
      • UserCanvas.decompose_wires()
    • Creating …
      • Wires
      • Connections
      • Annotations
      • Graphs
      • Controls
  • Graphics Canvas
    • GfxCanvas
      • GfxCanvas.create_component()
      • GfxCanvas.add_port()
      • GfxCanvas.add_input()
      • GfxCanvas.add_output()
      • GfxCanvas.add_electrical()
      • GfxCanvas.add_line()
      • GfxCanvas.add_rectangle()
      • GfxCanvas.add_text()
  • Components
    • Common
      • Component
      • Properties
      • Location
      • Layers
      • Modules
      • Clipboard
      • Z-Ordering
    • User Components
      • UserCmp
      • Properties
      • Ports
      • Modules
    • Connections
      • Wire.vertices()
      • Wire.endpoints()
      • Wires
      • Sticky Wire
      • Bus
      • T-Line
      • Cable
    • Output Channels
      • Graph Frame
      • Overlay Graph
      • Polygraph
      • XY Plot Frame
      • Curve
    • Instruments
      • Instrument
      • Instrument.link_id
      • Instrument.linked
      • Instrument.title
      • Instrument.parameters()
      • Instrument.range()
      • Oscilloscope
      • Phasor Meter
      • Poly Meter
    • Input Controls
      • Control Frame
      • General
      • Button
      • Switch
      • Selector
      • Slider
    • Annotations
      • Sticky
      • Divider
      • Group Box
  • Definitions
    • Definition
      • Definition.project_name
      • Definition.scope
      • Definition.name
      • Definition.scoped_name
      • Definition.instances
      • Definition.xml
      • Definition.form_codec
      • Definition.is_module()
      • Definition.parameters()
      • Definition.compile()
      • Definition.navigate_to()
      • Definition.set_view()
      • Definition.canvas()
      • Definition.graphics()
      • Definition.copy()
      • Definition.script
  • Simulation Sets
    • SimulationSet
    • Management
      • SimulationSet.name()
    • Tasks
      • SimulationSet.tasks()
      • SimulationSet.list_tasks()
      • SimulationSet.add_tasks()
      • SimulationSet.remove_tasks()
      • SimulationSet.task()
    • Build & Run
      • SimulationSet.run()
  • Simulation Tasks
    • Project Task
      • ProjectTask
      • ProjectTask.name
      • ProjectTask.namespace()
      • ProjectTask.simulation_set
      • ProjectTask.parameters()
      • ProjectTask.layers()
      • ProjectTask.overrides()
    • External Task
      • ExternalTask
  • Licensing
    • License Certificate
      • Certificate
      • Identification
      • Features
      • Requirements
    • License Features
      • Feature
      • Identification
  • Component Wizard
    • UserDefnWizard
      • UserDefnWizard.name
      • UserDefnWizard.module
      • UserDefnWizard.description
      • UserDefnWizard.port
      • UserDefnWizard.graphics
      • UserDefnWizard.form_caption
      • UserDefnWizard.form_width
      • UserDefnWizard.form_height
      • UserDefnWizard.form_splitter
      • UserDefnWizard.form_category_width
      • UserDefnWizard.form_help_width
      • UserDefnWizard.category
      • UserDefnWizard.parameter
      • UserDefnWizard.script
      • UserDefnWizard.create_definition()
    • Ports
      • Ports
      • Port
    • Graphics
      • Graphics
      • Text
      • Line
      • Rectangle
    • Parameter Form
      • Parameters
      • Categories
      • Category
      • Parameters
      • Parameter
    • Scripts
      • Scripts
  • Utilities
    • Clipboard
    • File
      • File
      • OutFile
    • Mail
    • Word
  • Types
    • Point
      • Point
    • Port
      • Port
    • Any Point
      • AnyPoint
    • Rect
      • Rect
    • Enums
      • NodeType
      • Electrical
      • Signal
      • Align
      • Side
      • LineStyle
      • FillStyle
      • ProjectType
      • LookIn
  • Unit
    • Unit System
      • UnitSystem
    • Value
      • Value
    • Complex Value
      • ComplexValue
• MHI Common Library
  • Coders / Decoders
    • General
      • Codec
      • Boolean Codec
      • Map Codec
      • Keyword Codec
      • Simple Codec
      • Fuzzy Codec
    • Arrows
      • Arrow
    • Colours
      • Colour
  • Collection
    • Indexable Dictionary
      • IndexableDict
    • Lingering Cache
      • LingeringCache
  • Configuration
    • read()
    • fetch()
  • Path Expansion
    • expand_path()
    • expand_paths()
    • contract_path()
    • contract_paths()
    • shell_folder()
  • Process Control
  • Remote Objects
    • Remotable
      • Remotable
      • Application
    • Decorators
      • @rmi
      • @rmi_property
    • Context
      • Context
      • Socket Context
      • Queue Context
    • Exceptions
      • RemoteException
  • Changes
    • 3.1.4
    • 3.1.3
    • 3.1.2
    • 3.1.1
    • 3.1.0
    • 3.0.3
    • 3.0.2
    • 3.0.1
    • 3.0.0
    • 2.5.1
    • 2.5.0
    • 2.4.5
    • 2.4.4
    • 2.4.3
    • 2.4.2
    • 2.4.1
    • 2.4.0
    • 2.3.11
    • 2.3.10
    • 2.3.9
    • 2.3.8
    • 2.3.7
    • 2.3.6
    • 2.3.5
    • 2.3.4
    • 2.3.3
    • 2.3.2
    • 2.3.1
    • 2.3.0
    • 2.2.1
    • 2.2.0
    • 2.1.3
    • 2.1.2
    • 2.1.1
    • 2.1.0
    • 2.0.1
  • Indices and tables
• Changes
  • What’s new in 3.0
    • 3.0.8
    • 3.0.7
    • 3.0.6
    • 3.0.5
    • 3.0.4
    • 3.0.3
    • 3.0.2
    • 3.0.1
    • 3.0.0
  • What’s New in 2.9
    • 2.9.7
    • 2.9.6
    • 2.9.5
    • 2.9.4
    • 2.9.3
    • 2.9.2
    • 2.9.1
    • 2.9.0
  • What’s New in 2.8
    • 2.8.4
    • 2.8.3
    • 2.8.2
    • 2.8.1
    • 2.8.0
  • What’s New in 2.7
    • 2.7.2
    • 2.7.1
    • 2.7.0
  • What’s New in 2.6
    • 2.6.0
  • What’s New in 2.5
    • 2.5.1
    • 2.5.0
  • What’s New in 2.4
    • 2.4.1
    • 2.4.0
  • What’s New in 2.3
    • 2.3.4
    • 2.3.3
    • 2.3.2
    • 2.3.1
    • 2.3.0
  • What’s New in 2.2
    • 2.2.2
    • 2.2.1
    • 2.2.0
  • What’s New in 2.1
    • 2.1.1
    • 2.1.0
    • Summary
    • Deprecations

Indices and tables

• Index

• Module Index

• Search Page