Skip to content

Commit

Permalink
📚 Update documentation
Browse files Browse the repository at this point in the history
  • Loading branch information
@ronisbr
ronisbr committed Aug 17, 2023
1 parent 474b4ec commit 9d4016c
Show file tree
Hide file tree
Showing 2 changed files with 48 additions and 48 deletions.
48 changes: 24 additions & 24 deletions README.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -19,30 +19,30 @@ The space index sets supported in this version are:

Those sets provide the following indices:

| **Space Index Set** | **Index** | **Description** | **Unit** |
|:--------------------|:----------------------|:---------------------------------------------------------------|:--------------------|
| `SW-All.csv` | `F10obs` | Observed F10.7 (10.7-cm solar flux). | 10⁻²² W / (M² ⋅ Hz) |
| | `F10osb_avg_center81` | Observed F10.7 averaged over 81 days centered for the instant. | 10⁻²² W / (M² ⋅ Hz) |
| | `F10osb_avg_last81` | Observed F10.7 averaged over the last 81 days. | 10⁻²² W / (M² ⋅ Hz) |
| | `F10adj` | Adjusted F10.7 (10.7-cm solar flux). | 10⁻²² W / (M² ⋅ Hz) |
| | `F10adj_avg_center81` | Adjusted F10.7 averaged over 81 days centered for the instant. | 10⁻²² W / (M² ⋅ Hz) |
| | `F10adj_avg_last81` | Adjusted F10.7 averaged over the last 81 days. | 10⁻²² W / (M² ⋅ Hz) |
| | `Ap` | Ap index computed every three hours. | |
| | `Ap_daily` | Daily Ap index. | |
| | `Kp` | Kp index computed every three hours. | |
| | `Kp_daily` | Daily Kp index. | |
| | `BSRN` | BSRN index. | |
| | `ND` | ND index. | |
| | `Cp` | Cp index. | |
| | `C9` | C9 index. | |
| | `ISN` | ISN index. | |
| `JB2008` | `DTC` | Exospheric temperature variation caused by the Dst index. | K |
| | `S10` | EUV index (26-34 nm) scaled to F10.7 | 10⁻²² W / (M² ⋅ Hz) |
| | `M10` | MG2 index scaled to F10.7. | 10⁻²² W / (M² ⋅ Hz) |
| | `Y10` | Solar X-ray & Lya index scaled to F10.7 | 10⁻²² W / (M² ⋅ Hz) |
| | `S81a` | 81-day averaged EUV index (26-34 nm) scaled to F10.7 | 10⁻²² W / (M² ⋅ Hz) |
| | `M81a` | 81-day averaged MG2 index scaled to F10.7. | 10⁻²² W / (M² ⋅ Hz) |
| | `Y81a` | 81-day averaged solar X-ray & Lya index scaled to F10.7 | 10⁻²² W / (M² ⋅ Hz) |
| **Space Index Set** | **Index** | **Description** | **Unit** |
|:--------------------|:----------------------|:-------------------------------------------------------------------|:--------------------|
| `Celestrak` | `F10obs` | Observed F10.7 (10.7-cm solar flux) | 10⁻²² W / (M² ⋅ Hz) |
| | `F10obs_avg_center81` | Observed F10.7 (10.7-cm solar flux) averaged over 81 days centered | 10⁻²² W / (M² ⋅ Hz) |
| | `F10obs_avg_last81` | Observed F10.7 (10.7-cm solar flux) averaged over 81 last days | 10⁻²² W / (M² ⋅ Hz) |
| | `F10adj` | Adjusted F10.7 (10.7-cm solar flux) | 10⁻²² W / (M² ⋅ Hz) |
| | `F10adj_avg_center81` | Observed F10.7 (10.7-cm solar flux) averaged over 81 days centered | 10⁻²² W / (M² ⋅ Hz) |
| | `F10adj_avg_last81` | Observed F10.7 (10.7-cm solar flux) averaged over 81 last days | 10⁻²² W / (M² ⋅ Hz) |
| | `Ap` | Ap index computed every three hours | |
| | `Ap_daily` | Daily Ap index | |
| | `Kp` | Kp index computed every three hours | |
| | `Kp_daily` | Daily Kp index | |
| | `Cp` | Daily planetary character figure | |
| | `C9` | Daily magnetic index on Cp basis | |
| | `ISN` | International sunspot number | |
| | `BSRN` | Bartels solar rotation number | |
| | `ND` | Number of Days into Bartels Solar Rotation Cycle | Days |
| `JB2008` | `DTC` | Exospheric temperature variation caused by the Dst index | K |
| | `S10` | EUV index (26-34 nm) scaled to F10.7 | 10⁻²² W / (M² ⋅ Hz) |
| | `M10` | MG2 index scaled to F10.7 | 10⁻²² W / (M² ⋅ Hz) |
| | `Y10` | Solar X-ray & Lya index scaled to F10.7 | 10⁻²² W / (M² ⋅ Hz) |
| | `S81a` | 81-day averaged EUV index (26-34 nm) scaled to F10.7 | 10⁻²² W / (M² ⋅ Hz) |
| | `M81a` | 81-day averaged MG2 index scaled to F10.7 | 10⁻²² W / (M² ⋅ Hz) |
| | `Y81a` | 81-day averaged solar X-ray & Lya index scaled to F10.7 | 10⁻²² W / (M² ⋅ Hz) |

## Installation

