gridfm-datakit 0.0.1__tar.gz

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (32) hide show
  1. gridfm_datakit-0.0.1/LICENSE +201 -0
  2. gridfm_datakit-0.0.1/PKG-INFO +169 -0
  3. gridfm_datakit-0.0.1/README.md +130 -0
  4. gridfm_datakit-0.0.1/gridfm_datakit/__init__.py +10 -0
  5. gridfm_datakit-0.0.1/gridfm_datakit/cli.py +32 -0
  6. gridfm_datakit-0.0.1/gridfm_datakit/generate.py +449 -0
  7. gridfm_datakit-0.0.1/gridfm_datakit/grids/__init__.py +0 -0
  8. gridfm_datakit-0.0.1/gridfm_datakit/interactive.py +538 -0
  9. gridfm_datakit-0.0.1/gridfm_datakit/load_profiles/__init__.py +0 -0
  10. gridfm_datakit-0.0.1/gridfm_datakit/network.py +94 -0
  11. gridfm_datakit-0.0.1/gridfm_datakit/perturbations/__init__.py +0 -0
  12. gridfm_datakit-0.0.1/gridfm_datakit/perturbations/load_perturbation.py +507 -0
  13. gridfm_datakit-0.0.1/gridfm_datakit/perturbations/topology_perturbation.py +222 -0
  14. gridfm_datakit-0.0.1/gridfm_datakit/process/__init__.py +0 -0
  15. gridfm_datakit-0.0.1/gridfm_datakit/process/process_network.py +489 -0
  16. gridfm_datakit-0.0.1/gridfm_datakit/process/solvers.py +290 -0
  17. gridfm_datakit-0.0.1/gridfm_datakit/save.py +225 -0
  18. gridfm_datakit-0.0.1/gridfm_datakit/utils/__init__.py +0 -0
  19. gridfm_datakit-0.0.1/gridfm_datakit/utils/config.py +7 -0
  20. gridfm_datakit-0.0.1/gridfm_datakit/utils/param_handler.py +250 -0
  21. gridfm_datakit-0.0.1/gridfm_datakit/utils/stats.py +183 -0
  22. gridfm_datakit-0.0.1/gridfm_datakit/utils/utils.py +30 -0
  23. gridfm_datakit-0.0.1/gridfm_datakit.egg-info/PKG-INFO +169 -0
  24. gridfm_datakit-0.0.1/gridfm_datakit.egg-info/SOURCES.txt +30 -0
  25. gridfm_datakit-0.0.1/gridfm_datakit.egg-info/dependency_links.txt +1 -0
  26. gridfm_datakit-0.0.1/gridfm_datakit.egg-info/entry_points.txt +2 -0
  27. gridfm_datakit-0.0.1/gridfm_datakit.egg-info/requires.txt +26 -0
  28. gridfm_datakit-0.0.1/gridfm_datakit.egg-info/top_level.txt +1 -0
  29. gridfm_datakit-0.0.1/pyproject.toml +67 -0
  30. gridfm_datakit-0.0.1/setup.cfg +4 -0
  31. gridfm_datakit-0.0.1/tests/test_generate.py +299 -0
  32. gridfm_datakit-0.0.1/tests/test_yaml_configs.py +63 -0
