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

* [swmfpy](#.swmfpy)
* [swmfpy.web](#.swmfpy.web)
  * [get\_omni\_data](#.swmfpy.web.get_omni_data)
6
  * [download\_magnetogram\_hmi](#.swmfpy.web.download_magnetogram_hmi)
Qusai Al Shidi's avatar
Qusai Al Shidi committed
7
8
9
10
11
12
13
14
15
  * [download\_magnetogram\_adapt](#.swmfpy.web.download_magnetogram_adapt)
* [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)
* [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
16
17
<a name=".swmfpy"></a>
## swmfpy
18

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

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

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

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

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

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

Qusai Al Shidi's avatar
Autodoc    
Qusai Al Shidi committed
36
*None yet.*
37

Qusai Al Shidi's avatar
Qusai Al Shidi committed
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
<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)
  ```

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
<a name=".swmfpy.web.download_magnetogram_hmi"></a>
#### download\_magnetogram\_hmi

```python
download_magnetogram_hmi(mag_time, **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/drms, if you don't have it try,


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

**Arguments**:

- `mag_time` _datetime.datetime_ - Time after which to find
  vector magnetograms.
  
  **kwargs:
- `download_dir` _str_ - Relative directory to download to.
- `verbose` _bool_ - (default False) print out the files it's downloading.
  

**Returns**:

Qusai Al Shidi's avatar
Qusai Al Shidi committed
116
- `str` - list of filenames downloaded.
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
  

**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,
  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, download_dir='mydir')
  ```

Qusai Al Shidi's avatar
Qusai Al Shidi committed
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
<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.
165
  
Qusai Al Shidi's avatar
Qusai Al Shidi committed
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
  **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/')
  ```

<a name=".swmfpy.io"></a>
## swmfpy.io
199

Qusai Al Shidi's avatar
Autodoc    
Qusai Al Shidi committed
200
Input/Output tools
201

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

Qusai Al Shidi's avatar
Autodoc    
Qusai Al Shidi committed
204
TODO: Move pandas dependancy elsewhere.
205

Qusai Al Shidi's avatar
Qusai Al Shidi committed
206
207
<a name=".swmfpy.io.read_wdc_ae"></a>
#### read\_wdc\_ae
208

Qusai Al Shidi's avatar
Autodoc    
Qusai Al Shidi committed
209
210
211
```python
read_wdc_ae(wdc_filename)
```
Qusai Al Shidi's avatar
Qusai Al Shidi committed
212

Qusai Al Shidi's avatar
Autodoc    
Qusai Al Shidi committed
213
214
215
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
216
217
218
219
220
**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
221

Qusai Al Shidi's avatar
Qusai Al Shidi committed
222
223
**Returns**:

Qusai Al Shidi's avatar
Qusai Al Shidi committed
224
225
226
- `dict` - Auroral indeces 'AL', 'AE', 'AO', 'AU'
- `datetime.datetime` - 'times'
- `int` - 'values'
Qusai Al Shidi's avatar
Qusai Al Shidi committed
227
228
229

<a name=".swmfpy.io.read_wdc_asy_sym"></a>
#### read\_wdc\_asy\_sym
Qusai Al Shidi's avatar
Autodoc    
Qusai Al Shidi committed
230
231
232
233

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

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

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

Qusai Al Shidi's avatar
Qusai Al Shidi committed
241
**Arguments**:
242

Qusai Al Shidi's avatar
Qusai Al Shidi committed
243
244
- `wdc_filename` _str_ - Relative filename (or file handle no.) to read.
  
245

Qusai Al Shidi's avatar
Qusai Al Shidi committed
246
**Returns**:
Qusai Al Shidi's avatar
Qusai Al Shidi committed
247

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

Qusai Al Shidi's avatar
Qusai Al Shidi committed
251
**Examples**:
252

Qusai Al Shidi's avatar
Qusai Al Shidi committed
253
254
255
256
257
258
259
260
261
262
263
  ```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.
264

Qusai Al Shidi's avatar
Qusai Al Shidi committed
265
266
<a name=".swmfpy.io.read_gm_log"></a>
#### read\_gm\_log
267

Qusai Al Shidi's avatar
Autodoc    
Qusai Al Shidi committed
268
269
270
```python
read_gm_log(filename, colnames=None, dtypes=None, index_time=True)
```
Qusai Al Shidi's avatar
Qusai Al Shidi committed
271

Qusai Al Shidi's avatar
Autodoc    
Qusai Al Shidi committed
272
273
Make a dictionary out of the indeces outputted
from the GM model log.
274

Qusai Al Shidi's avatar
Qusai Al Shidi committed
275
**Arguments**:
276

Qusai Al Shidi's avatar
Qusai Al Shidi committed
277
278
279
280
281
282
283
284
285
- `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]'.
  
286

Qusai Al Shidi's avatar
Qusai Al Shidi committed
287
**Returns**:
Qusai Al Shidi's avatar
Qusai Al Shidi committed
288

Qusai Al Shidi's avatar
Qusai Al Shidi committed
289
- `dict` - Dictionary of the log file
Qusai Al Shidi's avatar
Qusai Al Shidi committed
290
  
291

Qusai Al Shidi's avatar
Qusai Al Shidi committed
292
**Examples**:
Qusai Al Shidi's avatar
Qusai Al Shidi committed
293

Qusai Al Shidi's avatar
Qusai Al Shidi committed
294
295
296
297
298
299
300
301
  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'])
  ```
302

Qusai Al Shidi's avatar
Qusai Al Shidi committed
303
304
<a name=".swmfpy.paramin"></a>
## swmfpy.paramin
305

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

Qusai Al Shidi's avatar
Qusai Al Shidi committed
308
309
<a name=".swmfpy.paramin.replace_command"></a>
#### replace\_command
310

Qusai Al Shidi's avatar
Autodoc    
Qusai Al Shidi committed
311
312
313
```python
replace_command(parameters, input_file, output_file='PARAM.in')
```
Qusai Al Shidi's avatar
Qusai Al Shidi committed
314

315
316
317
318
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
319
**Arguments**:
320

Qusai Al Shidi's avatar
Qusai Al Shidi committed
321
- `parameters` _dict_ - Dictionary of strs with format
322
  replace = {'COMMAND': ['value', 'comments', ...]}
Qusai Al Shidi's avatar
Qusai Al Shidi committed
323
324
325
326
  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.
327

Qusai Al Shidi's avatar
Qusai Al Shidi committed
328
**Returns**:
Qusai Al Shidi's avatar
Qusai Al Shidi committed
329

Qusai Al Shidi's avatar
Qusai Al Shidi committed
330
331
  A list of lines of the PARAM.in file that would be outputted.
  
332

Qusai Al Shidi's avatar
Qusai Al Shidi committed
333
**Raises**:
Qusai Al Shidi's avatar
Qusai Al Shidi committed
334

Qusai Al Shidi's avatar
Qusai Al Shidi committed
335
336
- `TypeError` - If a value given couldn't be converted to string.
  
337

Qusai Al Shidi's avatar
Qusai Al Shidi committed
338
**Examples**:
Qusai Al Shidi's avatar
Qusai Al Shidi committed
339

Qusai Al Shidi's avatar
Qusai Al Shidi committed
340
  ```python
341
  change['SOLARWINDFILE'] = [['T', 'UseSolarWindFile'],
Qusai Al Shidi's avatar
Qusai Al Shidi committed
342
343
344
345
  ['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
346

Qusai Al Shidi's avatar
Qusai Al Shidi committed
347
348
<a name=".swmfpy.paramin.read_command"></a>
#### read\_command
Qusai Al Shidi's avatar
Qusai Al Shidi committed
349
350

```python
Qusai Al Shidi's avatar
Qusai Al Shidi committed
351
read_command(command, paramin_file='PARAM.in', **kwargs)
Qusai Al Shidi's avatar
Qusai Al Shidi committed
352
353
```

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

356
357
This will find the COMMAND and return a list of
values for the parameters.
Qusai Al Shidi's avatar
Qusai Al Shidi committed
358

Qusai Al Shidi's avatar
Qusai Al Shidi committed
359
**Arguments**:
Qusai Al Shidi's avatar
Qusai Al Shidi committed
360

361
- `command` _str_ - This is the COMMAND you're looking for.
Qusai Al Shidi's avatar
Qusai Al Shidi committed
362
363
364
365
366
367
- `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
368

Qusai Al Shidi's avatar
Qusai Al Shidi committed
369
**Returns**:
Qusai Al Shidi's avatar
Qusai Al Shidi committed
370

371
372
- `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
373
  
Qusai Al Shidi's avatar
Qusai Al Shidi committed
374

Qusai Al Shidi's avatar
Qusai Al Shidi committed
375
**Raises**:
Qusai Al Shidi's avatar
Qusai Al Shidi committed
376

377
- `ValueError` - When the COMMAND is not found.
Qusai Al Shidi's avatar
Qusai Al Shidi committed
378
  
Qusai Al Shidi's avatar
Qusai Al Shidi committed
379

Qusai Al Shidi's avatar
Qusai Al Shidi committed
380
**Examples**:
Qusai Al Shidi's avatar
Qusai Al Shidi committed
381

Qusai Al Shidi's avatar
Qusai Al Shidi committed
382
383
384
385
386
387
388
389
390
391
  ```python
  start_time = swmfpy.paramin.read_command('`STARTTIME`')
  end_time = swmfpy.paramin.read_command('`ENDTIME`')
  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
392