DOCUMENTATION.markdown 9.03 KB
Newer Older
1

Qusai Al Shidi's avatar
Autodoc    
Qusai Al Shidi committed
2
# swmfpy
3

Qusai Al Shidi's avatar
Autodoc    
Qusai Al Shidi committed
4
5
SWMF Tools
==========
6

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

Qusai Al Shidi's avatar
Autodoc    
Qusai Al Shidi committed
10
11
Modules
-------
12

Qusai Al Shidi's avatar
Autodoc    
Qusai Al Shidi committed
13
These are automatically imported.
14

Qusai Al Shidi's avatar
Autodoc    
Qusai Al Shidi committed
15
16
17
- swmfpy.io: Input/Output tools.
- swmfpy.paramin: PARAM.in editing tools.
- swmfpy.web: Internet data downloading/uploading tools.
18

Qusai Al Shidi's avatar
Autodoc    
Qusai Al Shidi committed
19
20
Extra Modules
-------------
21

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

Qusai Al Shidi's avatar
Autodoc    
Qusai Al Shidi committed
24
*None yet.*
25
26


Qusai Al Shidi's avatar
Autodoc    
Qusai Al Shidi committed
27
28
# swmfpy.io
Input/Output tools
29

Qusai Al Shidi's avatar
Autodoc    
Qusai Al Shidi committed
30
31
Input/Output
============
32

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

Qusai Al Shidi's avatar
Autodoc    
Qusai Al Shidi committed
35
TODO: Move pandas dependancy elsewhere.
36
37


Qusai Al Shidi's avatar
Autodoc    
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
## 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.

Args:
 wdc_filename (str): Filename of wdc data from
                     http://wdc.kugi.kyoto-u.ac.jp/
Returns:
 dict: {
        Auroral indeces 'AL', 'AE', 'AO', 'AU' (int): {
             'times' (datetime.datetime): List of datetime objects
                                          corresponding to time in UT.
             'values' (int): List of indeces.
       }


## read_wdc_asy_sym
```python
read_wdc_asy_sym(wdc_filename)
```
Reads a WDC file for ASY/SYM data.
62

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

Qusai Al Shidi's avatar
Autodoc    
Qusai Al Shidi committed
67
68
Args:
    wdc_filename (str): Relative filename (or file handle no.) to read.
69

Qusai Al Shidi's avatar
Autodoc    
Qusai Al Shidi committed
70
71
72
Returns:
    dict: of values.
    {'[ASY-SYM]-[D-H]': 'times': [], 'values': []}
73

Qusai Al Shidi's avatar
Autodoc    
Qusai Al Shidi committed
74
75
76
77
78
79
80
81
82
83
Examples:
    ```
    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]')
    ```
84

Qusai Al Shidi's avatar
Autodoc    
Qusai Al Shidi committed
85
Important to note if there is bad data it will be filled as None.
86
87


Qusai Al Shidi's avatar
Autodoc    
Qusai Al Shidi committed
88
89
90
91
## read_omni_csv
```python
read_omni_csv(filename, filtering=False, **kwargs)
```
92
93
94
Take an OMNI csv file from cdaweb.sci.gsfc.nasa.gov
and turn it into a pandas.DataFrame.

Qusai Al Shidi's avatar
Autodoc    
Qusai Al Shidi committed
95
96
97
98
99
100
101
102
103
104
Args:
    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.
    **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
105

Qusai Al Shidi's avatar
Autodoc    
Qusai Al Shidi committed
106
107
Returns:
    pandas.DataFrame: object with solar wind data
108
109
110
111
112
113
114

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.


Qusai Al Shidi's avatar
Autodoc    
Qusai Al Shidi committed
115
116
117
118
## write_imf_input
```python
write_imf_input(data, outfilename='IMF.dat', enable_rb=True, **kwargs)
```
119
120
121
Writes the pandas.DataFrame into an input file
that SWMF can read as input IMF (IMF.dat).

Qusai Al Shidi's avatar
Autodoc    
Qusai Al Shidi committed
122
123
124
125
126
127
Args:
    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)
