Skip to content

Commit 05589ba

Browse files
authored
Update README.md
Updates after splitting figures in the manuscript
1 parent e801bc1 commit 05589ba

File tree

1 file changed

+21
-17
lines changed

1 file changed

+21
-17
lines changed

figures/README.md

Lines changed: 21 additions & 17 deletions
Original file line numberDiff line numberDiff line change
@@ -13,44 +13,48 @@ Inkscape is an open source vector graphic software, available on https://inkscap
1313
We will discuss below how to generate the base figures that do not include the special notation (shading, numbering etc.) to assist any reader interested in re-producing our results.
1414

1515
## Step-by-step instructions
16+
### Figure 1
1617

17-
### Figures 1,2
18+
* FIG. 1 was generated using the mms.mms4_pl_conf function of [irfu-matlab](https://github.com/irfu/irfu-matlab) package
1819

19-
* FIG1 and FIG2 (a) were generated using the mms.mms4_pl_conf function of [irfu-matlab](https://github.com/irfu/irfu-matlab) package
20-
FIG1 and FIG2 (b,c) are ladder plots of different MMS spacecraft. all the raw data available for them can be found in the MMS public depository.
20+
### Figures 2,3
2121

22-
* For panels 3-5 for FIG1,2 (b,c) one can use the iPDist.reduce function of [irfu-matlab](https://github.com/irfu/irfu-matlab) package in 1D on x,y,z GSE coordinates. The panels correspond to 1D reduced velocity distribution functions.
22+
FIG. 1 and FIG. 2 (a,b) are ladder plots of different MMS spacecraft. all the raw data available for them can be found in the MMS public depository.
2323

24-
* For panel 9 for FIG1,2 (b,c) one can use irf_spectrogram of [irfu-matlab](https://github.com/irfu/irfu-matlab) package. The panels correspond to ion differential energy flux spectrum.
24+
* For panels 3-5 for FIGs 2,3 (a,b) one can use the iPDist.reduce function of [irfu-matlab](https://github.com/irfu/irfu-matlab) package in 1D on x,y,z GSE coordinates. The panels correspond to 1D reduced velocity distribution functions.
25+
26+
* For panel 9 for FIGs 2,3 (a,b) one can use irf_spectrogram of [irfu-matlab](https://github.com/irfu/irfu-matlab) package. The panels correspond to ion differential energy flux spectrum.
2527

2628
- The rest of the panels are essentially timeseries plots made with irf_plot and irf_panel of [irfu-matlab](https://github.com/irfu/irfu-matlab).
2729

28-
### Figures 3,5
30+
### Figures 4,6
2931

30-
* For panel 3 of FIGs 3,5 one can use the iPDist.reduce function of [irfu-matlab](https://github.com/irfu/irfu-matlab) package in 1D on x GSE direction. The panel correspond to 1D reduced ion velocity distribution function.
32+
* For panel 3 of FIGs 4,6 one can use the iPDist.reduce function of [irfu-matlab](https://github.com/irfu/irfu-matlab) package in 1D on x GSE direction. The panel correspond to 1D reduced ion velocity distribution function.
3133

32-
* For panel 6 for FIG3,5 one can use irf_spectrogram of [irfu-matlab](https://github.com/irfu/irfu-matlab) package. The panel correspond to the ion differential energy flux spectrum.
34+
* For panel 6 for FIGs 4,6 one can use irf_spectrogram of [irfu-matlab](https://github.com/irfu/irfu-matlab) package. The panel correspond to the ion differential energy flux spectrum.
3335

34-
* For FIG 5(c), one can use the function mms.psd_moments of [irfu-matlab](https://github.com/irfu/irfu-matlab) package. Specifically, the jet is defined as a closed square box of the particles corresponding to negative velocities in the x and y GSE direction in the FIGS1 and discussed in the manuscript of the text.
36+
* For FIG. 6(c), one can use the function mms.psd_moments of [irfu-matlab](https://github.com/irfu/irfu-matlab) package. Specifically, the jet is defined as a closed square box of the particles corresponding to negative velocities in the x and y GSE direction in the FIGS1 and discussed in the manuscript of the text.
3537

36-
* Mach number computations to generate the first panel of FIG5(c) is discussed in the results section of the manuscript.
38+
* Mach number computations to generate the first panel of FIG. 6(c) is discussed in the results and methods ssection of the manuscript.
3739

3840

39-
### Figure 4
41+
### Figure 5
4042

41-
- For reducing the velocity distributions and poject them in 2D we used the iPDist.reduce function of [irfu-matlab](https://github.com/irfu/irfu-matlab) package. Specifically, we use 2D on x,y,z GSE coordinates. The exact same result can be generated by using 3 data points (i-1:i+1) for each measurement point of the FPI burst dataset.
43+
* For reducing the velocity distributions and poject them in 2D we used the iPDist.reduce function of [irfu-matlab](https://github.com/irfu/irfu-matlab) package. Specifically, we use 2D on x,y,z GSE coordinates. The exact same result can be generated by using 3 data points (i-1:i+1) for each measurement point of the FPI burst dataset.
4244

4345

44-
### Figure 6
46+
### Figure 7
4547

46-
* To generate FIG6 one has to use MMS 1 to cross corelate the rest of the spacecraft measurements with respect to it. For picking the time period, one can focus on the region ("1") as discussed in the manuscript or extend the period to include a larger part. One can use the sample cross-correlation function as implemented in MATLAB software, https://mathworks.com/help/econ/crosscorr.html to perform the task. As discussed in the manuscript, adapting the period of time must produce no significant differences in the optimal time lag between the measurements. More information abou this process can be found in the methods section of the article and in the references cited there.
48+
* To generate FIG. 7 one has to use MMS 1 to cross corelate the rest of the spacecraft measurements with respect to it. For picking the time period, one can focus on the region ("1") as discussed in the manuscript or extend the period to include a larger part. One can use the sample cross-correlation function as implemented in MATLAB software, https://mathworks.com/help/econ/crosscorr.html to perform the task. As discussed in the manuscript, adapting the period of time must produce no significant differences in the optimal time lag between the measurements. More information abou this process can be found in the methods section of the article and in the references cited there.
4749

4850
* The plot itself is a typical ladder plot of 4 timerseries that include magnetic field measurements. Similar to the figures above, one can use the irf_plot function of [irfu-matlab](https://github.com/irfu/irfu-matlab) package.
4951

50-
### Figure 7
52+
### Figure 8
53+
54+
* FIG. 8(a) was generated using the mms.mms4_pl_conf function of [irfu-matlab](https://github.com/irfu/irfu-matlab) package
5155

52-
* FIG 7(a) was completely done using vector graphics in inkscape by the corresponding author.
56+
* FIG. 8(b) was completely done using vector graphics in inkscape by the corresponding author.
5357

54-
* FIG 7(b) is a timeseries ladder plot using simple plotting routines and the irf_spectrogram of [irfu-matlab](https://github.com/irfu/irfu-matlab) package.
58+
* FIG. 8(c) is a timeseries ladder plot using simple plotting routines and the irf_spectrogram of [irfu-matlab](https://github.com/irfu/irfu-matlab) package.
5559

5660
If more information are needed, the reader may contact the corresponding author.

0 commit comments

Comments
 (0)