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.45 KB
Newer Older
Qusai Al Shidi's avatar
Qusai Al Shidi committed
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
# Table of Contents

* [swmfpy](#.swmfpy)
* [swmfpy.web](#.swmfpy.web)
  * [get\_omni\_data](#.swmfpy.web.get_omni_data)
  * [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\_omni\_csv](#.swmfpy.io.read_omni_csv)
  * [write\_imf\_input](#.swmfpy.io.write_imf_input)
  * [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
17
18
<a name=".swmfpy"></a>
## swmfpy
19

Qusai Al Shidi's avatar
Autodoc    
Qusai Al Shidi committed
20
21
SWMF Tools
==========
22

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

Qusai Al Shidi's avatar
Autodoc    
Qusai Al Shidi committed
26
27
Modules
-------
28

Qusai Al Shidi's avatar
Autodoc    
Qusai Al Shidi committed
29
These are automatically imported.
30

Qusai Al Shidi's avatar
Autodoc    
Qusai Al Shidi committed
31
32
33
- swmfpy.io: Input/Output tools.
- swmfpy.paramin: PARAM.in editing tools.
- swmfpy.web: Internet data downloading/uploading tools.
34

Qusai Al Shidi's avatar
Autodoc    
Qusai Al Shidi committed
35
36
Extra Modules
-------------
37

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

Qusai Al Shidi's avatar
Autodoc    
Qusai Al Shidi committed
40
*None yet.*
41

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

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

Qusai Al Shidi's avatar
Autodoc    
Qusai Al Shidi committed
142
Input/Output tools
143

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

Qusai Al Shidi's avatar
Autodoc    
Qusai Al Shidi committed
146
TODO: Move pandas dependancy elsewhere.
147

Qusai Al Shidi's avatar
Qusai Al Shidi committed
148
149
<a name=".swmfpy.io.read_wdc_ae"></a>
#### read\_wdc\_ae
150

Qusai Al Shidi's avatar
Autodoc    
Qusai Al Shidi committed
151
152
153
```python
read_wdc_ae(wdc_filename)
```
Qusai Al Shidi's avatar
Qusai Al Shidi committed
154

Qusai Al Shidi's avatar
Autodoc    
Qusai Al Shidi committed
155
156
157
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
158
159
160
161
162
**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
163

Qusai Al Shidi's avatar
Qusai Al Shidi committed
164
165
166
167
168
**Returns**:

  
- `dict` - {
  Auroral indeces 'AL', 'AE', 'AO', 'AU' (int): {
Qusai Al Shidi's avatar
Qusai Al Shidi committed
169
  'times' (datetime.datetime)
Qusai Al Shidi's avatar
Qusai Al Shidi committed
170
171
172
173
174
- `'values'` _int_ - List of indeces.
  }

<a name=".swmfpy.io.read_wdc_asy_sym"></a>
#### read\_wdc\_asy\_sym
Qusai Al Shidi's avatar
Autodoc    
Qusai Al Shidi committed
175
176
177
178

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

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

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

Qusai Al Shidi's avatar
Qusai Al Shidi committed
186
**Arguments**:
187

Qusai Al Shidi's avatar
Qusai Al Shidi committed
188
189
- `wdc_filename` _str_ - Relative filename (or file handle no.) to read.
  
190

Qusai Al Shidi's avatar
Qusai Al Shidi committed
191
**Returns**:
Qusai Al Shidi's avatar
Qusai Al Shidi committed
192

Qusai Al Shidi's avatar
Qusai Al Shidi committed
193
194
195
- `dict` - of values.
- `{'[ASY-SYM]-[D-H]'` - 'times': [], 'values': []}
  
Qusai Al Shidi's avatar
Qusai Al Shidi committed
196

Qusai Al Shidi's avatar
Qusai Al Shidi committed
197
**Examples**:
198

Qusai Al Shidi's avatar
Qusai Al Shidi committed
199
200
201
202
203
204
205
206
207
208
209
  ```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.
210

Qusai Al Shidi's avatar
Qusai Al Shidi committed
211
212
<a name=".swmfpy.io.read_omni_csv"></a>
#### read\_omni\_csv
213

Qusai Al Shidi's avatar
Autodoc    
Qusai Al Shidi committed
214
215
216
```python
read_omni_csv(filename, filtering=False, **kwargs)
```
Qusai Al Shidi's avatar
Qusai Al Shidi committed
217

218
219
220
Take an OMNI csv file from cdaweb.sci.gsfc.nasa.gov
and turn it into a pandas.DataFrame.

Qusai Al Shidi's avatar
Qusai Al Shidi committed
221
**Arguments**:
222

Qusai Al Shidi's avatar
Qusai Al Shidi committed
223
224
225
226
227
- `fnames` _dict_ - dict with filenames from omni .lst files.
  The keys must be: density, temperature,
  magnetic_field, velocity
- `filtering` _bool_ - default=False Remove points where the value
  is >sigma (default: sigma=3) from mean.
Qusai Al Shidi's avatar
Qusai Al Shidi committed
228
  
Qusai Al Shidi's avatar
Qusai Al Shidi committed
229
230
231
232
233
  **kwargs:
- `coarseness` _int_ - default=3, Number of standard deviations
  above which to remove if filtering=True.
- `clean` _bool_ - default=True, Clean the omni data of bad data points
  
234

Qusai Al Shidi's avatar
Qusai Al Shidi committed
235
**Returns**:
236

Qusai Al Shidi's avatar
Qusai Al Shidi committed
237
238
239
240
241
242
- `pandas.DataFrame` - object with solar wind data
  
  Make sure to download the csv files with cdaweb.sci.gsfc.nasa.gov
  the header seperated into a json file for safety.
  
  This only tested with OMNI data specifically.
243

Qusai Al Shidi's avatar
Qusai Al Shidi committed
244
245
<a name=".swmfpy.io.write_imf_input"></a>
#### write\_imf\_input
246

Qusai Al Shidi's avatar
Autodoc    
Qusai Al Shidi committed
247
```python
Qusai Al Shidi's avatar
Qusai Al Shidi committed
248
write_imf_input(data, outfilename="IMF.dat", enable_rb=True, **kwargs)
Qusai Al Shidi's avatar
Autodoc    
Qusai Al Shidi committed
249
```
Qusai Al Shidi's avatar
Qusai Al Shidi committed
250

251
252
253
Writes the pandas.DataFrame into an input file
that SWMF can read as input IMF (IMF.dat).

Qusai Al Shidi's avatar
Qusai Al Shidi committed
254
**Arguments**:
255

Qusai Al Shidi's avatar
Qusai Al Shidi committed
256
257
258
259
260
261
- `data` - pandas.DataFrame object with solar wind data
- `outfilename` - The output file name for ballistic solar wind data.
- `(default` - "IMF.dat")
- `enable_rb` - Enables solar wind input for the radiation belt model.
- `(default` - True)
  
Qusai Al Shidi's avatar
Qusai Al Shidi committed
262
263
264
  **kwargs:
- `gse` _bool_ - (default: False) Use GSE coordinates instead of GSM.
  
Qusai Al Shidi's avatar
Qusai Al Shidi committed
265
266
267
  Other paramaters:
- `gse` - (default=False)
  Use GSE coordinate system for the file instead of GSM default.
268

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

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

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

Qusai Al Shidi's avatar
Qusai Al Shidi committed
279
**Arguments**:
280

Qusai Al Shidi's avatar
Qusai Al Shidi committed
281
282
283
284
285
286
287
288
289
- `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]'.
  
290

Qusai Al Shidi's avatar
Qusai Al Shidi committed
291
**Returns**:
Qusai Al Shidi's avatar
Qusai Al Shidi committed
292

Qusai Al Shidi's avatar
Qusai Al Shidi committed
293
294
  Dictionary of the log file
  
295

Qusai Al Shidi's avatar
Qusai Al Shidi committed
296
**Examples**:
Qusai Al Shidi's avatar
Qusai Al Shidi committed
297

Qusai Al Shidi's avatar
Qusai Al Shidi committed
298
299
300
301
302
303
304
305
  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'])
  ```
306

Qusai Al Shidi's avatar
Qusai Al Shidi committed
307
308
<a name=".swmfpy.paramin"></a>
## swmfpy.paramin
309

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

Qusai Al Shidi's avatar
Qusai Al Shidi committed
312
313
<a name=".swmfpy.paramin.replace_command"></a>
#### replace\_command
314

Qusai Al Shidi's avatar
Autodoc    
Qusai Al Shidi committed
315
316
317
```python
replace_command(parameters, input_file, output_file='PARAM.in')
```
Qusai Al Shidi's avatar
Qusai Al Shidi committed
318

319
320
321
322
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
323
**Arguments**:
324

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

Qusai Al Shidi's avatar
Qusai Al Shidi committed
332
**Returns**:
Qusai Al Shidi's avatar
Qusai Al Shidi committed
333

Qusai Al Shidi's avatar
Qusai Al Shidi committed
334
335
  A list of lines of the PARAM.in file that would be outputted.
  
336

Qusai Al Shidi's avatar
Qusai Al Shidi committed
337
**Raises**:
Qusai Al Shidi's avatar
Qusai Al Shidi committed
338

Qusai Al Shidi's avatar
Qusai Al Shidi committed
339
340
- `TypeError` - If a value given couldn't be converted to string.
  
341

Qusai Al Shidi's avatar
Qusai Al Shidi committed
342
**Examples**:
Qusai Al Shidi's avatar
Qusai Al Shidi committed
343

Qusai Al Shidi's avatar
Qusai Al Shidi committed
344
345
346
347
348
349
  ```python
  change['`SOLARWINDFILE`'] = [['T', 'UseSolarWindFile'],
  ['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
350

Qusai Al Shidi's avatar
Qusai Al Shidi committed
351
352
<a name=".swmfpy.paramin.read_command"></a>
#### read\_command
Qusai Al Shidi's avatar
Qusai Al Shidi committed
353
354

```python
Qusai Al Shidi's avatar
Qusai Al Shidi committed
355
read_command(command, paramin_file='PARAM.in', **kwargs)
Qusai Al Shidi's avatar
Qusai Al Shidi committed
356
357
```

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

Qusai Al Shidi's avatar
Qusai Al Shidi committed
360
This will find the `COMMAND` and return a list of values for the parameters.
Qusai Al Shidi's avatar
Qusai Al Shidi committed
361

Qusai Al Shidi's avatar
Qusai Al Shidi committed
362
**Arguments**:
Qusai Al Shidi's avatar
Qusai Al Shidi committed
363

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

Qusai Al Shidi's avatar
Qusai Al Shidi committed
372
**Returns**:
Qusai Al Shidi's avatar
Qusai Al Shidi committed
373

Qusai Al Shidi's avatar
Qusai Al Shidi committed
374
375
376
- `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
377

Qusai Al Shidi's avatar
Qusai Al Shidi committed
378
**Raises**:
Qusai Al Shidi's avatar
Qusai Al Shidi committed
379

Qusai Al Shidi's avatar
Qusai Al Shidi committed
380
381
- `ValueError` - When the `COMMAND` is not found.
  
Qusai Al Shidi's avatar
Qusai Al Shidi committed
382

Qusai Al Shidi's avatar
Qusai Al Shidi committed
383
**Examples**:
Qusai Al Shidi's avatar
Qusai Al Shidi committed
384

Qusai Al Shidi's avatar
Qusai Al Shidi committed
385
386
387
388
389
390
391
392
393
394
  ```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
395