-
Notifications
You must be signed in to change notification settings - Fork 113
/
DownloadDataset.py
171 lines (137 loc) · 5.82 KB
/
DownloadDataset.py
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
# Copyright (c) 2019-2020, RTE (https://www.rte-france.com)
# See AUTHORS.txt
# This Source Code Form is subject to the terms of the Mozilla Public License, version 2.0.
# If a copy of the Mozilla Public License, version 2.0 was not distributed with this file,
# you can obtain one at http://mozilla.org/MPL/2.0/.
# SPDX-License-Identifier: MPL-2.0
# This file is part of Grid2Op, Grid2Op a testbed platform to model sequential decision making in power systems.
import os
import sys
from tqdm import tqdm
import re
import tarfile
from grid2op.Exceptions import Grid2OpException
try:
import urllib.request
except Exception as e:
raise RuntimeError("Impossible to find library urllib. Please install it.")
URL_GRID2OP_DATA = "https://github.com/Tezirg/Grid2Op/releases/download/{}/{}"
DATASET_TAG_v0_1_0 = "datasets-v0.1.0"
DICT_URL_GRID2OP_DL = {
"rte_case14_realistic": URL_GRID2OP_DATA.format(
DATASET_TAG_v0_1_0, "rte_case14_realistic.tar.bz2"
),
"rte_case14_redisp": URL_GRID2OP_DATA.format(
DATASET_TAG_v0_1_0, "rte_case14_redisp.tar.bz2"
),
"l2rpn_2019": URL_GRID2OP_DATA.format(DATASET_TAG_v0_1_0, "l2rpn_2019.tar.bz2"),
}
LI_VALID_ENV = sorted(['"{}"'.format(el) for el in DICT_URL_GRID2OP_DL.keys()])
class DownloadProgressBar(tqdm):
"""
INTERNAL
.. warning:: /!\\\\ Internal, do not use unless you know what you are doing /!\\\\
This class is here to show the progress bar when downloading this dataset
"""
def update_to(self, b=1, bsize=1, tsize=None):
if tsize is not None:
self.total = tsize
self.update(b * bsize - self.n)
def download_url(url, output_path):
"""
INTERNAL
.. warning:: /!\\\\ Internal, do not use unless you know what you are doing /!\\\\
This function download the file located at 'url' and save it to 'output_path'
Parameters
----------
url: ``str``
The url of the file to download
output_path: ``str``
The path where the data will be stored.
"""
with DownloadProgressBar(
unit="B", unit_scale=True, miniters=1, desc=url.split("/")[-1]
) as t:
urllib.request.urlretrieve(url, filename=output_path, reporthook=t.update_to)
def _aux_download(url, dataset_name, path_data, ds_name_dl=None):
"""
INTERNAL
.. warning:: /!\\\\ Internal, do not use unless you know what you are doing /!\\\\
"""
if ds_name_dl is None:
ds_name_dl = dataset_name
final_path = os.path.join(path_data, ds_name_dl)
if os.path.exists(final_path):
str_ = (
'Downloading and extracting this data would create a folder "{final_path}" '
"but this folder already exists. Either you already downloaded the data, in this case "
"you can invoke the environment from a python script with:\n"
'\t env = grid2op.make("{final_path}")\n'
'Alternatively you can also delete the folder "{final_path}" from your computer and run this command '
"again.\n"
"Finally, you can download the data in a different folder by specifying (in a command prompt):\n"
'\t grid2op.download --name "{env_name}" --path_save PATH\WHERE\YOU\WANT\TO\DOWNLOAD'
"".format(final_path=final_path, env_name=dataset_name)
)
print(str_)
raise Grid2OpException(str_)
if not os.path.exists(path_data):
print(
'Creating path "{}" where data for "{}" environment will be downloaded.'
"".format(path_data, ds_name_dl)
)
try:
os.mkdir(path_data)
except Exception as exc_:
str_ = (
'Impossible to create path "{}" to store the data. Please save the data in a different repository '
'with setting the argument "--path_save"'
"Error was:\n{}".format(path_data, exc_)
)
raise Grid2OpException(str_)
output_path = os.path.abspath(
os.path.join(path_data, "{}.tar.bz2".format(ds_name_dl))
)
# download the data (with progress bar)
print("downloading the training data, this may take a while.")
download_url(url, output_path)
tar = tarfile.open(output_path, "r:bz2")
print('Extract the tar archive in "{}"'.format(os.path.abspath(path_data)))
tar.extractall(path_data)
tar.close()
# rename the file if necessary
if ds_name_dl != dataset_name:
try:
os.rename(final_path, os.path.join(path_data, dataset_name))
except FileNotFoundError as exc_:
# the try catch is added because for some environments, the
# archive name does not match the env name.
# so the folder cannot be deleted properly.
print(f"WARN: file \"{final_path}\" could not be found. You might need to manually delete it.")
pass
# and rm the tar bz2
# bug in the AWS file... named ".tar.tar.bz2" ...
os.remove(output_path)
# check for update (if any)
from grid2op.MakeEnv.UpdateEnv import _update_files
_update_files(dataset_name)
print(
'You may now use the environment "{}" with the available data by invoking:\n'
'\tenv = grid2op.make("{}")'
"".format(dataset_name, dataset_name)
)
def main_download(dataset_name, path_data):
"""
INTERNAL
.. warning:: /!\\\\ Internal, do not use unless you know what you are doing /!\\\\
"""
dataset_name = dataset_name.lower().rstrip().lstrip()
dataset_name = re.sub('"', "", dataset_name)
if dataset_name not in DICT_URL_GRID2OP_DL:
print(
'Impossible to find environment named "{env_name}". Known environments are:\n{li_env}'
"".format(env_name=dataset_name, li_env=",".join(LI_VALID_ENV))
)
sys.exit(1)
url = DICT_URL_GRID2OP_DL[dataset_name]
_aux_download(url, dataset_name, path_data)