VE7UWU/sdrangel
1
0
Fork 0
mirror of https://github.com/f4exb/sdrangel.git synced 2024-12-23 01:55:48 -05:00
Code Issues Projects Releases Wiki Activity

Fix typos in docs and CMakeLists.txt

Browse Source
This commit is contained in:
srcejon 2024-04-02 16:39:33 +01:00
parent 610c36004e
commit 8d57e040ff
2 changed files with 39 additions and 39 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

2
plugins/feature/CMakeLists.txt
View File

@ -121,7 +121,7 @@ else()
message(STATUS "Not building remotecontrol (ENABLE_FEATURE_REMOTECONTROL=${ENABLE_FEATURE_REMOTECONTROL})")
endif()
if (ENABLED_FEATURE_SID)
if (ENABLE_FEATURE_SID)
add_subdirectory(sid)
else()
message(STATUS "Not building SID (ENABLED_FEATURE_SID=${ENABLED_FEATURE_SID})")

76
plugins/feature/sid/readme.md
View File

@ -7,7 +7,7 @@ and GRBs (Gamma Ray Bursts) via SIDs (Sudden Ionospheric Disturbances).
The signal source for which power is measured should typically be a VLF signal from a distant transmitter with near constant day-time power output,
such as the VLF transmitters that are used by navies to communicate with submarines
(E.g. [GQD](https://en.wikipedia.org/wiki/Anthorn_Radio_Station) / [HWU](https://en.wikipedia.org/wiki/HWU_transmitter) / [NAA](https://en.wikipedia.org/wiki/VLF_Transmitter_Cutler)).
This can be measured within SDRangel using the [Channel Power]](../../channelrx/channelpower/readme.md) plugin.
This can be measured within SDRangel using the [Channel Power](../../channelrx/channelpower/readme.md) plugin.
When a solar flare occurs, EUV (Extreme Ultraviolet) and X-ray radiation is emitted from the Sun. When the radiation reaches the Earth's atmosphere (after ~8 minutes),
it can increase the ionization of the D and E regions in the ionosphere, enhancing VLF propagation. Gamma-rays from powerful GRBs can also have a similar effect on the ionosphere.
@ -16,7 +16,7 @@ in the plot of received power vs time.
The SID chart can plot multiple series, allowing different signals from different transmitters to be monitored.
This can be useful as SIDs can be localized to specific regions in the atmosphere, thus not all signals may be affected.
Data can come from multiple [Channel Power]](../../channelrx/channelpower/readme.md) plugins within a single device, or separate devices.
Data can come from multiple [Channel Power](../../channelrx/channelpower/readme.md) plugins within a single device, or separate devices.
To help determine the cause of a SID, addtional data can be plotted from a variety of sources:
@ -33,31 +33,31 @@ To help determine the cause of a SID, addtional data can be plotted from a varie
![SID feature plugin GUI](../../../doc/img/SID_plugin_settings.png)
<h3>Start/stop</h3>
<h3>1: Start/stop</h3>
Press to start/stop collection and plotting of data.
<h3>Open .csv</h3>
<h3>2: Open .csv</h3>
Press to open a .csv file to read data from.
<h3>Save to .csv</h3>
<h3>3: Save to .csv</h3>
Press to select a .csv file to write data to.
<h3>Save chart to image</h3>
<h3>4: Save chart to image</h3>
Press to save the chart to a .png or .jpg file.
<h3>Clear all data</h3>
<h3>5: Clear all data</h3>
Press to clear all data.
<h3>Average</h3>
<h3>6: Average</h3>
Number of samples to use in a moving average filter that can be applied to the data. Set to 1 for no filtering.
<h3>Display Primary Long Wavelength X-Ray Data</h3>
<h3>7: Display Primary Long Wavelength X-Ray Data</h3>
Check to display long wavelength (0.1-0.8nm) X-Ray data from the primary GOES satellite (Currently GOES 16) on the chart.
@ -68,7 +68,7 @@ The Y-axis indicates the flare classification. M and X class flares are those mo
![X-Ray data showing M class flare](../../../doc/img/SID_plugin_xray.png)
<h3>Display Secondary Long Wavelength X-Ray Data</h3>
<h3>8: Display Secondary Long Wavelength X-Ray Data</h3>
Check to display long wavelength (0.1-0.8nm) X-Ray data from the secondary GOES satellite (Currently GOES 18) on the chart.
Data from the secondary satellite may be useful when the primary is unavailable, such as when it is in eclipse.
@ -77,16 +77,16 @@ while in eclipse:
![X-Ray data during eclipse](../../../doc/img/SID_plugin_eclipse.png)
<h3>Display Primary Short Wavelength X-Ray Data</h3>
<h3>9: Display Primary Short Wavelength X-Ray Data</h3>
Check to display short wavelength (0.1-0.8nm) X-Ray data from the primary GOES satellite (Currently GOES 16) on the chart.
<h3>Display Secondary Short Wavelength X-Ray Data</h3>
<h3>10: Display Secondary Short Wavelength X-Ray Data</h3>
Check to display short wavelength (0.05-0.4nm) X-Ray data from the secondary GOES satellite (Currently GOES 18) on the chart.
Data from the secondary satellite may be useful when the primary is in eclipse.
<h3>Display Proton Flux</h3>
<h3>11: Display Proton Flux</h3>
Check to display 10 MeV and 100 MeV proton flux measurements from the primary GOES satellte on the chart.
A peak in the proton flux can occur one to three days after a CME (Coronal Mass Ejection) is directed towards Earth.
@ -94,30 +94,30 @@ Whereas X-rays from flares can impact any part of the ionosphere that are facing
the particles in the CME towards the poles, so a corresponding SID is most likely to be detected if you are receiving
a signal from a transmitter crossing the polar region.
<h3>Display GRBs</h3>
<h3>12: Display GRBs</h3>
Check to display Gamma Ray Bursts (GRB) on the chart. GRBs are plotted as a scatter plot. You can right click on a GRB to display the context
menu, which contains a number of links to additional data from the Fermi satellite for the GRB. The GRB data is not realtime, and it may take
up to 7 days for a GRB to appear in the data, so this is typically only useful for the analysis of historical data.
The context menu also has an item to display the location of the GRB in the [Sky Map](../../feature/skymap.readme.md) feature.
The context menu also has an item to display the location of the GRB in the [Sky Map](../../feature/skymap/readme.md) feature.
<h3>Display Solar Flares</h3>
<h3>13: Display Solar Flares</h3>
Check to display solar flares on the chart as record by the STIX X-ray instrument on the Solar Oribter satellite.
You can right click on a solar flare to display the context menu, which contains a number of links to additional data from the STIX instrument.
The solar flare data is not realtime and can sometimes be delayed by 24 hours.
<h3>Combined or Separate Charts</h3>
<h3>14: Combined or Separate Charts</h3>
When unchecked, data from [Channel Power]](../../channelrx/channelpower/readme.md) plugins is displayed on a separate chart to other data such as X-ray and proton flux and GRBs.
When unchecked, data from [Channel Power](../../channelrx/channelpower/readme.md) plugins is displayed on a separate chart to other data such as X-ray and proton flux and GRBs.
When checked, all data is displayed on a single combined chart.
<h3>Display Legend</h3>
<h3>15: Display Legend</h3>
Check to display a legend on the chart. When unchecked the legend will be hidden. You can click on items in the legend to temporarily hide and then show the corresponding series on the chart.
The position of the legend can be set in the Settings Dialog.
<h3>Open Settings Dialog</h3>
<h3>16: Open Settings Dialog</h3>
Click to open the Settings Dialog. The settings dialog allows a user to:
@ -128,7 +128,7 @@ Click to open the Settings Dialog. The settings dialog allows a user to:
- The filename is use for auto-save.
- Where the chart legend should be positioned.
<h3>Display SDO/SOHO Imagery</h3>
<h3>17: Display SDO/SOHO Imagery</h3>
When checked, displays imagary from NASA's SDO (Solar Dynamic Observatory) and ESA/NASA's SOHO (Solar and Heliospheric Observatory) satellites.
@ -136,11 +136,11 @@ SDOs images the Sun in a variety of UV and EUV wavelengths. SOHO shows images of
Solar flares are particularly visibible in the AIA 131 Å images.
<h3>Image or Video Selection</h3>
<h3>18: Image or Video Selection</h3>
Selects whether to display images (unchecked) or video (checked).
<h3>Image/Wavelength Selection</h3>
<h3>19: Image/Wavelength Selection</h3>
Selects which image / wavelength to view.
@ -166,60 +166,60 @@ Selects which image / wavelength to view.
* LASCO (Large Angle Spectrometric Coronagraph) shows solar corona. C2 shows corona up to 8.4Mkm. C3 shows corona up to 23Mkm.
<h3>Show GOES 16, 18 and SDO</h3>
<h3>20: Show GOES 16, 18 and SDO</h3>
When checked, opens a [Satellite Tracker](../../feature/satellitetracker/readme.md) feature and sets it to display data for the GOES 16, GOES 18 and SDO satellites.
The position and tracks of the satellites will then be visible on a [Map](../../feature/map/readme.md) feature.
<h3>Autoscale X</h3>
<h3>21: Autoscale X</h3>
When clicked, the chart X-axis is automatically scaled so that all power data is visible. When right-clicked, autoscaling of the X-axis will occur whenever new data is added to the chart.
<h3>Autoscale Y</h3>
<h3>22: Autoscale Y</h3>
When clicked, the chart Y-axis is automatically scaled so that all power data is visible. When right-clicked, autoscaling of the Y-axis will occur whenever new data is added to the chart.
<h3>Set X-axis to Today</h3>
<h3>23: Set X-axis to Today</h3>
When clicked, the X-axis is set to show today, from midnight to midnight.
When right-clicked, the X-axis is set to show sunrise to sunset. This uses latitude and longitude from Preferences > My position.
<h3>Set X-axis to -1 day</h3>
<h3>24: Set X-axis to -1 day</h3>
When clicked, the X-axis is set 1 day earlier than the current setting, at the same time.
<h3>Set X-axis to +1 day</h3>
<h3>25: Set X-axis to +1 day</h3>
When clicked, the X-axis is set 1 day later than the current setting, at the same time.
<h3>Start Time</h3>
<h3>26: Start Time</h3>
Displays/sets the current start time of the chart (X-axis minimum). It's possible to scroll through hours/days/months by clicking on the relevent segment and using the mouse scroll wheel.
<h3>End Time</h3>
<h3>27: End Time</h3>
Displays/sets the current end time of the chart (X-axis maximum). It's possible to scroll through hours/days/months by clicking on the relevent segment and using the mouse scroll wheel.
<h3>Min</h3>
<h3>28: Min</h3>
Displays/sets the minimum Y-axis value.
<h3>Max</h3>
<h3>29: Max</h3>
Displays/sets the maximum Y-axis value.
<h3>Now</h3>
<h3>30: Now</h3>
When checked, the latest SDO imagery is displayed. When unchecked, you can enter a date and time for which imagery should be displayed.
<h3>Date Time</h3>
<h3>31: Date Time</h3>
Specifies the date and time for which SDR imagery should be displayed. Images are updated every 15 minutes. The data and time can also be set by clicking on the chart.
<h3>Map</h3>
<h3>32: Map</h3>
Select a Map to link to the SID feature. When a time is selected on the SID charts, the Map feature will have it's time set accordingly.
Select a Map to link to the SID feature. When a time is selected on the SID charts, the [Map](../../feature/map/readme.md) feature will have it's time set accordingly.
This allows you, for example, to see the corresponding impact on MUF/foF2.
<h2>Tips</h2>
@ -228,7 +228,7 @@ In order to check that a peak in the spectrum is a real VLF signal, you can:
* If using a magnetic loop or other directional antenna, rotate it and make sure the amplitude varies, as mag loops should have a null orthogonal to the plane of the loop.
* Check that the signal has diurnal variation (it should vary with the time of day, due to the changes in the ionosphere).
* Check with online lists of VLF signals (E.g. https://sidstation.loudet.org/stations-list-en.xhtml or https://www.mwlist.org/vlf.php). A number of these are plotted on the Map feature.
* Check with online lists of VLF signals (E.g. https://sidstation.loudet.org/stations-list-en.xhtml or https://www.mwlist.org/vlf.php). A number of these are plotted on the [Map](../../feature/map/readme.md) feature.
Occasionally, the X-ray flux data may drop to 0. This is typically when the GOES satellite is in eclipse (The Earth or moon is inbetween the satellite and the Sun).