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.

__init__.py 2.68 KB
Newer Older
1
"""A collection of tools to read, write, visualize with the
2
3
Space Weather Modeling Framework (SWMF).

4
### Modules
5
6
7

These are automatically imported.

8
9
10
- `swmfpy.io` Input/Output tools.
- `swmfpy.paramin` PARAM.in editing tools.
- `swmfpy.web` Internet data downloading/uploading tools.
11

12
### Extra Modules
13
14
15

These are not automatically imported. Might have extra dependancies.

Qusai Al Shidi's avatar
Qusai Al Shidi committed
16
*None yet.*
Qusai Al Shidi's avatar
Qusai Al Shidi committed
17
"""
18
19
__author__ = 'Qusai Al Shidi'
__license__ = 'MIT'
20
__version__ = '2020.1'
21
22
__maintainer__ = 'Qusai Al Shidi'
__email__ = 'qusai@umich.edu'
Qusai Al Shidi's avatar
Qusai Al Shidi committed
23
24


Qusai Al Shidi's avatar
Qusai Al Shidi committed
25
26
import sys
assert sys.version_info >= (3, 6), "swmfpy requires Python >=3.6. Sorry :(."
Qusai Al Shidi's avatar
Qusai Al Shidi committed
27
28
from . import paramin
from . import io
29
from . import web
30

31
32
33
34
35
36
37
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
# This is straight from the format guide on spdf with nicer names as second col
OMNI_COLS = (('ID for IMF spacecraft', 'id_imf'),
             ('ID for SW Plasma spacecraft', 'id_sw'),
             ('# of points in IMF averages', 'num_avg_imf'),
             ('# of points in Plasma averages', 'num_avg_sw'),
             ('Percent interp', 'interp'),
             ('Timeshift, sec', 'timeshift'),
             ('RMS, Timeshift', 'rms_timeshift'),
             ('RMS, Phase front normal', 'rms_phase'),
             ('Time btwn observations, sec', 'dt'),
             ('Field magnitude average, nT', 'b'),
             ('Bx, nT (GSE, GSM)', 'bx'),
             ('By, nT (GSE)', 'by_gse'),
             ('Bz, nT (GSE)', 'bz_gse'),
             ('By, nT (GSM)', 'by'),
             ('Bz, nT (GSM)', 'bz'),
             ('RMS SD B scalar, nT', 'rms_sd_b'),
             ('RMS SD field vector, nT', 'rms_sd_field'),
             ('Flow speed, km/s', 'v'),
             ('Vx Velocity, km/s, GSE', 'vx_gse'),
             ('Vy Velocity, km/s, GSE', 'vy_gse'),
             ('Vz Velocity, km/s, GSE', 'vz_gse'),
             ('Proton Density, n/cc', 'density'),
             ('Temperature, K', 'temperature'),
             ('Flow pressure, nPa', 'pressure'),
             ('Electric field, mV/m', 'e'),
             ('Plasma beta', 'beta'),
             ('Alfven mach number', 'alfven_mach'),
             ('X(s/c), GSE, Re', 'x_gse'),
             ('Y(s/c), GSE, Re', 'y_gse'),
             ('Z(s/c), GSE, Re', 'z_gse'),
             ('BSN location, Xgse, Re', 'bsn_x_gse'),
             ('BSN location, Ygse, Re', 'bsn_y_gse'),
             ('BSN location, Zgse, Re', 'bsn_z_gse'),
             ('AE-index, nT', 'ae'),
             ('AL-index, nT', 'al'),
             ('AU-index, nT', 'au'),
             ('SYM/D index, nT', 'sym_d'),
             ('SYM/H index, nT', 'sym_h'),
             ('ASY/D index, nT', 'asy_d'),
             ('ASY/H index, nT', 'asy_h'),
             ('PC(N) index', 'pc_n'),
             ('Magnetosonic mach number', 'mach'),
             )