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 is possible. Pandapower conversions are under development.

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
  • Loading data
  • Saving Data
• Tabular converter
  • Mapping file
  • Grid
  • Field Definitions
  • Units
  • Substitutions
  • AutoID
  • AutoID Mapping
  • Advanced AutoID Mapping
• Vision converter
  • Load rate of elements
  • Transformer load modelling
  • Voltage angle of buses in symmetric power-flow
  • Modelling differences or unsupported attributes
• Pandapower converter
  • Defaults
  • Modelling 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
  • 4. Converting output data
  • 5. Asymmetrical Calculations
  • Summary

API Documentation

• power_grid_model_io
  • cli
  • converters
    • BaseConverter
      • BaseConverter.__init__()
      • BaseConverter.load_input_data()
      • BaseConverter.load_update_data()
      • BaseConverter.load_sym_output_data()
      • BaseConverter.load_asym_output_data()
      • BaseConverter.convert()
      • BaseConverter.save()
    • TabularConverter
      • TabularConverter.__init__()
      • TabularConverter.set_mapping_file()
      • TabularConverter.set_mapping()
      • TabularConverter.get_id()
      • TabularConverter.get_ids()
      • TabularConverter.lookup_id()
      • TabularConverter.lookup_ids()
    • 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()
    • PgmJsonConverter
      • PgmJsonConverter.__init__()
  • 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
    • 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
    • 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__()
    • get_function()

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

Release and Support

• Release strategy
• 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
• Citations