128
129
130
131
132
133

Other paramaters:
    gse: (default=False)
        Use GSE coordinate system for the file instead of GSM default.


Qusai Al Shidi's avatar
Autodoc    
Qusai Al Shidi committed
134
135
136
137
138
139
## 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.
140

Qusai Al Shidi's avatar
Autodoc    
Qusai Al Shidi committed
141
142
143
144
145
146
147
148
149
Args:
    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]'.
150

Qusai Al Shidi's avatar
Autodoc    
Qusai Al Shidi committed
151
152
Returns:
    Dictionary of the log file
153

Qusai Al Shidi's avatar
Autodoc    
Qusai Al Shidi committed
154
155
156
157
158
Examples:
    To plot AL and Dst get the log files
    ```
    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')
159

Qusai Al Shidi's avatar
Autodoc    
Qusai Al Shidi committed
160
161
162
    # Plot AL indeces
    plt.plot(geo['times', geo['AL'])
    ```
163
164
165



Qusai Al Shidi's avatar
Autodoc    
Qusai Al Shidi committed
166
# swmfpy.paramin
167

Qusai Al Shidi's avatar
Autodoc    
Qusai Al Shidi committed
168
169
PARAM.in Tools
--------------
170

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


Qusai Al Shidi's avatar
Autodoc    
Qusai Al Shidi committed
174
175
176
177
## replace_command
```python
replace_command(parameters, input_file, output_file='PARAM.in')
```
178
179
180
181
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
Autodoc    
Qusai Al Shidi committed
182
183
184
185
186
187
188
189
190
191
192
193
194
195
Args:
    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.
Returns:
    A list of lines of the PARAM.in file that would be outputted.

Raises:
    TypeError: If a value given couldn't be converted to string.

Examples:
Qusai Al Shidi's avatar
Qusai Al Shidi committed
196
197
    ```python

Qusai Al Shidi's avatar
Autodoc    
Qusai Al Shidi committed
198
199
200
201
    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
202

Qusai Al Shidi's avatar
Autodoc    
Qusai Al Shidi committed
203
204
205
206
207
208
209
210
    ```


## read_command
```python
read_command(command, paramin_file='PARAM.in', **kwargs)
```
Get parameters of a certain command in PARAM.in file.
211

Qusai Al Shidi's avatar
Autodoc    
Qusai Al Shidi committed
212
This will find the [`COMMAND`](#COMMAND) and return a list of values for the parameters.
213

Qusai Al Shidi's avatar
Autodoc    
Qusai Al Shidi committed
214
215
216
217
218
219
220
Args:
    command (str): This is the [`COMMAND`](#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.
221

Qusai Al Shidi's avatar
Autodoc    
Qusai Al Shidi committed
222
223
224
Returns:
    list: Values found for the [`COMMAND`](#COMMAND) in file. Index 0 is [`COMMAND`](#COMMAND) and
          the values follow (1 for first argument...)
225

Qusai Al Shidi's avatar
Autodoc    
Qusai Al Shidi committed
226
227
Raises:
    ValueError: When the [`COMMAND`](#COMMAND) is not found.
228

Qusai Al Shidi's avatar
Autodoc    
Qusai Al Shidi committed
229
Examples:
Qusai Al Shidi's avatar
Qusai Al Shidi committed
230
231
    ```python

Qusai Al Shidi's avatar
Autodoc    
Qusai Al Shidi committed
232
233
234
235
    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])
236

Qusai Al Shidi's avatar
Qusai Al Shidi committed
237
238
    ```

Qusai Al Shidi's avatar
Autodoc    
Qusai Al Shidi committed
239
240
241
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.
242

Qusai Al Shidi's avatar
Qusai Al Shidi committed
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
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

# swmfpy.web
Tools to retrieve and send data on the web.

SWMF Web Tools
==============

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


## 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().

Args:
    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)
    ```


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

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