-
Notifications
You must be signed in to change notification settings - Fork 0
/
Copy pathFDAT_readme.txt
139 lines (105 loc) · 4.03 KB
/
FDAT_readme.txt
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
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
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
********************************************************************************************
FDAT - Forbush Decrease Analysis Tool
********************************************************************************************
A graphical user interface tool for analyzing Forbush decrease and ICME events, performing basic in-situ analysis of ICMEs/flux ropes, and
conducting ForbMod best-fit calculations on selected data regions.
====================================
OVERVIEW
====================================
ForbMod GUI enables to:
- Plot and analyze ICME/Forbush decrease events
- Select borders of ICME events and related Forbush decreases
- Perform in-situ analysis of ICMEs
- Execute ForbMod best-fit procedures on selected events
- Generate comprehensive analysis outputs and visualizations
====================================
INSTALLATION
====================================
Prerequisites:
-------------
- Python 3.10.6 or later
- Operating System: Tested on Windows, macOS, should work on Linux
Core Scientific Libraries:
numpy>=1.24.0 (array operations, calculations)
scipy>=1.10.0 (scientific computations)
matplotlib>=3.7.0 (plotting)
scikit-learn>=1.2.0 (data analysis)
mpmath>=1.3.0 (mathematical functions)
pandas>=2.0.0 (data manipulation)
GUI Libraries:
PyQt5>=5.15.0 (main GUI framework)
pyqtgraph>=0.13.0 (fast plotting)
Additional Libraries:
python-dateutil>=2.8.0 (date handling)
setuptools>=65.5.1 (package management)
wheel>=0.38.0 (package management)
Optional Development Tools:
pytest>=7.0.0 (testing)
flake8>=6.0.0 (code quality)
black>=22.0.0 (code formatting)
Installation Steps:
-----------------
1. Install required packages:
python3 -m pip install --upgrade pip setuptools
pip3 install -r requirements.txt
2. Navigate to ForbMod directory and run:
python3 FDAT_main.py
====================================
USAGE
====================================
Application Workflow:
-------------------
Window 1 (Start Window):
- Enter start and end dates
- Select satellite source
- Input observer name (will be saved in the events ID)
Window 2 (Plot Window):
- View magnetic field, solar wind and GCR data
- Adjust borders for analysis region
- Adjust range for the upstream solar wind speed calculation window
- Select fit type from dropdown (inner, extended, optimal or test)
- Click "Calculate" to initiate analysis
Window 3 (Fit Window):
- Review selected FD data and best-fit function
- Choose fit type characteristics
- Save analysis results, including screenshots, ICME& FD parameters
====================================
OUTPUT FILES
====================================
Analysis results are saved as:
best_fit.jpg = Image showing selected data and best-fit function
bestfit_data.txt = Selected FD vs r data
bestfit_results.txt = Best-fit FD amplitude and MSE values
insitu_results.txt = DOY start/end, vLead, vTrail, BPeak, BAvg, FD_obs
bestfit_function.txt = Best-fit FD function vs r
plot_window.png = Screenshot of analysis window with chosen borders
all_res_{satellite}.csv = all ICME, FD, fit parameters for each event in one table
====================================
DATA SOURCES
====================================
Supported satellite MF&SW data sources and periods:
- Solar Orbiter: Apr 2020 - Jul 2024
- OMNI: Jan 2007 - Dec 2019
- ACE: Sep 1997 - Dec 2022
- WIND: Nov 1994 - Sep 2024
- Helios2: Jan 1976 - Mar 1980
- Helios1: Dec 1974 - Jun 1981
====================================
VERSION HISTORY
====================================
v6 (12-11-2024) - G.Chikunova
v5 (16-09-2024) - G.Chikunova
v4 (09-06-2024) - G.Chikunova
v3 (13-03-2024) - M. Dumbovic
v2 (11-12-2022) - M. Dumbovic
v1 (17-10-2022) - L. Kramaric
====================================
KNOWN LIMITATIONS
====================================
- Only works for time spans where data is available in the GUI
====================================
CONTACT
====================================
For questions and support, contact:
G.Chikunova ([email protected])
********************************************************************************************