Note: The default ITS GitLab runner is a shared resource and is subject to slowdowns during heavy usage.
You can run your own GitLab runner that is dedicated just to your group if you need to avoid processing delays.

DOCUMENTATION.markdown 9.53 KB
Newer Older
Qusai Al Shidi's avatar
Qusai Al Shidi committed
1
2
3
# Table of Contents

* [swmfpy](#.swmfpy)
4
5
6
7
* [swmfpy.web](#.swmfpy.web)
  * [get\_omni\_data](#.swmfpy.web.get_omni_data)
  * [download\_magnetogram\_hmi](#.swmfpy.web.download_magnetogram_hmi)
  * [download\_magnetogram\_adapt](#.swmfpy.web.download_magnetogram_adapt)
Qusai Al Shidi's avatar
Qusai Al Shidi committed
8
9
10
11
* [swmfpy.io](#.swmfpy.io)
  * [read\_wdc\_ae](#.swmfpy.io.read_wdc_ae)
  * [read\_wdc\_asy\_sym](#.swmfpy.io.read_wdc_asy_sym)
  * [read\_gm\_log](#.swmfpy.io.read_gm_log)
12
* [swmfpy.tools](#.swmfpy.tools)
Qusai Al Shidi's avatar
Qusai Al Shidi committed
13
14
15
16
* [swmfpy.paramin](#.swmfpy.paramin)
  * [replace\_command](#.swmfpy.paramin.replace_command)
  * [read\_command](#.swmfpy.paramin.read_command)

Qusai Al Shidi's avatar
Qusai Al Shidi committed
17
18
<a name=".swmfpy"></a>
## swmfpy
19

Qusai Al Shidi's avatar
Autodoc    
Qusai Al Shidi committed
20
21
A collection of tools to read, write, visualize with the
Space Weather Modeling Framework (SWMF).
22

Qusai Al Shidi's avatar
Autodoc    
Qusai Al Shidi committed
23
24
Modules
-------
25

Qusai Al Shidi's avatar
Autodoc    
Qusai Al Shidi committed
26
These are automatically imported.
27

28
29
30
- `swmfpy.io` Input/Output tools.
- `swmfpy.paramin` PARAM.in editing tools.
- `swmfpy.web` Internet data downloading/uploading tools.
31

Qusai Al Shidi's avatar
Autodoc    
Qusai Al Shidi committed
32
33
Extra Modules
-------------
34

Qusai Al Shidi's avatar
Autodoc    
Qusai Al Shidi committed
35
These are not automatically imported. Might have extra dependancies.
36

Qusai Al Shidi's avatar
Autodoc    
Qusai Al Shidi committed
37
*None yet.*
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
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
<a name=".swmfpy.web"></a>
## swmfpy.web

Tools to retrieve and send data on the web.

Here are a collection of tools to work with data on the internet. Thus,
this module mostly requires an internet connection.

<a name=".swmfpy.web.get_omni_data"></a>
#### get\_omni\_data

```python
get_omni_data(time_from, time_to, **kwargs)
```

Retrieve omni solar wind data over http.

This will download omni data from https://spdf.gsfc.nasa.gov/pub/data/omni
and put it into a dictionary. If your data is large, then make a csv and
use swmfpy.io.read_omni_data().

**Arguments**:

- `time_from` _datetime.datetime_ - The start time of the solar wind
  data that you want to receive.
- `time_to` _datetime.datetime_ - The end time of the solar wind data
  you want to receive.
  

**Returns**:

- `dict` - This will be a list of *all* columns
  available in the omni data set.
  

**Examples**:

  ```python
  import datetime
  import swmfpy.web
  
  storm_start = datetime.datetime(year=2000, month=1, day=1)
  storm_end = datetime.datetime(year=2000, month=2, day=15)
  data = swmfpy.web.get_omni_data(time_from=storm_start,
  time_to=storm_end)
  ```

<a name=".swmfpy.web.download_magnetogram_hmi"></a>
#### download\_magnetogram\_hmi

```python
download_magnetogram_hmi(mag_time, hmi_map='hmi.B_720s', **kwargs)
```

Downloads HMI vector magnetogram fits files.

This will download vector magnetogram FITS files from
Joint Science Operations Center (JSOC) near a certain hour.

This unfortunately depends on sunpy and drms, if you don't have it try,


```bash
pip install -U --user sunpy drms
```

**Arguments**:

- `mag_time` _datetime.datetime_ - Time after which to find
  vector magnetograms.
- `hmi_map` _str_ - JSOC prefix for hmi maps. Currently can only do
  'hmi.B_720s' and 'hmi.b_synoptic.small'.
  
  **kwargs:
- `download_dir` _str_ - Relative directory to download to.
- `verbose` _bool_ - (default False) print out the files it's downloading.
  

**Returns**:

- `str` - list of filenames downloaded.
  

**Raises**:

- `ImportError` - If module `drms` is not found.
- `FileNotFoundError` - If the JSOC doesn't have the magnetograms for that
  time.
  

**Examples**:

  ```python
  from swmfpy.web import download_magnetogram_hmi
  import datetime as dt
  
  # I am interested in the hmi vector magnetogram from 2014, 2, 18
  time_mag = dt.datetime(2014, 2, 18, 10)  # Around hour 10
  
  # Calling it will download
  filenames = download_magnetogram_hmi(mag_time=time_mag,
  hmi_map='B_720s',
  download_dir='mydir/')
  
  # To see my list
  print('The magnetograms I downloaded are:', filenames)
  
  # You may call and ignore the file list
  download_magnetogram_hmi(mag_time=time_mag,
  hmi_map='b_synoptic_small',
  download_dir='mydir')
  ```

<a name=".swmfpy.web.download_magnetogram_adapt"></a>
#### download\_magnetogram\_adapt

```python
download_magnetogram_adapt(time, map_type='fixed', **kwargs)
```

This routine downloads GONG ADAPT magnetograms.

Downloads ADAPT magnetograms from ftp://gong2.nso.edu/adapt/maps/gong/
to a local directory. It will download all maps with the regex file
pattern: adapt4[0,1]3*yyyymmddhh

**Arguments**:

- `time` _datetime.datetime_ - Time in which you want the magnetogram.
- `map_type` _str_ - (default: 'fixed')
  Choose either 'fixed' or 'central' for
  the map type you want.
  
  **kwargs:
- `download_dir` _str_ - (default is current dir) Relative directory
  where you want the maps to be downloaded.
  

**Returns**:

- `str` - First unzipped filename found.
  

**Raises**:

- `NotADirectoryError` - If the adapt maps directory
  is not found on the server.
- `ValueError` - If map_type is not recognized.
  (i.e. not 'fixed' or 'central')
- `FileNotFoundError` - If maps were not found.
  

**Examples**:

  ```python
  import datetime as dt
  
  # Use datetime objects for the time
  time_flare = dt.datetime(2018, 2, 12, hour=10)
  swmfpy.web.download_magnetogram_adapt(time=time_flare,
  map_type='central',
  download_dir='./mymaps/')
  ```

Qusai Al Shidi's avatar
Qusai Al Shidi committed
203
204
<a name=".swmfpy.io"></a>
## swmfpy.io
205

Qusai Al Shidi's avatar
Autodoc    
Qusai Al Shidi committed
206
Input/Output tools
207

Qusai Al Shidi's avatar
Autodoc    
Qusai Al Shidi committed
208
Here are tools to read and write files relating to SWMF.
209

Qusai Al Shidi's avatar
Autodoc    
Qusai Al Shidi committed
210
TODO: Move pandas dependancy elsewhere.
211

Qusai Al Shidi's avatar
Qusai Al Shidi committed
212
213
<a name=".swmfpy.io.read_wdc_ae"></a>
#### read\_wdc\_ae
214

Qusai Al Shidi's avatar
Autodoc    
Qusai Al Shidi committed
215
216
217
```python
read_wdc_ae(wdc_filename)
```
Qusai Al Shidi's avatar
Qusai Al Shidi committed
218

Qusai Al Shidi's avatar
Autodoc    
Qusai Al Shidi committed
219
220
221
Read an auroral electrojet (AE) indeces from Kyoto's World Data Center
text file into a dictionary of lists.

Qusai Al Shidi's avatar
Qusai Al Shidi committed
222
223
224
225
226
**Arguments**:

  
- `wdc_filename` _str_ - Filename of wdc data from
  http://wdc.kugi.kyoto-u.ac.jp/
Qusai Al Shidi's avatar
Autodoc    
Qusai Al Shidi committed
227

Qusai Al Shidi's avatar
Qusai Al Shidi committed
228
229
**Returns**:

Qusai Al Shidi's avatar
Qusai Al Shidi committed
230
231
232
- `dict` - Auroral indeces 'AL', 'AE', 'AO', 'AU'
- `datetime.datetime` - 'times'
- `int` - 'values'
Qusai Al Shidi's avatar
Qusai Al Shidi committed
233
234
235

<a name=".swmfpy.io.read_wdc_asy_sym"></a>
#### read\_wdc\_asy\_sym
Qusai Al Shidi's avatar
Autodoc    
Qusai Al Shidi committed
236
237
238
239

```python
read_wdc_asy_sym(wdc_filename)
```
Qusai Al Shidi's avatar
Qusai Al Shidi committed
240

Qusai Al Shidi's avatar
Autodoc    
Qusai Al Shidi committed
241
Reads a WDC file for ASY/SYM data.
242

Qusai Al Shidi's avatar
Autodoc    
Qusai Al Shidi committed
243
244
245
Reads an ASY/SYM file downloaded from
http://wdc.kugi.kyoto-u.ac.jp/aeasy/index.html
and puts it into a dictionary.
246

Qusai Al Shidi's avatar
Qusai Al Shidi committed
247
**Arguments**:
248

Qusai Al Shidi's avatar
Qusai Al Shidi committed
249
250
- `wdc_filename` _str_ - Relative filename (or file handle no.) to read.
  
251

Qusai Al Shidi's avatar
Qusai Al Shidi committed
252
**Returns**:
Qusai Al Shidi's avatar
Qusai Al Shidi committed
253

Qusai Al Shidi's avatar
Qusai Al Shidi committed
254
- `dict` - of values. {'[ASY-SYM]-[D-H]': 'times': [], 'values': []}
Qusai Al Shidi's avatar
Qusai Al Shidi committed
255
  
Qusai Al Shidi's avatar
Qusai Al Shidi committed
256

Qusai Al Shidi's avatar
Qusai Al Shidi committed
257
**Examples**:
258

Qusai Al Shidi's avatar
Qusai Al Shidi committed
259
260
261
262
263
264
265
266
267
268
269
  ```python
  indeces = swmfpy.io.read_wdc_asy_sym('wdc.dat')
  # Plot data
  plt.plot(indeces['SYM-H']['times'],
  indeces['SYM-H']['values'],
  label='SYM-H [nT]'
  )
  plt.xlabel('Time [UT]')
  ```
  
  Important to note if there is bad data it will be filled as None.
270

Qusai Al Shidi's avatar
Qusai Al Shidi committed
271
272
<a name=".swmfpy.io.read_gm_log"></a>
#### read\_gm\_log
273

Qusai Al Shidi's avatar
Autodoc    
Qusai Al Shidi committed
274
275
276
```python
read_gm_log(filename, colnames=None, dtypes=None, index_time=True)
```
Qusai Al Shidi's avatar
Qusai Al Shidi committed
277

Qusai Al Shidi's avatar
Autodoc    
Qusai Al Shidi committed
278
279
Make a dictionary out of the indeces outputted
from the GM model log.
280

Qusai Al Shidi's avatar
Qusai Al Shidi committed
281
**Arguments**:
282

Qusai Al Shidi's avatar
Qusai Al Shidi committed
283
284
285
286
287
288
289
290
291
- `filename` _str_ - The relative filename as a string. (or file handle no.)
- `colnames` _[str]_ - (default: None) Supply the name of the columns.
  If None it will use second line
  of log file.
- `dtypes` _[types]_ - (default: None) Provide types for the columns, if
  None then all will be float.
- `index_time` _bool_ - (default: True) Make a column of dt.datetime objects
  in dictionary key 'Time [UT]'.
  
292

Qusai Al Shidi's avatar
Qusai Al Shidi committed
293
**Returns**:
Qusai Al Shidi's avatar
Qusai Al Shidi committed
294

Qusai Al Shidi's avatar
Qusai Al Shidi committed
295
- `dict` - Dictionary of the log file
Qusai Al Shidi's avatar
Qusai Al Shidi committed
296
  
297

Qusai Al Shidi's avatar
Qusai Al Shidi committed
298
**Examples**:
Qusai Al Shidi's avatar
Qusai Al Shidi committed
299

Qusai Al Shidi's avatar
Qusai Al Shidi committed
300
301
302
303
304
305
306
307
  To plot AL and Dst get the log files
  ```python
  geo = swmfpy.io.read_gm_log('run/GM/IO2/geoindex_e20140215-100500.log')
  dst = swmfpy.io.read_gm_log('run/GM/IO2/log_e20140215-100500.log')
  
  # Plot AL indeces
  plt.plot(geo['times', geo['AL'])
  ```
308

309
310
311
312
313
314
<a name=".swmfpy.tools"></a>
## swmfpy.tools

Tools to be used in swmfpy functions and classes. Some of the functions are
*hidden functions*.

Qusai Al Shidi's avatar
Qusai Al Shidi committed
315
316
<a name=".swmfpy.paramin"></a>
## swmfpy.paramin
317

Qusai Al Shidi's avatar
Autodoc    
Qusai Al Shidi committed
318
These tools are to help script the editing of PARAM.in files.
319

Qusai Al Shidi's avatar
Qusai Al Shidi committed
320
321
<a name=".swmfpy.paramin.replace_command"></a>
#### replace\_command
322

Qusai Al Shidi's avatar
Autodoc    
Qusai Al Shidi committed
323
324
325
```python
replace_command(parameters, input_file, output_file='PARAM.in')
```
Qusai Al Shidi's avatar
Qusai Al Shidi committed
326

327
328
329
330
Replace values for the parameters in a PARAM.in file.

Note, if you have repeat commands this will replace all the repeats.

Qusai Al Shidi's avatar
Qusai Al Shidi committed
331
**Arguments**:
332

Qusai Al Shidi's avatar
Qusai Al Shidi committed
333
- `parameters` _dict_ - Dictionary of strs with format
334
  replace = 'COMMAND': ['value', 'comments', ...]
Qusai Al Shidi's avatar
Qusai Al Shidi committed
335
336
337
338
  This is case sensitive.
- `input_file` _str_ - String of PARAM.in file name.
- `output_file` _str_ - (default 'PARAM.in') The output file to write to.
  A value of None will not output a file.
339

Qusai Al Shidi's avatar
Qusai Al Shidi committed
340
**Returns**:
Qusai Al Shidi's avatar
Qusai Al Shidi committed
341

Qusai Al Shidi's avatar
Qusai Al Shidi committed
342
343
  A list of lines of the PARAM.in file that would be outputted.
  
344

Qusai Al Shidi's avatar
Qusai Al Shidi committed
345
**Raises**:
Qusai Al Shidi's avatar
Qusai Al Shidi committed
346

Qusai Al Shidi's avatar
Qusai Al Shidi committed
347
348
- `TypeError` - If a value given couldn't be converted to string.
  
349

Qusai Al Shidi's avatar
Qusai Al Shidi committed
350
**Examples**:
Qusai Al Shidi's avatar
Qusai Al Shidi committed
351

Qusai Al Shidi's avatar
Qusai Al Shidi committed
352
  ```python
353
  change['\#SOLARWINDFILE'] = [['T', 'UseSolarWindFile'],
Qusai Al Shidi's avatar
Qusai Al Shidi committed
354
355
356
357
  ['new_imf.dat', 'NameSolarWindFile']]
  # This will overwrite PARAM.in
  swmfpy.paramin.replace('PARAM.in.template', change)
  ```
Qusai Al Shidi's avatar
Qusai Al Shidi committed
358

Qusai Al Shidi's avatar
Qusai Al Shidi committed
359
360
<a name=".swmfpy.paramin.read_command"></a>
#### read\_command
Qusai Al Shidi's avatar
Qusai Al Shidi committed
361
362

```python
Qusai Al Shidi's avatar
Qusai Al Shidi committed
363
read_command(command, paramin_file='PARAM.in', **kwargs)
Qusai Al Shidi's avatar
Qusai Al Shidi committed
364
365
```

Qusai Al Shidi's avatar
Qusai Al Shidi committed
366
Get parameters of a certain command in PARAM.in file.
Qusai Al Shidi's avatar
Qusai Al Shidi committed
367

368
369
This will find the COMMAND and return a list of
values for the parameters.
Qusai Al Shidi's avatar
Qusai Al Shidi committed
370

Qusai Al Shidi's avatar
Qusai Al Shidi committed
371
**Arguments**:
Qusai Al Shidi's avatar
Qusai Al Shidi committed
372

373
- `command` _str_ - This is the COMMAND you're looking for.
Qusai Al Shidi's avatar
Qusai Al Shidi committed
374
375
376
377
378
379
- `paramin_file` _str_ - (default: 'PARAM.in') The file in which you're
  looking for the command values.
  **kwargs:
- `num_of_values` _int_ - (default: None) Number of values to take from
  command.
  
Qusai Al Shidi's avatar
Qusai Al Shidi committed
380

Qusai Al Shidi's avatar
Qusai Al Shidi committed
381
**Returns**:
Qusai Al Shidi's avatar
Qusai Al Shidi committed
382

383
384
- `list` - Values found for the COMMAND in file. Index 0 is
  COMMAND and the values follow (1 for first argument...)
Qusai Al Shidi's avatar
Qusai Al Shidi committed
385
  
Qusai Al Shidi's avatar
Qusai Al Shidi committed
386

Qusai Al Shidi's avatar
Qusai Al Shidi committed
387
**Raises**:
Qusai Al Shidi's avatar
Qusai Al Shidi committed
388

389
- `ValueError` - When the COMMAND is not found.
Qusai Al Shidi's avatar
Qusai Al Shidi committed
390
  
Qusai Al Shidi's avatar
Qusai Al Shidi committed
391

Qusai Al Shidi's avatar
Qusai Al Shidi committed
392
**Examples**:
Qusai Al Shidi's avatar
Qusai Al Shidi committed
393

Qusai Al Shidi's avatar
Qusai Al Shidi committed
394
  ```python
395
396
  start_time = swmfpy.paramin.read_command('\#STARTTIME')
  end_time = swmfpy.paramin.read_command('\#ENDTIME')
Qusai Al Shidi's avatar
Qusai Al Shidi committed
397
398
399
400
401
402
403
  print('Starting month is ', start_time[1])
  print('Ending month is ', end_time[1])
  ```
  
  This will treat all following lines as values for the command. To suppress
  this, try using the `num_of_values` keyword. This is helpful if your
  PARAM.in is comment heavy.
Qusai Al Shidi's avatar
Qusai Al Shidi committed
404