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 15.8 KB
Newer Older
Qusai Al Shidi's avatar
Qusai Al Shidi committed
1
2
3
# Table of Contents

* [swmfpy](#.swmfpy)
4
  * [write\_imf\_from\_omni](#.swmfpy.write_imf_from_omni)
5
6
7
8
* [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)
9
10
11
12
13
* [swmfpy.io](#.swmfpy.io)
  * [write\_imf\_input](#.swmfpy.io.write_imf_input)
  * [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)
Qusai Al Shidi's avatar
Qusai Al Shidi committed
14
15
16
* [swmfpy.paramin](#.swmfpy.paramin)
  * [replace\_command](#.swmfpy.paramin.replace_command)
  * [read\_command](#.swmfpy.paramin.read_command)
17
* [swmfpy.tools](#.swmfpy.tools)
Qusai Al Shidi's avatar
Qusai Al Shidi committed
18
  * [interp\_nans](#.swmfpy.tools.interp_nans)
19
  * [carrington\_rotation\_number](#.swmfpy.tools.carrington_rotation_number)
Qusai Al Shidi's avatar
Qusai Al Shidi committed
20
21
* [swmfpy.tecplottools](#.swmfpy.tecplottools)
  * [apply\_equations](#.swmfpy.tecplottools.apply_equations)
Qusai Al Shidi's avatar
Qusai Al Shidi committed
22

Qusai Al Shidi's avatar
Qusai Al Shidi committed
23
24
<a name=".swmfpy"></a>
## swmfpy
25

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

29
### Modules
30

Qusai Al Shidi's avatar
Autodoc    
Qusai Al Shidi committed
31
These are automatically imported.
32

33
34
35
- `swmfpy.io` Input/Output tools.
- `swmfpy.paramin` PARAM.in editing tools.
- `swmfpy.web` Internet data downloading/uploading tools.
36

37
### Extra Modules
38

Qusai Al Shidi's avatar
Qusai Al Shidi committed
39
40
- `swmfpy.tools` Tools used in swmfpy. You might find these useful but it is
  unecessary.
Qusai Al Shidi's avatar
Qusai Al Shidi committed
41
42
- `swmfpy.tecplottools` Tools for working with the Tecplot visualization
  software. Requires a Tecplot license and the pytecplot python package.
43

44
45
<a name=".swmfpy.write_imf_from_omni"></a>
#### write\_imf\_from\_omni
46
47

```python
48
write_imf_from_omni(time_from, time_to, filename='IMF.dat', **kwargs)
49
50
```

51
52
Writes an IMF.dat file for the geospace model runs for a specific time
period.
53
54
55

**Arguments**:

56
57
58
- `time_from` _datetime.datetime_ - Time to begin omni data retrieval
- `time_to` _datetime.datetime_ - Time to end omni data retrieval
- `filename` _str_ - The filename for the dat file, defaults to 'IMF.dat'.
59
  
60
61
  **kwargs:
  see `swmfpy.io.write_imf_input()` and `swmfpy.web.get_omni_data()`
62
63
  

64
65
66
67
68
**Returns**:

- `(dict)` - Dictionary of omni data.
  

69
70
**Examples**:

71
  Using this function is simple:
72
  ```python
73
74
75
76
77
78
79
  import swmfpy
  import datetime as dt
  times = (dt.datetime(2014, 2, 2), dt.datetime(2014, 2, 4))
  # Usually the kwargs are unecessary
  swmfpy.write_imf_input(*times)
  # Sometimes this
  swmfpy.write_imf_input(*times, filename='run/IMF.dat')
80
81
  ```

82
83
84
<a name=".swmfpy.web"></a>
## swmfpy.web

85
### Tools to download/upload data on the web
86
87

Here are a collection of tools to work with data on the internet. Thus,
88
89
90
this module mostly requires an internet connection. Which on some
supercomputers would be turned off during a job run. In scripts, make sure to
use these to preprocess before submitting jobs.
91
92
93
94
95

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

```python
Qusai Al Shidi's avatar
Qusai Al Shidi committed
96
@lru_cache(maxsize=4)
97
98
99
100
101
102
103
104
105
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().

Qusai Al Shidi's avatar
Qusai Al Shidi committed
106
107
108
109
110
111
Note that calling this more than once with the same arguments will point to
your original dictionary that it created. This is to speed up code that
calls this multiple times as it requires internet access and download.
If you mutate your original try doing an omni_dict2 = omni_dict1.copy()
and mutate the other one.

112
113
114
115
116
117
**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.
118
119
120
121
122
123
124
125
  **kwargs:
- `original_colnames` _bool_ - Use the original column names from the
  spdf specification. The alternative is
  nicer and shorter names. Defaults to
  False.
- `resolution` _str_ - (default: 'high') Here you can choose 'high' or
  'low' resolution omni data. Some columns appear
  in one but not the other.
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
  

**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)
144
145
146
147
  # or for low res
  data = swmfpy.web.get_omni_data(time_from=storm_start,
  time_to=storm_end,
  resolution='low')
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
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
  ```

<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.

**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/')
  ```

260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
<a name=".swmfpy.io"></a>
## swmfpy.io

### Input/Output tools

Here are tools to read and write files relating to SWMF.

<a name=".swmfpy.io.write_imf_input"></a>
#### write\_imf\_input

```python
write_imf_input(imf_data, filename='IMF.dat', **kwargs)
```

Creates the IMF.dat input file for the SWMF BATS-R-US geospace model.

`imf_data` must be a dictionary of array_like objects with same length
in data. In swmfpy Pythonic versions are always preferred so the 'times'
must be `datetime.datetime` array.
imf_data = dict(times, bx, by, bz, vx, vy, vz, density, temperature)

**Arguments**:

- `imf_data` _dict_ - This dictionary contains the solar wind data.
- `filename` _str_ - (default: 'IMF.dat') Filename to write to.
  **kwargs:
- `commands` _[str]_ - (default: None) List of commands to write to imf
  input file (indexed by line then by tabs on same
  line). *Note*: Must be a list if have one command
  str.
  

**Raises**:

- `TypeError` - If commands is not a list or tuple. It must be at least a
  one element list of strings.
- `AssertionError` - If inputs aren't prepared properly (key names)
  

**Examples**:

  ```python
  from swmfpy.io import write_imf_input
  
  # Prepare imf dictionary: imf_data
  write_imf_input(imf_data, filename='run/IMF.dat')
  ```

<a name=".swmfpy.io.read_wdc_ae"></a>
#### read\_wdc\_ae

```python
read_wdc_ae(wdc_filename)
```

Read an auroral electrojet (AE) indeces from Kyoto's World Data Center
text file into a dictionary of lists.

**Arguments**:

  
- `wdc_filename` _str_ - Filename of wdc data from
  http://wdc.kugi.kyoto-u.ac.jp/

**Returns**:

- `dict` - Auroral indeces 'AL', 'AE', 'AO', 'AU'
- `datetime.datetime` - 'times'
- `int` - 'values'

<a name=".swmfpy.io.read_wdc_asy_sym"></a>
#### read\_wdc\_asy\_sym

```python
read_wdc_asy_sym(wdc_filename)
```

Reads a WDC file for ASY/SYM data.

Reads an ASY/SYM file downloaded from
http://wdc.kugi.kyoto-u.ac.jp/aeasy/index.html
and puts it into a dictionary.

**Arguments**:

- `wdc_filename` _str_ - Relative filename (or file handle no.) to read.
  

**Returns**:

- `dict` - of values. {'[ASY-SYM]-[D-H]': 'times': [], 'values': []}
  

**Examples**:

  ```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.

<a name=".swmfpy.io.read_gm_log"></a>
#### read\_gm\_log

```python
read_gm_log(filename, colnames=None, dtypes=None, index_time=True)
```

Make a dictionary out of the indeces outputted
from the GM model log.

**Arguments**:

- `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]'.
  

**Returns**:

- `dict` - Dictionary of the log file
  

**Examples**:

  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'])
  ```

Qusai Al Shidi's avatar
Qusai Al Shidi committed
405
406
<a name=".swmfpy.paramin"></a>
## swmfpy.paramin
407

408
409
410
### Editing PARAM.in files

These tools are to help script the editing and reading of PARAM.in files.
411

Qusai Al Shidi's avatar
Qusai Al Shidi committed
412
413
<a name=".swmfpy.paramin.replace_command"></a>
#### replace\_command
414

Qusai Al Shidi's avatar
Autodoc    
Qusai Al Shidi committed
415
416
417
```python
replace_command(parameters, input_file, output_file='PARAM.in')
```
Qusai Al Shidi's avatar
Qusai Al Shidi committed
418

419
420
421
422
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
423
**Arguments**:
424

Qusai Al Shidi's avatar
Qusai Al Shidi committed
425
- `parameters` _dict_ - Dictionary of strs with format
426
  replace = '#COMMAND': ['value', 'comments', ...]
Qusai Al Shidi's avatar
Qusai Al Shidi committed
427
428
429
430
  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.
431

Qusai Al Shidi's avatar
Qusai Al Shidi committed
432
**Returns**:
Qusai Al Shidi's avatar
Qusai Al Shidi committed
433

Qusai Al Shidi's avatar
Qusai Al Shidi committed
434
435
  A list of lines of the PARAM.in file that would be outputted.
  
436

Qusai Al Shidi's avatar
Qusai Al Shidi committed
437
**Raises**:
Qusai Al Shidi's avatar
Qusai Al Shidi committed
438

Qusai Al Shidi's avatar
Qusai Al Shidi committed
439
440
- `TypeError` - If a value given couldn't be converted to string.
  
441

Qusai Al Shidi's avatar
Qusai Al Shidi committed
442
**Examples**:
Qusai Al Shidi's avatar
Qusai Al Shidi committed
443

Qusai Al Shidi's avatar
Qusai Al Shidi committed
444
  ```python
445
  change = {}
446
  change['#SOLARWINDFILE'] = [['T', 'UseSolarWindFile'],
Qusai Al Shidi's avatar
Qusai Al Shidi committed
447
448
449
450
  ['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
451

Qusai Al Shidi's avatar
Qusai Al Shidi committed
452
453
<a name=".swmfpy.paramin.read_command"></a>
#### read\_command
Qusai Al Shidi's avatar
Qusai Al Shidi committed
454
455

```python
Qusai Al Shidi's avatar
Qusai Al Shidi committed
456
read_command(command, paramin_file='PARAM.in', **kwargs)
Qusai Al Shidi's avatar
Qusai Al Shidi committed
457
458
```

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

461
This will find the #COMMAND and return a list of
462
values for the parameters.
Qusai Al Shidi's avatar
Qusai Al Shidi committed
463

Qusai Al Shidi's avatar
Qusai Al Shidi committed
464
**Arguments**:
Qusai Al Shidi's avatar
Qusai Al Shidi committed
465

466
- `command` _str_ - This is the #COMMAND you're looking for.
Qusai Al Shidi's avatar
Qusai Al Shidi committed
467
468
469
470
471
472
- `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
473

Qusai Al Shidi's avatar
Qusai Al Shidi committed
474
**Returns**:
Qusai Al Shidi's avatar
Qusai Al Shidi committed
475

476
477
- `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
478
  
Qusai Al Shidi's avatar
Qusai Al Shidi committed
479

Qusai Al Shidi's avatar
Qusai Al Shidi committed
480
**Raises**:
Qusai Al Shidi's avatar
Qusai Al Shidi committed
481

482
- `ValueError` - When the #COMMAND is not found.
Qusai Al Shidi's avatar
Qusai Al Shidi committed
483
  
Qusai Al Shidi's avatar
Qusai Al Shidi committed
484

Qusai Al Shidi's avatar
Qusai Al Shidi committed
485
**Examples**:
Qusai Al Shidi's avatar
Qusai Al Shidi committed
486

Qusai Al Shidi's avatar
Qusai Al Shidi committed
487
  ```python
488
489
  start_time = swmfpy.paramin.read_command('#STARTTIME')
  end_time = swmfpy.paramin.read_command('#ENDTIME')
Qusai Al Shidi's avatar
Qusai Al Shidi committed
490
491
492
493
494
495
496
  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
497

498
499
500
501
502
503
<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
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
<a name=".swmfpy.tools.interp_nans"></a>
#### interp\_nans

```python
interp_nans(x_vals, y_vals)
```

Returns a numpy array with NaNs interpolated.

**Arguments**:

  x_vals (np.array):
  x values to interpolate.
  y_vals (np.array):
  y values including NaNs.
  

**Returns**:

- `(np.array)` - numpy array with NaNs interpolated.

525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
<a name=".swmfpy.tools.carrington_rotation_number"></a>
#### carrington\_rotation\_number

```python
carrington_rotation_number(the_time='now')
```

Returns the carrington rotation

**Arguments**:

- `the_time` _datetime.datetime/str_ - The time to convert to carrington
  rotation.
  

**Returns**:

- `(int)` - Carrington Rotation

Qusai Al Shidi's avatar
Qusai Al Shidi committed
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
<a name=".swmfpy.tecplottools"></a>
## swmfpy.tecplottools

Tools for working with the Tecplot visualization software.

Requires an active Tecplot license and the pytecplot python package.
pytecplot ships with Tecplot 360 2017 R1 and later versions
but it is recommended that you install the latest version with
`pip install pytecplot`.
See the pytecplot documentation for more details about
[installation](https://www.tecplot.com/docs/pytecplot/install.html).
See also [TECPLOT](TECPLOT.markdown) for tips targeted to SWMF users.

Some useful references:
- [Tecplot User's Manual](download.tecplot.com/360/current/360_users_manual.pdf)
- [Tecplot Scripting Guide](download.tecplot.com/360/current/360_scripting_guide.pdf)
- [Pytecplot documentation](www.tecplot.com/docs/pytecplot/index.html)

<a name=".swmfpy.tecplottools.apply_equations"></a>
#### apply\_equations

```python
apply_equations(eqn_path: str, verbose: bool = False)
```

Apply an equations file in the Tecplot macro format to the active dataset

Please reference the Tecplot User's Manual for more details on
equation files and syntax. It is recommended to use this function with eqn
files generated with the Tecplot GUI.
See [TECPLOT](TECPLOT.markdown) for tips on using pytecplot.

**Arguments**:

- `eqn_file_path` _str_ - The path to the equation macro file (typically with
  extension `.eqn`).
- `verbose` _bool_ - (Optional) Whether or not to print the equations as they are
  applied. Default behavior is silent.
  

**Examples**:

  ```python
  import tecplot
  import swmfpy.tecplottools as tpt
  
  ## Uncomment this line if you are connecting to a running tecplot
  ## session. Be sure that the port number matches the port the GUI is
  ## listening to. See TECPLOT.markdown for tips on connecting to a
  ## running session or running your script seperately.
  # tecplot.session.connect(port=7600)
  
  ## load a dataset
  dataset = tecplot.data.load_tecplot('./z=0_mhd_1_n00000000.plt')
  
  ## apply an equations file
  tpt.apply_equations('./gse_to_ephio.eqn', verbose= True)
  
  ## apply a frame style
  frame = tecplot.active_frame()
  frame.load_stylesheet('./density.sty')
  
  ## annotate with the zone name
  frame.add_text('&(ZONENAME[ACTIVEOFFSET=1])', position= (5, 95))
  
  ## save the image
  tecplot.export.save_png('./density.png', width= 1200, supersample= 8)
  ```