diff --git a/docs/source/docs.rst b/docs/source/docs.rst new file mode 100644 index 0000000000000000000000000000000000000000..fd2b8cb6ded46728bed41be9d35254c9e32fba11 --- /dev/null +++ b/docs/source/docs.rst @@ -0,0 +1,27 @@ +=========================== +Further readings and drafts +=========================== + + +:download:`inaf_cpcp_superdarn_datacube (pdf) <products/docs/inaf_cpcp_superdarn_datacube-SuperDARN_data_handling.pdf>` + +:download:`inaf_data_solopas_timeseries (pdf) <products/docs/inaf_data_solopas_timeseries-14_Solo_pas_description.pdf>` + +:download:`unical_sep_ace_spectrum (pdf) <products/docs/unical_sep_ace_spectrum-Description_SEP_ACE.pdf>` + +:download:`unical_sep_psp_spectrum (pdf) <products/docs/unical_sep_psp_spectrum-Description_SEP_PSP.pdf>` + +:download:`unical_sep_soho_spectrum (pdf) <products/docs/unical_sep_soho_spectrum-Description_SEP_SOHO.pdf>` + +:download:`unical_sep_solo_spectrum (pdf) <products/docs/unical_sep_solo_spectrum-Description_SEP_SOLO.pdf>` + +:download:`unical_sep_stra_spectrum (pdf) <products/docs/unical_sep_stra_spectrum-Description_SEP_STEREOA.pdf>` + +:download:`unical_sep_wind_spectrum (pdf) <products/docs/unical_sep_wind_spectrum-Description_SEP_WIND.pdf>` + +:download:`unical_shockpar_tableset (pdf) <products/docs/unical_shockpar_tableset-Description_ESP_STEREOA.pdf>` + +:download:`unical_shockpar_tableset (pdf) <products/docs/unical_shockpar_tableset-Description_product22-1.pdf>` + +:download:`unical_visual_spectra_sw (pdf) <products/docs/unical_visual_spectra_sw-Description_visual_spectra.pdf>` + diff --git a/docs/source/products/data/inaf_cpcp_superdarn_datacube.rst b/docs/source/products/data/inaf_cpcp_superdarn_datacube.rst index dd3d27a4bb15d5945a8fbca6c4c5272b364c112d..8efc139c45f5467285e1c70978df540a9242fbe8 100644 --- a/docs/source/products/data/inaf_cpcp_superdarn_datacube.rst +++ b/docs/source/products/data/inaf_cpcp_superdarn_datacube.rst @@ -6,7 +6,7 @@ INAF SuperDARN Cross Polar Cap Potential SuperDARN maximum potential difference measured across the polar caps. -:download:`Further readings (pdf) <products/docs/inaf_cpcp_superdarn_datacube-SuperDARN_data_handling.pdf>`. +:download:`Further readings (pdf) <../docs/inaf_cpcp_superdarn_datacube-SuperDARN_data_handling.pdf>`. diff --git a/docs/source/products/data/unical_espseptransport_tableset.rst b/docs/source/products/data/unical_espseptransport_tableset.rst new file mode 100644 index 0000000000000000000000000000000000000000..9244f1f6d062422e2146ef9a2cdf156501ab964e --- /dev/null +++ b/docs/source/products/data/unical_espseptransport_tableset.rst @@ -0,0 +1,62 @@ +========================================== +UNICAL Energetic particle spectral indices +========================================== + +.. contents:: The tiny table of contents + +The differential energy spectral index is listed for all the SEP/ESP events analyzed and a pointer to the relevant transport parameter files + + +Data Description +---------------- + +| **Data type**: tableset + +| **Data formats**: - csv + + +| **Version**: v2.0 + +Data Provider +------------- + +Data are collected by the following instruments: + +- **ACE** - source: + + - EPAM + +Data Coverage +------------- +The product cover measurements for the ND messangers. + +Data coverage is listed below: + +| **Spatial** IP + +| **Temporal** - time_start: 2009-01-01T00:00:00+01:00 + +- time_stop: 2022-03-31T00:00:00+02:00 + + + +| **Spectral** range: ND ND - ND ND + +Product Status +-------------- + +| **Status**: Active + +| **Creation date**: 2022-04-27T09:47:00+02:00 + +| **Last Update**: 2023-10-31T12:00:00+01:00 + +Data Policy +----------- + +This product contains public data. Public access to the data. + +Example +------- + +Example is not yet provided . diff --git a/docs/source/products/data/unical_shockpar_tableset.rst b/docs/source/products/data/unical_shockpar_tableset.rst new file mode 100644 index 0000000000000000000000000000000000000000..e56e0baaeb029796e6409bb18c9d2f90f5b6cdb6 --- /dev/null +++ b/docs/source/products/data/unical_shockpar_tableset.rst @@ -0,0 +1,159 @@ +====================================================== +UNICAL Parameters of shocks associated with ESP events +====================================================== + +.. contents:: The tiny table of contents + +The table contains a list +of shocks (and their parameters) associated with ESP and SEP events, observed from Stereo +A, Wind, ACE spacecraft from 2009. The shock parameters (the plasma beta, the angle +between the mean magnetic field and the normal to the shock, the magnetosonic Mach +number) for Stereo A spacecraft were taken from: + +Jian et al. Interplanetary Shock list +(URL: https://stereo-ssc.nascom.nasa.gov/data/ins_data/impact/level3/IPs.pdf ) + +and the +related ESP spectra are presented in detail in the paper Chiappetta et al. (2021) ApJ 915, 8 +DOI: 10.3847/1538-4357/abfe09. +The shock parameters (the plasma beta, the angle between the mean magnetic field and the +normal to the shock, the magnetosonic Mach number, compression ratio) for Wind and ACE, +have been calculated using upstream and downstream time intervals of [tshock – 9min, tshock – +1min] and [tshock + 2min, tshock + 10min], respectively. In these cases the normal vector of the +shock (and therefore the angle θBn) is calculated using the Mixed Mode 3 method. When the +plasma data for the event is not available, the magnetic coplanarity method is used to +determine the shock normal vector. +The table also contains information relating to the ESP and SEP spectra files, and to the +turbulence analysis upstream and downstream of the shocks, if available. + +:download:`Further readings (pdf) <../docs/unical_shockpar_tableset-Description_ESP_STEREOA.pdf>`. + +:download:`Further readings (pdf) <../docs/unical_shockpar_tableset-Description_product22-1.pdf>`. + +Data Description +---------------- + +| **Data type**: tableset + +| **Data formats**: - csv + + +| **Version**: v1.0 + +**Columns:** + +1. time and date of the shock arrival at spacecraft; + +2. the plasma beta (β); + +3. the angle (θBn) between the mean magnetic field and the normal to the shock; + +4. the magnetosonic Mach number (Mms); + +5. the compression ratio (r); + +6. the name of the spacecraft; + +7. a flag which indicates if there is a SEP in progress or not; + +8. the name of the SEP spectrum file (if available); + +9. the starting time of the range used to calculate the SEP energy spectrum; + +10. the ending time of the range used to calculate the SEP energy spectrum; + +11. a flag indicating whether ESP spectrum is available; + +12. the name of the ESP spectrum file (if available); + +13. a flag to indicate if the data calibration procedure has been performed or if it has not been necessary; + +14. the starting time of the range used to calculate the ESP energy spectrum; + +15. the ending time of the range used to calculate the ESP energy spectrum; + +16. a flag to indicate whether the PSD is available; + +17. the name of the PSD file calculated in the upstream region of the shock (if available); + +18. the starting time of the range used to calculate the PSD in the upstream region; + +19. the ending time of the range used to calculate the PSD in the upstream region; + +20. the name of the PSD file calculated in the downstream region of the shock (if available); + +21. the starting time of the range used to calculate the PSD in the downstream region; + +22. the ending time of the range used to calculate the PSD in the downstream region; + +23. a flag to indicate whether the Structure Functions are available; + +24. the name of the Structure Functions file calculated in the upstream region of the shock (if available); + +25. the starting time of the range used to calculate the Structure Functions in the upstream region; + +26. the ending time of the range used to calculate the Structure Functions in the upstream region; + +27. the name of the Structure Functions file calculated in the downstream region of the shock (if available); + +28. the starting time of the range used to calculate the Structure Functions in the downstream region; + +29. the ending time of the range used to calculate the Structure Functions in the downstream region. + +Data Provider +--------------- + +Data are collected by the following instruments: + +- **ACE** - sources: + + - EPAM + - MAG + - SWEPAM +- **WIND** - sources: + + - 3DP + - EPACT + - MFI + - SWE +- **STEREO A** - source: + + - IMPACT +- **Jian et al. Interplanetary Shock list at STEREO A** - source: + + - https://stereo-ssc.nascom.nasa.gov/data/ins_data/impact/level3/IPs.pdf + +Data Coverage +----------------- +The product cover measurements for the ND messangers. + +Data coverage is listed below: + +| **Spatial** IP + +| **Temporal** - time_start: 2009-01-01T00:00:36+01:00 + +- time_stop: 2022-03-31T23:00:00+02:00 + + + +| **Spectral** range: ND ND - ND ND + +Product Status +--------------- + +| **Status**: Active + +| **Creation date**: 2023-10-22T17:40:00+02:00 + +| **Last Update**: 2023-10-22T17:40:00+02:00 + +Data Policy +-------------- + +This product contains public data. Other. + +Example +------------ + +Example is not yet provided . diff --git a/docs/source/products/docs/inaf_cpcp_superdarn_datacube-SuperDARN_data_handling.pdf b/docs/source/products/docs/inaf_cpcp_superdarn_datacube-SuperDARN_data_handling.pdf new file mode 100644 index 0000000000000000000000000000000000000000..20afb78658e62a757a8f4bd52a81fbfa0b5f1b61 Binary files /dev/null and b/docs/source/products/docs/inaf_cpcp_superdarn_datacube-SuperDARN_data_handling.pdf differ diff --git a/docs/source/products/docs/inaf_data_solopas_timeseries-14_Solo_pas_description.pdf b/docs/source/products/docs/inaf_data_solopas_timeseries-14_Solo_pas_description.pdf new file mode 100644 index 0000000000000000000000000000000000000000..0eae1b443eb0f0dcb6e7858843d0330a663d6521 Binary files /dev/null and b/docs/source/products/docs/inaf_data_solopas_timeseries-14_Solo_pas_description.pdf differ diff --git a/docs/source/products/docs/unical_sep_ace_spectrum-Description_SEP_ACE.pdf b/docs/source/products/docs/unical_sep_ace_spectrum-Description_SEP_ACE.pdf new file mode 100644 index 0000000000000000000000000000000000000000..fe2242fa86bd281f75f01ea0e8b7ea7fcbccf8d7 Binary files /dev/null and b/docs/source/products/docs/unical_sep_ace_spectrum-Description_SEP_ACE.pdf differ diff --git a/docs/source/products/docs/unical_sep_psp_spectrum-Description_SEP_PSP.pdf b/docs/source/products/docs/unical_sep_psp_spectrum-Description_SEP_PSP.pdf new file mode 100644 index 0000000000000000000000000000000000000000..3289c252707a74184be03c5ea91b588b94d52ec8 Binary files /dev/null and b/docs/source/products/docs/unical_sep_psp_spectrum-Description_SEP_PSP.pdf differ diff --git a/docs/source/products/docs/unical_sep_soho_spectrum-Description_SEP_SOHO.pdf b/docs/source/products/docs/unical_sep_soho_spectrum-Description_SEP_SOHO.pdf new file mode 100644 index 0000000000000000000000000000000000000000..05b443313c74fb0a955f857442ac2f8c986683b4 Binary files /dev/null and b/docs/source/products/docs/unical_sep_soho_spectrum-Description_SEP_SOHO.pdf differ diff --git a/docs/source/products/docs/unical_sep_solo_spectrum-Description_SEP_SOLO.pdf b/docs/source/products/docs/unical_sep_solo_spectrum-Description_SEP_SOLO.pdf new file mode 100644 index 0000000000000000000000000000000000000000..4e5141518632c1822aed778c23d6824cf3ce2afa Binary files /dev/null and b/docs/source/products/docs/unical_sep_solo_spectrum-Description_SEP_SOLO.pdf differ diff --git a/docs/source/products/docs/unical_sep_stra_spectrum-Description_SEP_STEREOA.pdf b/docs/source/products/docs/unical_sep_stra_spectrum-Description_SEP_STEREOA.pdf new file mode 100644 index 0000000000000000000000000000000000000000..331635d07f2baf55757cdddb7069f1fc539451bd Binary files /dev/null and b/docs/source/products/docs/unical_sep_stra_spectrum-Description_SEP_STEREOA.pdf differ diff --git a/docs/source/products/docs/unical_sep_wind_spectrum-Description_SEP_WIND.pdf b/docs/source/products/docs/unical_sep_wind_spectrum-Description_SEP_WIND.pdf new file mode 100644 index 0000000000000000000000000000000000000000..9e4fe2dfdd7e8e816f09ee7ba12e51554d7ab4f7 Binary files /dev/null and b/docs/source/products/docs/unical_sep_wind_spectrum-Description_SEP_WIND.pdf differ diff --git a/docs/source/products/docs/unical_shockpar_tableset-Description_ESP_STEREOA.pdf b/docs/source/products/docs/unical_shockpar_tableset-Description_ESP_STEREOA.pdf new file mode 100644 index 0000000000000000000000000000000000000000..89b627bd20b54e23e67fdbe4a670d22d6bbef93b Binary files /dev/null and b/docs/source/products/docs/unical_shockpar_tableset-Description_ESP_STEREOA.pdf differ diff --git a/docs/source/products/docs/unical_shockpar_tableset-Description_product22-1.pdf b/docs/source/products/docs/unical_shockpar_tableset-Description_product22-1.pdf new file mode 100644 index 0000000000000000000000000000000000000000..4231a21109135be1be7d6366ce2e3c7b6533dd3d Binary files /dev/null and b/docs/source/products/docs/unical_shockpar_tableset-Description_product22-1.pdf differ diff --git a/docs/source/products/docs/unical_visual_spectra_sw-Description_visual_spectra.pdf b/docs/source/products/docs/unical_visual_spectra_sw-Description_visual_spectra.pdf new file mode 100644 index 0000000000000000000000000000000000000000..da336df39bc65490d03c8850094d3cc24d5b7d68 Binary files /dev/null and b/docs/source/products/docs/unical_visual_spectra_sw-Description_visual_spectra.pdf differ