Expand Down
48 changes: 24 additions & 24 deletions docs/src/man/get.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -32,28 +32,28 @@ julia> space_index(Val(:F10adj), 2.4590195e6)

The following space indices are currently supported:

| **Space Index Set** | **Index** | **Description** | **Unit** |
|:--------------------|:-----------------------|:-----------------------------------------------------------------------|:-------------------|
| `Celestrak` | `F10obs` | Observed F10.7 (10.7-cm solar flux) | 10⁻²² W / (M² ⋅ Hz) |
| | `F10adj` | Adjusted F10.7 (10.7-cm solar flux) | 10⁻²² W / (M² ⋅ Hz) |
| | `f107_obs_avg_center81`| Observed F10.7 (10.7-cm solar flux) averaged over 81 days centered | 10⁻²² W / (M² ⋅ Hz) |
| | `f107_obs_avg_last81` | Observed F10.7 (10.7-cm solar flux) averaged over 81 last days | 10⁻²² W / (M² ⋅ Hz) |
| | `f107_adj_avg_center81`| Observed F10.7 (10.7-cm solar flux) averaged over 81 days centered | 10⁻²² W / (M² ⋅ Hz) |
| | `f107_adj_avg_last81` | Observed F10.7 (10.7-cm solar flux) averaged over 81 last days | 10⁻²² W / (M² ⋅ Hz) |
| | `Ap` | Ap index computed every three hours. | |
| | `Ap_daily` | Daily Ap index. | |
| | `Kp` | Kp index computed every three hours. | |
| | `Kp_daily` | Daily Kp index. | |
| | `Cp` | Daily Planetary Character Figure | |
| | `C9` | Daily Magnetic Index on Cp Basis | |
| | `ISN` | International Sunspot Number | |
| | `BSRN` | Bartels Solar Rotation Number | |
| | `ND` | Number of Days into Bartels Solar Rotation Cycle | Days |
| `JB2008` | `DTC` | Exospheric temperature variation caused by the Dst index. | K |
| | `S10` | EUV index (26-34 nm) scaled to F10.7 | 10⁻²² W / (M² ⋅ Hz) |
| | `M10` | MG2 index scaled to F10.7. | 10⁻²² W / (M² ⋅ Hz) |
| | `Y10` | Solar X-ray & Lya index scaled to F10.7 | 10⁻²² W / (M² ⋅ Hz) |
| | `S81a` | 81-day averaged EUV index (26-34 nm) scaled to F10.7 | 10⁻²² W / (M² ⋅ Hz) |
| | `M81a` | 81-day averaged MG2 index scaled to F10.7. | 10⁻²² W / (M² ⋅ Hz) |
| | `Y81a` | 81-day averaged solar X-ray & Lya index scaled to F10.7 | 10⁻²² W / (M² ⋅ Hz) |
| **Space Index Set** | **Index** | **Description** | **Unit** |
|:--------------------|:----------------------|:-------------------------------------------------------------------|:--------------------|
| `Celestrak` | `F10obs` | Observed F10.7 (10.7-cm solar flux) | 10⁻²² W / (M² ⋅ Hz) |
| | `F10obs_avg_center81` | Observed F10.7 (10.7-cm solar flux) averaged over 81 days centered | 10⁻²² W / (M² ⋅ Hz) |
| | `F10obs_avg_last81` | Observed F10.7 (10.7-cm solar flux) averaged over 81 last days | 10⁻²² W / (M² ⋅ Hz) |
| | `F10adj` | Adjusted F10.7 (10.7-cm solar flux) | 10⁻²² W / (M² ⋅ Hz) |
| | `F10adj_avg_center81` | Observed F10.7 (10.7-cm solar flux) averaged over 81 days centered | 10⁻²² W / (M² ⋅ Hz) |
| | `F10adj_avg_last81` | Observed F10.7 (10.7-cm solar flux) averaged over 81 last days | 10⁻²² W / (M² ⋅ Hz) |
| | `Ap` | Ap index computed every three hours | |
| | `Ap_daily` | Daily Ap index | |
| | `Kp` | Kp index computed every three hours | |
| | `Kp_daily` | Daily Kp index | |
| | `Cp` | Daily planetary character figure | |
| | `C9` | Daily magnetic index on Cp basis | |
| | `ISN` | International sunspot number | |
| | `BSRN` | Bartels solar rotation number | |
| | `ND` | Number of Days into Bartels Solar Rotation Cycle | Days |
| `JB2008` | `DTC` | Exospheric temperature variation caused by the Dst index | K |
| | `S10` | EUV index (26-34 nm) scaled to F10.7 | 10⁻²² W / (M² ⋅ Hz) |
| | `M10` | MG2 index scaled to F10.7 | 10⁻²² W / (M² ⋅ Hz) |
| | `Y10` | Solar X-ray & Lya index scaled to F10.7 | 10⁻²² W / (M² ⋅ Hz) |
| | `S81a` | 81-day averaged EUV index (26-34 nm) scaled to F10.7 | 10⁻²² W / (M² ⋅ Hz) |
| | `M81a` | 81-day averaged MG2 index scaled to F10.7 | 10⁻²² W / (M² ⋅ Hz) |
| | `Y81a` | 81-day averaged solar X-ray & Lya index scaled to F10.7 | 10⁻²² W / (M² ⋅ Hz) |

0 comments on commit 9d4016c

Please sign in to comment.