@@ -0,0 +1,201 @@
1
+ Apache License
2
+ Version 2.0, January 2004
3
+ http://www.apache.org/licenses/
4
+
5
+ TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
6
+
7
+ 1. Definitions.
8
+
9
+ "License" shall mean the terms and conditions for use, reproduction,
10
+ and distribution as defined by Sections 1 through 9 of this document.
11
+
12
+ "Licensor" shall mean the copyright owner or entity authorized by
13
+ the copyright owner that is granting the License.
14
+
15
+ "Legal Entity" shall mean the union of the acting entity and all
16
+ other entities that control, are controlled by, or are under common
17
+ control with that entity. For the purposes of this definition,
18
+ "control" means (i) the power, direct or indirect, to cause the
19
+ direction or management of such entity, whether by contract or
20
+ otherwise, or (ii) ownership of fifty percent (50%) or more of the
21
+ outstanding shares, or (iii) beneficial ownership of such entity.
22
+
23
+ "You" (or "Your") shall mean an individual or Legal Entity
24
+ exercising permissions granted by this License.
25
+
26
+ "Source" form shall mean the preferred form for making modifications,
27
+ including but not limited to software source code, documentation
28
+ source, and configuration files.
29
+
30
+ "Object" form shall mean any form resulting from mechanical
31
+ transformation or translation of a Source form, including but
32
+ not limited to compiled object code, generated documentation,
33
+ and conversions to other media types.
34
+
35
+ "Work" shall mean the work of authorship, whether in Source or
36
+ Object form, made available under the License, as indicated by a
37
+ copyright notice that is included in or attached to the work
38
+ (an example is provided in the Appendix below).
39
+
40
+ "Derivative Works" shall mean any work, whether in Source or Object
41
+ form, that is based on (or derived from) the Work and for which the
42
+ editorial revisions, annotations, elaborations, or other modifications
43
+ represent, as a whole, an original work of authorship. For the purposes
44
+ of this License, Derivative Works shall not include works that remain
45
+ separable from, or merely link (or bind by name) to the interfaces of,
46
+ the Work and Derivative Works thereof.
47
+
48
+ "Contribution" shall mean any work of authorship, including
49
+ the original version of the Work and any modifications or additions
50
+ to that Work or Derivative Works thereof, that is intentionally
51
+ submitted to Licensor for inclusion in the Work by the copyright owner
52
+ or by an individual or Legal Entity authorized to submit on behalf of
53
+ the copyright owner. For the purposes of this definition, "submitted"
54
+ means any form of electronic, verbal, or written communication sent
55
+ to the Licensor or its representatives, including but not limited to
56
+ communication on electronic mailing lists, source code control systems,
57
+ and issue tracking systems that are managed by, or on behalf of, the
58
+ Licensor for the purpose of discussing and improving the Work, but
59
+ excluding communication that is conspicuously marked or otherwise
60
+ designated in writing by the copyright owner as "Not a Contribution."
61
+
62
+ "Contributor" shall mean Licensor and any individual or Legal Entity
63
+ on behalf of whom a Contribution has been received by Licensor and
64
+ subsequently incorporated within the Work.
65
+
66
+ 2. Grant of Copyright License. Subject to the terms and conditions of
67
+ this License, each Contributor hereby grants to You a perpetual,
68
+ worldwide, non-exclusive, no-charge, royalty-free, irrevocable
69
+ copyright license to reproduce, prepare Derivative Works of,
70
+ publicly display, publicly perform, sublicense, and distribute the
71
+ Work and such Derivative Works in Source or Object form.
72
+
73
+ 3. Grant of Patent License. Subject to the terms and conditions of
74
+ this License, each Contributor hereby grants to You a perpetual,
75
+ worldwide, non-exclusive, no-charge, royalty-free, irrevocable
76
+ (except as stated in this section) patent license to make, have made,
77
+ use, offer to sell, sell, import, and otherwise transfer the Work,
78
+ where such license applies only to those patent claims licensable
79
+ by such Contributor that are necessarily infringed by their
80
+ Contribution(s) alone or by combination of their Contribution(s)
81
+ with the Work to which such Contribution(s) was submitted. If You
82
+ institute patent litigation against any entity (including a
83
+ cross-claim or counterclaim in a lawsuit) alleging that the Work
84
+ or a Contribution incorporated within the Work constitutes direct
85
+ or contributory patent infringement, then any patent licenses
86
+ granted to You under this License for that Work shall terminate
87
+ as of the date such litigation is filed.
88
+
89
+ 4. Redistribution. You may reproduce and distribute copies of the
90
+ Work or Derivative Works thereof in any medium, with or without
91
+ modifications, and in Source or Object form, provided that You
92
+ meet the following conditions:
93
+
94
+ (a) You must give any other recipients of the Work or
95
+ Derivative Works a copy of this License; and
96
+
97
+ (b) You must cause any modified files to carry prominent notices
98
+ stating that You changed the files; and
99
+
100
+ (c) You must retain, in the Source form of any Derivative Works
101
+ that You distribute, all copyright, patent, trademark, and
102
+ attribution notices from the Source form of the Work,
103
+ excluding those notices that do not pertain to any part of
104
+ the Derivative Works; and
105
+
106
+ (d) If the Work includes a "NOTICE" text file as part of its
107
+ distribution, then any Derivative Works that You distribute must
108
+ include a readable copy of the attribution notices contained
109
+ within such NOTICE file, excluding those notices that do not
110
+ pertain to any part of the Derivative Works, in at least one
111
+ of the following places: within a NOTICE text file distributed
112
+ as part of the Derivative Works; within the Source form or
113
+ documentation, if provided along with the Derivative Works; or,
114
+ within a display generated by the Derivative Works, if and
115
+ wherever such third-party notices normally appear. The contents
116
+ of the NOTICE file are for informational purposes only and
117
+ do not modify the License. You may add Your own attribution
118
+ notices within Derivative Works that You distribute, alongside
119
+ or as an addendum to the NOTICE text from the Work, provided
120
+ that such additional attribution notices cannot be construed
121
+ as modifying the License.
122
+
123
+ You may add Your own copyright statement to Your modifications and
124
+ may provide additional or different license terms and conditions
125
+ for use, reproduction, or distribution of Your modifications, or
126
+ for any such Derivative Works as a whole, provided Your use,
127
+ reproduction, and distribution of the Work otherwise complies with
128
+ the conditions stated in this License.
129
+
130
+ 5. Submission of Contributions. Unless You explicitly state otherwise,
131
+ any Contribution intentionally submitted for inclusion in the Work
132
+ by You to the Licensor shall be under the terms and conditions of
133
+ this License, without any additional terms or conditions.
134
+ Notwithstanding the above, nothing herein shall supersede or modify
135
+ the terms of any separate license agreement you may have executed
136
+ with Licensor regarding such Contributions.
137
+
138
+ 6. Trademarks. This License does not grant permission to use the trade
139
+ names, trademarks, service marks, or product names of the Licensor,
140
+ except as required for reasonable and customary use in describing the
141
+ origin of the Work and reproducing the content of the NOTICE file.
142
+
143
+ 7. Disclaimer of Warranty. Unless required by applicable law or
144
+ agreed to in writing, Licensor provides the Work (and each
145
+ Contributor provides its Contributions) on an "AS IS" BASIS,
146
+ WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
147
+ implied, including, without limitation, any warranties or conditions
148
+ of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
149
+ PARTICULAR PURPOSE. You are solely responsible for determining the
150
+ appropriateness of using or redistributing the Work and assume any
151
+ risks associated with Your exercise of permissions under this License.
152
+
153
+ 8. Limitation of Liability. In no event and under no legal theory,
154
+ whether in tort (including negligence), contract, or otherwise,
155
+ unless required by applicable law (such as deliberate and grossly
156
+ negligent acts) or agreed to in writing, shall any Contributor be
157
+ liable to You for damages, including any direct, indirect, special,
158
+ incidental, or consequential damages of any character arising as a
159
+ result of this License or out of the use or inability to use the
160
+ Work (including but not limited to damages for loss of goodwill,
161
+ work stoppage, computer failure or malfunction, or any and all
162
+ other commercial damages or losses), even if such Contributor
163
+ has been advised of the possibility of such damages.
164
+
165
+ 9. Accepting Warranty or Additional Liability. While redistributing
166
+ the Work or Derivative Works thereof, You may choose to offer,
167
+ and charge a fee for, acceptance of support, warranty, indemnity,
168
+ or other liability obligations and/or rights consistent with this
169
+ License. However, in accepting such obligations, You may act only
170
+ on Your own behalf and on Your sole responsibility, not on behalf
171
+ of any other Contributor, and only if You agree to indemnify,
172
+ defend, and hold each Contributor harmless for any liability
173
+ incurred by, or claims asserted against, such Contributor by reason
174
+ of your accepting any such warranty or additional liability.
175
+
176
+ END OF TERMS AND CONDITIONS
177
+
178
+ APPENDIX: How to apply the Apache License to your work.
179
+
180
+ To apply the Apache License to your work, attach the following
181
+ boilerplate notice, with the fields enclosed by brackets "[]"
182
+ replaced with your own identifying information. (Don't include
183
+ the brackets!) The text should be enclosed in the appropriate
184
+ comment syntax for the file format. We also recommend that a
185
+ file or class name and description of purpose be included on the
186
+ same "printed page" as the copyright notice for easier
187
+ identification within third-party archives.
188
+
189
+ Copyright [yyyy] [name of copyright owner]
190
+
191
+ Licensed under the Apache License, Version 2.0 (the "License");
192
+ you may not use this file except in compliance with the License.
193
+ You may obtain a copy of the License at
194
+
195
+ http://www.apache.org/licenses/LICENSE-2.0
196
+
197
+ Unless required by applicable law or agreed to in writing, software
198
+ distributed under the License is distributed on an "AS IS" BASIS,
199
+ WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
200
+ See the License for the specific language governing permissions and
201
+ limitations under the License.
@@ -0,0 +1,169 @@
1
+ Metadata-Version: 2.4
2
+ Name: gridfm-datakit
3
+ Version: 0.0.1
4
+ Summary: Data Generation Kit
5
+ Author-email: Alban Puech <apuech@seas.harvard.edu>, Matteo Mazzonelli <matteo.mazzonelli1@ibm.com>, Tamara Govindasamy <tamara.govindasamy@ibm.com>, Mangaliso Mngomezulu <mngomezulum@ibm.com>, Etienne Vos <etienne.vos@ibm.com>, Jonas Weiss <jwe@zurich.ibm.com>
6
+ Maintainer-email: Alban Puech <apuech@seas.harvard.edu>
7
+ License-Expression: Apache-2.0
8
+ Classifier: Development Status :: 2 - Pre-Alpha
9
+ Classifier: Programming Language :: Python :: 3.9
10
+ Classifier: Topic :: Scientific/Engineering
11
+ Requires-Python: <3.13,>=3.9
12
+ Description-Content-Type: text/markdown
13
+ License-File: LICENSE
14
+ Requires-Dist: ipykernel
15
+ Requires-Dist: matplotlib
16
+ Requires-Dist: matpowercaseframes
17
+ Requires-Dist: nbformat
18
+ Requires-Dist: numba
19
+ Requires-Dist: numpy
20
+ Requires-Dist: pandapower==2.14.11
21
+ Requires-Dist: pandas
22
+ Requires-Dist: pathlib
23
+ Requires-Dist: plotly
24
+ Requires-Dist: pyaml
25
+ Requires-Dist: requests
26
+ Requires-Dist: urllib3<2.0.0
27
+ Requires-Dist: ipywidgets
28
+ Provides-Extra: dev
29
+ Requires-Dist: mkdocs; extra == "dev"
30
+ Requires-Dist: mkdocs-material; extra == "dev"
31
+ Requires-Dist: mkdocstrings[python]; extra == "dev"
32
+ Requires-Dist: pre-commit; extra == "dev"
33
+ Requires-Dist: bandit; extra == "dev"
34
+ Requires-Dist: build; extra == "dev"
35
+ Provides-Extra: test
36
+ Requires-Dist: pytest; extra == "test"
37
+ Requires-Dist: pytest-cov; extra == "test"
38
+ Dynamic: license-file
39
+
40
+ [![Docs](https://img.shields.io/badge/docs-available-brightgreen)](https://gridfm.github.io/gridfm-datakit/)
41
+ ![Coverage](https://img.shields.io/badge/coverage-76%25-yellow)
42
+
43
+
44
+ # Overview
45
+
46
+
47
+ This library is brought to you by the GridFM team to generate power flow data to train machine learning and foundation models.
48
+
49
+
50
+
51
+ <p align="center">
52
+ <img src="figs/pipeline.png" alt=""/>
53
+ <br/>
54
+ </p>
55
+
56
+
57
+ ---
58
+
59
+
60
+
61
+ ## Comparison with other PF datasets/ libraries
62
+
63
+ | Feature | GraphNeuralSolver [\[1\]](https://doi.org/10.1016/j.epsr.2020.106547)| OPFData [\[2\]](https://arxiv.org/abs/2406.07234) | OPFLearn [\[3\]](https://arxiv.org/abs/2111.01228)| PowerFlowNet [\[4\]](https://arxiv.org/abs/2311.03415) | TypedGNN [\[5\]](https://doi.org/10.1016/j.engappai.2022.105567)| PF△ [\[6\]](https://www.climatechange.ai/papers/iclr2025/67)| **gridfm-datakit** [\[7\]](https://www.cell.com/joule/fulltext/S2542-4351(24)00470-7) |
64
+ | ---------------------------------------------------------- | ----------------- | ------- | -------- | ------------ | -------- | --- | ---------- |
65
+ | Generator Profile | ✅ | ❌ | ❌ | ✅ | ✅ | ✅ | ❌ |
66
+ | N-1 | ❌ | ✅ | ✅ | ✅ | ✅ | ✅ | ✅ |
67
+ | > 1000 Buses | ❌ | ✅ | ✅ | ❌ | ❌ | ✅ | ✅ |
68
+ | N-k, k > 1 | ❌ | ❌ | ❌ | ❌ | ❌ | ❌ | ✅ |
69
+ | Load Scenarios from Real World Data | ❌ | ❌ | ❌ | ❌ | ❌ | ❌ | ✅ |
70
+ | Multi-processing and scalable to very large (1M+) datasets | ❌ | ❌ | ❌ | ❌ | ❌ | ❌ | ✅ |
71
+
72
+
73
+ # Installation
74
+
75
+ 1. ⭐ Star the [repository](https://github.com/gridfm/gridfm-datakit) on GitHub to support the project!
76
+
77
+ 2. Clone the repository and set up a Python virtual environment:
78
+
79
+ ```bash
80
+ git clone https://github.com/gridfm/gridfm-datakit.git
81
+ cd "gridfm-datakit"
82
+ python3 -m venv venv
83
+ source venv/bin/activate
84
+ python -m pip install --upgrade pip # Upgrade pip to ensure compatibility with pyproject.toml
85
+ pip3 install .
86
+ ```
87
+
88
+ # Getting Started
89
+
90
+ ## Option 1: Run data gen using interactive interface
91
+
92
+ To use the interactive interface, either open `scripts/interactive_interface.ipynb` or copy the following into a Jupyter notebook and follow the instructions:
93
+
94
+ ```python
95
+ from gridfm_datakit.interactive_utils import interactive_interface
96
+ interactive_interface()
97
+ ```
98
+
99
+
100
+ ## Option 2: Using the command line interface
101
+
102
+ Run the data generation routine from the command line:
103
+
104
+ ```bash
105
+ gridfm_datakit path/to/config.yaml
106
+ ```
107
+
108
+
109
+ ## Configuration Overview
110
+
111
+ Refer to the sections [Network](network.md), [Load Scenarios](load_scenarios.md), and [Topology perturbations](topology_perturbations.md) for a description of the configuration parameters.
112
+
113
+ Sample configuration files are provided in `scripts/config`, e.g. `default.yaml`:
114
+
115
+ ```yaml
116
+ network:
117
+ name: "case24_ieee_rts" # Name of the power grid network (without extension)
118
+ source: "pglib" # Data source for the grid; options: pglib, pandapower, file
119
+ network_dir: "scripts/grids" # if using source "file", this is the directory containing the network file (relative to the project root)
120
+
121
+
122
+ load:
123
+ generator: "agg_load_profile" # Name of the load generator; options: agg_load_profile, powergraph
124
+ agg_profile: "default" # Name of the aggregated load profile
125
+ scenarios: 200 # Number of different load scenarios to generate
126
+ # WARNING: the following parameters are only used if generator is "agg_load_profile"
127
+ # if using generator "powergraph", these parameters are ignored
128
+ sigma: 0.05 # max local noise
129
+ change_reactive_power: true # If true, changes reactive power of loads. If False, keeps the ones from the case file
130
+ global_range: 0.4 # Range of the global scaling factor. used to set the lower bound of the scaling factor
131
+ max_scaling_factor: 4.0 # Max upper bound of the global scaling factor
132
+ step_size: 0.025 # Step size when finding the upper bound of the global scaling factor
133
+ start_scaling_factor: 0.8 # Initial value of the global scaling factor
134
+
135
+ topology_perturbation:
136
+ type: "random" # Type of topology generator; options: n_minus_k, random, none
137
+ # WARNING: the following parameters are only used if type is not "none"
138
+ k: 1 # Maximum number of components to drop in each perturbation
139
+ n_topology_variants: 5 # Number of unique perturbed topologies per scenario
140
+ elements: ["line", "trafo", "gen", "sgen"] # elements to perturb options: line, trafo, gen, sgen
141
+
142
+ settings:
143
+ num_processes: 10 # Number of parallel processes to use
144
+ data_dir: "./data_out" # Directory to save generated data relative to the project root
145
+ large_chunk_size: 50 # Number of load scenarios processed before saving
146
+ no_stats: false # If true, disables statistical calculations
147
+ overwrite: true # If true, overwrites existing files, if false, appends to files (note that bus_params.csv, edge_params.csv, scenarios_{load.generator}.csv and scenarios_{load.generator}.html will still be overwritten)
148
+ mode: "pf" # Mode of the script; options: contingency, pf
149
+ ```
150
+
151
+ <br>
152
+
153
+ ## Output Files
154
+
155
+ The data generation process produces several output files in the specified data directory:
156
+
157
+ - **tqdm.log**: Progress bar log.
158
+ - **error.log**: Log of the errors raised during data generation.
159
+ - **args.log**: Copy of the config file used.
160
+ - **pf_node.csv**: Data related to the nodes (buses) in the network, such as voltage levels and power injections.
161
+ - **pf_edge.csv**: Branch admittance matrix for each pf case.
162
+ - **branch_idx_removed.csv**: List of the indices of the branches (lines and transformers) that got removed when perturbing the topologies.
163
+ - **edge_params.csv**: Branch admittance matrix and branch rate limits for the unperturbed topology.
164
+ - **bus_params.csv**: Parameters for the buses (voltage limits and the base voltage).
165
+ - **scenario_{args.load.generator}.csv**: Load element-level load profile obtained after using the load scenario generator.
166
+ - **scenario_{args.load.generator}.html**: Plots of the element-level load profile.
167
+ - **scenario_{args.load.generator}.log**: If generator is "agg_load_profile", stores the upper and lower bounds for the global scaling factor.
168
+ - **stats.csv**: Stats about the generated data.
169
+ - **stats_plot.html**: Plots of the stats about the generated data.
@@ -0,0 +1,130 @@
1
+ [![Docs](https://img.shields.io/badge/docs-available-brightgreen)](https://gridfm.github.io/gridfm-datakit/)
2
+ ![Coverage](https://img.shields.io/badge/coverage-76%25-yellow)
3
+
4
+
5
+ # Overview
6
+
7
+
8
+ This library is brought to you by the GridFM team to generate power flow data to train machine learning and foundation models.
9
+
10
+
11
+
12
+ <p align="center">
13
+ <img src="figs/pipeline.png" alt=""/>
14
+ <br/>
15
+ </p>
16
+
17
+
18
+ ---
19
+
20
+
21
+
22
+ ## Comparison with other PF datasets/ libraries
23
+
24
+ | Feature | GraphNeuralSolver [\[1\]](https://doi.org/10.1016/j.epsr.2020.106547)| OPFData [\[2\]](https://arxiv.org/abs/2406.07234) | OPFLearn [\[3\]](https://arxiv.org/abs/2111.01228)| PowerFlowNet [\[4\]](https://arxiv.org/abs/2311.03415) | TypedGNN [\[5\]](https://doi.org/10.1016/j.engappai.2022.105567)| PF△ [\[6\]](https://www.climatechange.ai/papers/iclr2025/67)| **gridfm-datakit** [\[7\]](https://www.cell.com/joule/fulltext/S2542-4351(24)00470-7) |
25
+ | ---------------------------------------------------------- | ----------------- | ------- | -------- | ------------ | -------- | --- | ---------- |
26
+ | Generator Profile | ✅ | ❌ | ❌ | ✅ | ✅ | ✅ | ❌ |
27
+ | N-1 | ❌ | ✅ | ✅ | ✅ | ✅ | ✅ | ✅ |
28
+ | > 1000 Buses | ❌ | ✅ | ✅ | ❌ | ❌ | ✅ | ✅ |
29
+ | N-k, k > 1 | ❌ | ❌ | ❌ | ❌ | ❌ | ❌ | ✅ |
30
+ | Load Scenarios from Real World Data | ❌ | ❌ | ❌ | ❌ | ❌ | ❌ | ✅ |
31
+ | Multi-processing and scalable to very large (1M+) datasets | ❌ | ❌ | ❌ | ❌ | ❌ | ❌ | ✅ |
32
+
33
+
34
+ # Installation
35
+
36
+ 1. ⭐ Star the [repository](https://github.com/gridfm/gridfm-datakit) on GitHub to support the project!
37
+
38
+ 2. Clone the repository and set up a Python virtual environment:
39
+
40
+ ```bash
41
+ git clone https://github.com/gridfm/gridfm-datakit.git
42
+ cd "gridfm-datakit"
43
+ python3 -m venv venv
44
+ source venv/bin/activate
45
+ python -m pip install --upgrade pip # Upgrade pip to ensure compatibility with pyproject.toml
46
+ pip3 install .
47
+ ```
48
+
49
+ # Getting Started
50
+
51
+ ## Option 1: Run data gen using interactive interface
52
+
53
+ To use the interactive interface, either open `scripts/interactive_interface.ipynb` or copy the following into a Jupyter notebook and follow the instructions:
54
+
55
+ ```python
56
+ from gridfm_datakit.interactive_utils import interactive_interface
57
+ interactive_interface()
58
+ ```
59
+
60
+
61
+ ## Option 2: Using the command line interface
62
+
63
+ Run the data generation routine from the command line:
64
+
65
+ ```bash
66
+ gridfm_datakit path/to/config.yaml
67
+ ```
68
+
69
+
70
+ ## Configuration Overview
71
+
72
+ Refer to the sections [Network](network.md), [Load Scenarios](load_scenarios.md), and [Topology perturbations](topology_perturbations.md) for a description of the configuration parameters.
73
+
74
+ Sample configuration files are provided in `scripts/config`, e.g. `default.yaml`:
75
+
76
+ ```yaml
77
+ network:
78
+ name: "case24_ieee_rts" # Name of the power grid network (without extension)
79
+ source: "pglib" # Data source for the grid; options: pglib, pandapower, file
80
+ network_dir: "scripts/grids" # if using source "file", this is the directory containing the network file (relative to the project root)
81
+
82
+
83
+ load:
84
+ generator: "agg_load_profile" # Name of the load generator; options: agg_load_profile, powergraph
85
+ agg_profile: "default" # Name of the aggregated load profile
86
+ scenarios: 200 # Number of different load scenarios to generate
87
+ # WARNING: the following parameters are only used if generator is "agg_load_profile"
88
+ # if using generator "powergraph", these parameters are ignored
89
+ sigma: 0.05 # max local noise
90
+ change_reactive_power: true # If true, changes reactive power of loads. If False, keeps the ones from the case file
91
+ global_range: 0.4 # Range of the global scaling factor. used to set the lower bound of the scaling factor
92
+ max_scaling_factor: 4.0 # Max upper bound of the global scaling factor
93
+ step_size: 0.025 # Step size when finding the upper bound of the global scaling factor
94
+ start_scaling_factor: 0.8 # Initial value of the global scaling factor
95
+
96
+ topology_perturbation:
97
+ type: "random" # Type of topology generator; options: n_minus_k, random, none
98
+ # WARNING: the following parameters are only used if type is not "none"
99
+ k: 1 # Maximum number of components to drop in each perturbation
100
+ n_topology_variants: 5 # Number of unique perturbed topologies per scenario
101
+ elements: ["line", "trafo", "gen", "sgen"] # elements to perturb options: line, trafo, gen, sgen
102
+
103
+ settings:
104
+ num_processes: 10 # Number of parallel processes to use
105
+ data_dir: "./data_out" # Directory to save generated data relative to the project root
106
+ large_chunk_size: 50 # Number of load scenarios processed before saving
107
+ no_stats: false # If true, disables statistical calculations
108
+ overwrite: true # If true, overwrites existing files, if false, appends to files (note that bus_params.csv, edge_params.csv, scenarios_{load.generator}.csv and scenarios_{load.generator}.html will still be overwritten)
109
+ mode: "pf" # Mode of the script; options: contingency, pf
110
+ ```
111
+
112
+ <br>
113
+
114
+ ## Output Files
115
+
116
+ The data generation process produces several output files in the specified data directory:
117
+
118
+ - **tqdm.log**: Progress bar log.
119
+ - **error.log**: Log of the errors raised during data generation.
120
+ - **args.log**: Copy of the config file used.
121
+ - **pf_node.csv**: Data related to the nodes (buses) in the network, such as voltage levels and power injections.
122
+ - **pf_edge.csv**: Branch admittance matrix for each pf case.
123
+ - **branch_idx_removed.csv**: List of the indices of the branches (lines and transformers) that got removed when perturbing the topologies.
124
+ - **edge_params.csv**: Branch admittance matrix and branch rate limits for the unperturbed topology.
125
+ - **bus_params.csv**: Parameters for the buses (voltage limits and the base voltage).
126
+ - **scenario_{args.load.generator}.csv**: Load element-level load profile obtained after using the load scenario generator.
127
+ - **scenario_{args.load.generator}.html**: Plots of the element-level load profile.
128
+ - **scenario_{args.load.generator}.log**: If generator is "agg_load_profile", stores the upper and lower bounds for the global scaling factor.
129
+ - **stats.csv**: Stats about the generated data.
130
+ - **stats_plot.html**: Plots of the stats about the generated data.
@@ -0,0 +1,10 @@
1
+ """gridfm-datakit - A library for generating synthetic power grid data."""
2
+
3
+ from gridfm_datakit.generate import (
4
+ generate_power_flow_data,
5
+ generate_power_flow_data_distributed,
6
+ )
7
+
8
+ __version__ = "0.1.0"
9
+
10
+ __all__ = ["generate_power_flow_data", "generate_power_flow_data_distributed"]
@@ -0,0 +1,32 @@
1
+ #!/usr/bin/env python3
2
+ """Command-line interface for generating power flow data."""
3
+
4
+ import argparse
5
+ from gridfm_datakit.generate import (
6
+ generate_power_flow_data_distributed,
7
+ )
8
+
9
+
10
+ def main():
11
+ """Command-line interface for the data generation script."""
12
+ parser = argparse.ArgumentParser(
13
+ description="Generate power flow data for grid analysis",
14
+ )
15
+
16
+ parser.add_argument(
17
+ "config",
18
+ type=str,
19
+ help="Path to config file",
20
+ )
21
+
22
+ args = parser.parse_args()
23
+ file_paths = generate_power_flow_data_distributed(args.config)
24
+
25
+ print("\nData generation complete.")
26
+ print("Generated files:")
27
+ for key, path in file_paths.items():
28
+ print(f"- {key}: {path}")
29
+
30
+
31
+ if __name__ == "__main__":
32
+ main()