Power Grid Model IO

Power Grid Model IO is a tool to convert grid data to and from the native data format of power-grid-model. Currently, conversions from Vision excel exports and Pandapower are possible.

Some formats may be similar to the format used by power-grid-model, but use a different underlying data structure. While we do not formally support those formats, you may find examples in this documentation for some of them.

Install from PyPI

You can directly install the package from PyPI. Although it is opt-in, it is recommended to use uv as your development environment manager.

uv add power-grid-model-io

Install from Conda

If you are using conda, you can directly install the package from conda-forge channel.

conda install -c conda-forge power-grid-model-io

Citations

If you are using Power Grid Model IO in your research work, please consider citing our library using the references in Citation.

Contents

Detailed contents of the documentation are structured as follows.

Converters

• Converters
  • Structure
  • Instantiation
  • Common methods for converters
• Tabular converter
  • Mapping file
  • Grid
  • Field Definitions
  • Units
  • Substitutions
  • AutoID
  • AutoID Mapping
  • Advanced AutoID Mapping
  • Table filters
  • Security Considerations
• Vision converter
  • Load rate of elements
  • Transformer load modeling
  • Voltage angle of buses in symmetric power-flow
  • Modeling differences or unsupported attributes
  • Accomdation of UUID-based id system since Vision 9.7
  • Optional extra columns
  • Common/Known issues related to Vision
  • Security Considerations
• Pandapower converter
  • Cross referencing
  • Defaults
  • Modeling differences

Examples

• PGM JSON Converter
  • 1. Load the JSON data
  • 2. Run the calculation
  • 3. Save the data as a JSON file
  • Summary
• Vision Conversion
  • Vision conversion
  • Other languages
  • Summary
• PandaPower conversion
  • 1. Load the PandaPower Data
  • 2. Validate the data
  • 3. Run the calculation
  • 4. Converting output data
  • 5. Asymmetrical Calculations
  • Summary
• Arrow example
  • Model
  • Single symmetric calculations
  • Single asymmetric calculations
  • Batch data

API Documentation

• power_grid_model_io
  • converters
    • BaseConverter
      • BaseConverter.__init__()
      • BaseConverter.load_input_data()
      • BaseConverter.load_update_data()
      • BaseConverter.load_sym_output_data()
      • BaseConverter.load_asym_output_data()
      • BaseConverter.load_sc_output_data()
      • BaseConverter.convert()
      • BaseConverter.save()
      • BaseConverter.set_log_level()
      • BaseConverter.get_log_level()
    • PgmJsonConverter
      • PgmJsonConverter.__init__()
    • TabularConverter
      • TabularConverter.__init__()
      • TabularConverter.set_mapping_file()
      • TabularConverter.set_mapping()
      • TabularConverter.get_id()
      • TabularConverter.get_ids()
      • TabularConverter.lookup_id()
      • TabularConverter.lookup_ids()
    • get_loss_params_3ph()
    • PandaPowerConverter
      • PandaPowerConverter.__init__()
      • PandaPowerConverter.system_frequency
      • PandaPowerConverter.pp_input_data
      • PandaPowerConverter.pgm_input_data
      • PandaPowerConverter.idx
      • PandaPowerConverter.idx_lookup
      • PandaPowerConverter.next_idx
      • PandaPowerConverter.get_individual_switch_states()
      • PandaPowerConverter.get_switch_states()
      • PandaPowerConverter.get_trafo3w_switch_states()
      • PandaPowerConverter.get_trafo_winding_types()
      • PandaPowerConverter.get_trafo3w_winding_types()
      • PandaPowerConverter.get_id()
      • PandaPowerConverter.lookup_id()
    • IdReferenceFields
      • IdReferenceFields.nodes_table
      • IdReferenceFields.number
      • IdReferenceFields.node_number
      • IdReferenceFields.sub_number
      • IdReferenceFields.__init__()
    • VisionExcelConverter
      • VisionExcelConverter.__init__()
      • VisionExcelConverter.set_mapping()
      • VisionExcelConverter.get_node_id()
      • VisionExcelConverter.get_branch_id()
      • VisionExcelConverter.get_appliance_id()
      • VisionExcelConverter.get_virtual_id()
  • data_stores
    • BaseDataStore
      • BaseDataStore.__init__()
      • BaseDataStore.load()
      • BaseDataStore.save()
    • ExcelFileStore
      • ExcelFileStore.__init__()
      • ExcelFileStore.files()
      • ExcelFileStore.load()
      • ExcelFileStore.save()
    • JsonFileStore
      • JsonFileStore.__init__()
      • JsonFileStore.set_indent()
      • JsonFileStore.set_compact()
      • JsonFileStore.load()
      • JsonFileStore.save()
    • VisionExcelFileStore
      • VisionExcelFileStore.__init__()
  • data_types
    • StructuredData
    • TabularData
      • TabularData.__init__()
      • TabularData.set_unit_multipliers()
      • TabularData.set_substitutions()
      • TabularData.get_column()
      • TabularData.keys()
      • TabularData.items()
  • functions
    • has_value()
    • value_or_default()
    • value_or_zero()
    • complex_inverse_real_part()
    • complex_inverse_imaginary_part()
    • get_winding()
    • degrees_to_clock()
    • is_greater_than()
    • both_zeros_to_nan()
    • relative_no_load_current()
    • reactive_power()
    • power_wind_speed()
    • get_winding_from()
    • get_winding_to()
    • get_winding_1()
    • get_winding_2()
    • get_winding_3()
    • get_clock()
    • get_clock_12()
    • get_clock_13()
    • reactive_power_to_susceptance()
    • pvs_power_adjustment()
  • mappings
    • FieldMapping
      • FieldMapping.__init__()
    • MultiplierMapping
      • MultiplierMapping.__init__()
      • MultiplierMapping.get_multiplier()
    • TabularMapping
      • TabularMapping.__init__()
      • TabularMapping.tables()
      • TabularMapping.instances()
    • UnitMapping
      • UnitMapping.__init__()
      • UnitMapping.set_mapping()
      • UnitMapping.get_unit_multiplier()
    • ValueMapping
      • ValueMapping.__init__()
      • ValueMapping.get_substitutions()
  • utils
    • AutoID
      • AutoID.__init__()
    • merge_dicts()
    • ResponseInfo
      • ResponseInfo.status
      • ResponseInfo.file_name
      • ResponseInfo.file_size
      • ResponseInfo.__init__()
    • DownloadProgressHook
      • DownloadProgressHook.__init__()
    • safe_download_and_extract()
    • download_and_extract()
    • safe_download()
    • download()
    • safe_get_response_info()
    • get_response_info()
    • get_download_path()
    • JsonEncoder
      • JsonEncoder.default()
    • compact_json_dump()
    • get_function()
    • extract()

Contribution

• Code of Conduct
  • Our Pledge
  • Our Standards
  • Our Responsibilities
  • Scope
  • Conflict Resolution
  • Attribution
• How to Contribute
  • Ways of contributing
  • Filing bugs and change requests
  • Community Guidelines
  • Style Guide
  • pre-commit hooks
  • REUSE Compliance
  • Git branching
  • Signing the Developer Certificate of Origin (DCO)
  • Code reviews
  • Pull Request Process
  • Attribution
• Project Governance
  • Technical Steering Committee
  • Maintainers
  • Contributors
  • PyPI project management

Release and Support

• Release strategy
  • Actively supported Python versions
• Getting Help
  • How to ask for help, suggest a feature, or give recommendations.
  • How to report a bug
  • How to report a security vulnerability
  • Contributing a fix
• Security Policy
  • Supported Versions
  • Reporting a Vulnerability
• Citations