From cf2244048699d513800ec8849ce838b0676902d4 Mon Sep 17 00:00:00 2001 From: "Documenter.jl" Date: Thu, 17 Aug 2023 13:24:43 +0000 Subject: [PATCH] build based on e266cfa --- dev/index.html | 4 ++-- dev/lib/library/index.html | 4 ++-- dev/man/api/index.html | 4 ++-- dev/man/get/index.html | 4 ++-- dev/man/initialization/index.html | 4 ++-- dev/man/quick_start/index.html | 4 ++-- dev/search/index.html | 2 +- 7 files changed, 13 insertions(+), 13 deletions(-) diff --git a/dev/index.html b/dev/index.html index d1adf97..d15ab31 100644 --- a/dev/index.html +++ b/dev/index.html @@ -1,3 +1,3 @@ -Home · Space Indices
Edit on GitHub

SpaceIndices.jl

This package allows to automatically fetch and parse space indices.

The space index sets supported in this version are:

Space Index SetFileExpiry periodInformation
CelestrakSW-All.csv1 dayF10.7, AP, KP, ISN, C9, Cp, ND, BSRN (historic and predicted).
JB2008DTCFILE.TXT1 dayExospheric temperature variation caused by the Dst index.
SOLFSMY.TXT1 dayIndices necessary for the JB2008 atmospheric model.

Installation

This package can be installed using:

julia> using Pkg
-julia> Pkg.add("SpaceIndices")
+Home · SpaceIndices.jl
Edit on GitHub

SpaceIndices.jl

This package allows to automatically fetch and parse space indices.

The space index sets supported in this version are:

Space Index SetFileExpiry periodInformation
CelestrakSW-All.csv1 dayF10.7, AP, KP, ISN, C9, Cp, ND, BSRN (historic and predicted).
JB2008DTCFILE.TXT1 dayExospheric temperature variation caused by the Dst index.
SOLFSMY.TXT1 dayIndices necessary for the JB2008 atmospheric model.

Installation

This package can be installed using:

julia> using Pkg
+julia> Pkg.add("SpaceIndices")
diff --git a/dev/lib/library/index.html b/dev/lib/library/index.html index 031d010..ee6edc9 100644 --- a/dev/lib/library/index.html +++ b/dev/lib/library/index.html @@ -1,3 +1,3 @@ -Library · Space Indices
Edit on GitHub

Library

Documentation for SpaceIndices.jl.

SpaceIndices._round_Kp — Method
_round_Kp(x::Float64)

Celestrak mulitples Kp by 10 and rounds to the nearest integer this puts it back.

source
SpaceIndices.constant_interpolation — Method
constant_interpolation(knots::Vector{Date}, values::AbstractVector, x::Date) -> eltype(values)

Perform a constant interpolation at x of values evaluated at knots. The interpolation returns value(knots[k-1]) in which knots[k-1] <= x < knots[k].

source
SpaceIndices.expiry_periods — Function
expiry_periods(::Type{T}) where T<:SpaceIndexSet -> Vector{DatePeriod}

Return the expiry periods for the remote files associated with the space index set T. If a time interval greater than this period has elapsed since the last download, the remote files will be downloaded again.

source
SpaceIndices.filenames — Method
filenames(::Type{T}) where T<:SpaceIndexSet -> Vector{String}

Return the filenames for the remote files associated with the space index set T. If this function is not defined for T, the filenames will be obtained based on the URLs.

source
SpaceIndices.init — Method
init(; blocklist::Vector = []) -> Nothing

Initialize all the registered space index sets.

This function will download the remote files associated to the space index sets if they do not exist or if the expiry period has been elapsed. Aftward, it will parse the files and populate the objects to be accessed by the function space_index.

If the user does not want to initialize some sets, they can pass them in the keyword blocklist.

source
SpaceIndices.init — Method
init(::Type{T}; kwargs...) where T<:SpaceIndexSet -> Nothing

Initialize the space index set T.

This function will download the remote files associated with the space index set T if they do not exist or if their expiry period has been elapsed. Aftward, it will parse the files and populate the object to be accessed by the function space_index.

Keywords

  • force_download::Bool: If true, the remote files will be downloaded regardless of their timestamps. (Default = false)
source
SpaceIndices.linear_interpolation — Method
linear_interpolation(knots::AbstractVector{Tk}, values::AbstractVector{Tv}, x::Tk) where {Tk, Tv}

Perform a linear interpolation at x of values evaluated at knots.

source
SpaceIndices.parse_files — Function
parse_files(::Type{T}, filepaths::Vector{String}) where T<:SpaceIndexSet -> T

Parse the files associated with the space index set T using the files in filepaths. It must return an object of type T with the parsed data.

source
SpaceIndices.space_index — Function
space_index(::Val{:index}, jd::Number; kwargs...) -> Number
-space_index(::Val{:index}, instant::DateTime; kwargs...) -> Number

Get the space index for the Julian day jd or the instant. The latter must be an object of type DateTime. kwargs... can be used to pass additional configuration for the space index.

source
SpaceIndices.space_index — Method
space_index(::Val{:Ap}, instant::DateTime) -> NTuple{8, Float64}

Get the Ap index for the day at instant compute every three hours.

source
SpaceIndices.space_index — Method
space_index(::Val{:DTC}, instant::DateTime) -> Float64

Get the exospheric temperature variation [K] caused by the Dst index at instant (UTC).

source
SpaceIndices.space_index — Method
space_index(::Val{:F10adj_avg_center81}, instant::DateTime) -> Float64

Get the adjusted F10.7 index (10.7-cm solar flux) [10⁻²² W / (M² ⋅ Hz)] averaged over 81 days centered for the instant (UTC).

source
SpaceIndices.space_index — Method
space_index(::Val{:F10adj_avg_last81}, instant::DateTime) -> Float64

Get the adjusted F10.7 index (10.7-cm solar flux) [10⁻²² W / (M² ⋅ Hz)] averaged over the last 81 days from the instant (UTC).

source
SpaceIndices.space_index — Method
space_index(::Val{:F10adj}, instant::DateTime) -> Float64

Get the adjusted F10.7 index (10.7-cm solar flux) [10⁻²² W / (M² ⋅ Hz)] for the instant (UTC).

source
SpaceIndices.space_index — Method
space_index(::Val{:F10obs_avg_center81}, instant::DateTime) -> Float64

Get the observed F10.7 index (10.7-cm solar flux) [10⁻²² W / (M² ⋅ Hz)] averaged over 81 days centered for the instant (UTC).

source
SpaceIndices.space_index — Method
space_index(::Val{:F10obs_avg_last81}, instant::DateTime) -> Float64

Get the observed F10.7 index (10.7-cm solar flux) [10⁻²² W / (M² ⋅ Hz)] averaged over the last 81 days from the instant (UTC).

source
SpaceIndices.space_index — Method
space_index(::Val{:F10obs}, instant::DateTime) -> Float64

Get the observed F10.7 index (10.7-cm solar flux) [10⁻²² W / (M² ⋅ Hz)] for the instant (UTC).

source
SpaceIndices.space_index — Method
space_index(::Val{:Kp}, instant::DateTime) -> NTuple{8, Float64}

Get the Kp index for the day at instant compute every three hours.

source
SpaceIndices.space_index — Method
get_space_index(::Val{:M10}, instant::DateTime) -> Float64

Get the MG2 index scaled to F10.7 [10⁻²² W / (M² ⋅ Hz)] for the instant (UTC).

source
SpaceIndices.space_index — Method
space_index(::Val{:M81a}, instant::DateTime) -> Float64

Get the 81-day averaged MG2 index scaled to F10.7 [10⁻²² W / (M² ⋅ Hz)] for the instant (UTC).

source
SpaceIndices.space_index — Method
space_index(::Val{:S10}, instant::DateTime) -> Float64

Get the EUV index (26-34 nm) scaled to F10.7 [10⁻²² W / (M² ⋅ Hz)] for the instant (UTC).

source
SpaceIndices.space_index — Method
space_index(::Val{:S81a}, instant::DateTime) -> Float64

Get the 81-day averaged EUV index (26-34 nm) scaled to F10.7 [10⁻²² W / (M² ⋅ Hz)] for the instant (UTC).

source
SpaceIndices.space_index — Method
space_index(::Val{:Y10}, instant::DateTime) -> Float64

Get the solar X-ray & Lya index scaled to F10.7 [10⁻²² W / (M² ⋅ Hz)] for the instant (UTC).

source
SpaceIndices.space_index — Method
space_index(::Val{:Y81a}, instant::DateTime) -> Float64

Get the 81-day averaged solar X-ray & Lya index scaled to F10.7 [10⁻²² W / (M² ⋅ Hz)] for the instant (UTC).

source
SpaceIndices.urls — Function
urls(::Type{T}) where T<:SpaceIndexSet -> Vector{String}

Return the URLs to fetch the remote files associated with the space index set T.

source
SpaceIndices.@data_handler — Macro
@data_handler(T)

Return the optional data handler associated with space index set T. This variable stores an instance of T if the set was already initialized.

source
SpaceIndices.@object — Macro
@object(T)

Return the object associated with the space index set T.

Throws

  • Error: If the space index T was not initialized.
source
SpaceIndices.@register — Macro
@register(T)

Register the the space index set T. This macro push the data into the global vector of space files and also creates the optional data handler for the processed structure.

source
+Library · SpaceIndices.jl
Edit on GitHub

Library

Documentation for SpaceIndices.jl.

SpaceIndices._round_Kp — Method
_round_Kp(x::Float64)

Celestrak mulitples Kp by 10 and rounds to the nearest integer this puts it back.

source
SpaceIndices.constant_interpolation — Method
constant_interpolation(knots::Vector{Date}, values::AbstractVector, x::Date) -> eltype(values)

Perform a constant interpolation at x of values evaluated at knots. The interpolation returns value(knots[k-1]) in which knots[k-1] <= x < knots[k].

source
SpaceIndices.expiry_periods — Function
expiry_periods(::Type{T}) where T<:SpaceIndexSet -> Vector{DatePeriod}

Return the expiry periods for the remote files associated with the space index set T. If a time interval greater than this period has elapsed since the last download, the remote files will be downloaded again.

source
SpaceIndices.filenames — Method
filenames(::Type{T}) where T<:SpaceIndexSet -> Vector{String}

Return the filenames for the remote files associated with the space index set T. If this function is not defined for T, the filenames will be obtained based on the URLs.

source
SpaceIndices.init — Method
init(; blocklist::Vector = []) -> Nothing

Initialize all the registered space index sets.

This function will download the remote files associated to the space index sets if they do not exist or if the expiry period has been elapsed. Aftward, it will parse the files and populate the objects to be accessed by the function space_index.

If the user does not want to initialize some sets, they can pass them in the keyword blocklist.

source
SpaceIndices.init — Method
init(::Type{T}; kwargs...) where T<:SpaceIndexSet -> Nothing

Initialize the space index set T.

This function will download the remote files associated with the space index set T if they do not exist or if their expiry period has been elapsed. Aftward, it will parse the files and populate the object to be accessed by the function space_index.

Keywords

  • force_download::Bool: If true, the remote files will be downloaded regardless of their timestamps. (Default = false)
source
SpaceIndices.linear_interpolation — Method
linear_interpolation(knots::AbstractVector{Tk}, values::AbstractVector{Tv}, x::Tk) where {Tk, Tv}

Perform a linear interpolation at x of values evaluated at knots.

source
SpaceIndices.parse_files — Function
parse_files(::Type{T}, filepaths::Vector{String}) where T<:SpaceIndexSet -> T

Parse the files associated with the space index set T using the files in filepaths. It must return an object of type T with the parsed data.

source
SpaceIndices.space_index — Function
space_index(::Val{:index}, jd::Number; kwargs...) -> Number
+space_index(::Val{:index}, instant::DateTime; kwargs...) -> Number

Get the space index for the Julian day jd or the instant. The latter must be an object of type DateTime. kwargs... can be used to pass additional configuration for the space index.

source
SpaceIndices.space_index — Method
space_index(::Val{:Ap}, instant::DateTime) -> NTuple{8, Float64}

Get the Ap index for the day at instant compute every three hours.

source
SpaceIndices.space_index — Method
space_index(::Val{:DTC}, instant::DateTime) -> Float64

Get the exospheric temperature variation [K] caused by the Dst index at instant (UTC).

source
SpaceIndices.space_index — Method
space_index(::Val{:F10adj_avg_center81}, instant::DateTime) -> Float64

Get the adjusted F10.7 index (10.7-cm solar flux) [10⁻²² W / (M² ⋅ Hz)] averaged over 81 days centered for the instant (UTC).

source
SpaceIndices.space_index — Method
space_index(::Val{:F10adj_avg_last81}, instant::DateTime) -> Float64

Get the adjusted F10.7 index (10.7-cm solar flux) [10⁻²² W / (M² ⋅ Hz)] averaged over the last 81 days from the instant (UTC).

source
SpaceIndices.space_index — Method
space_index(::Val{:F10adj}, instant::DateTime) -> Float64

Get the adjusted F10.7 index (10.7-cm solar flux) [10⁻²² W / (M² ⋅ Hz)] for the instant (UTC).

source
SpaceIndices.space_index — Method
space_index(::Val{:F10obs_avg_center81}, instant::DateTime) -> Float64

Get the observed F10.7 index (10.7-cm solar flux) [10⁻²² W / (M² ⋅ Hz)] averaged over 81 days centered for the instant (UTC).

source
SpaceIndices.space_index — Method
space_index(::Val{:F10obs_avg_last81}, instant::DateTime) -> Float64

Get the observed F10.7 index (10.7-cm solar flux) [10⁻²² W / (M² ⋅ Hz)] averaged over the last 81 days from the instant (UTC).

source
SpaceIndices.space_index — Method
space_index(::Val{:F10obs}, instant::DateTime) -> Float64

Get the observed F10.7 index (10.7-cm solar flux) [10⁻²² W / (M² ⋅ Hz)] for the instant (UTC).

source
SpaceIndices.space_index — Method
space_index(::Val{:Kp}, instant::DateTime) -> NTuple{8, Float64}

Get the Kp index for the day at instant compute every three hours.

source
SpaceIndices.space_index — Method
get_space_index(::Val{:M10}, instant::DateTime) -> Float64

Get the MG2 index scaled to F10.7 [10⁻²² W / (M² ⋅ Hz)] for the instant (UTC).

source
SpaceIndices.space_index — Method
space_index(::Val{:M81a}, instant::DateTime) -> Float64

Get the 81-day averaged MG2 index scaled to F10.7 [10⁻²² W / (M² ⋅ Hz)] for the instant (UTC).

source
SpaceIndices.space_index — Method
space_index(::Val{:S10}, instant::DateTime) -> Float64

Get the EUV index (26-34 nm) scaled to F10.7 [10⁻²² W / (M² ⋅ Hz)] for the instant (UTC).

source
SpaceIndices.space_index — Method
space_index(::Val{:S81a}, instant::DateTime) -> Float64

Get the 81-day averaged EUV index (26-34 nm) scaled to F10.7 [10⁻²² W / (M² ⋅ Hz)] for the instant (UTC).

source
SpaceIndices.space_index — Method
space_index(::Val{:Y10}, instant::DateTime) -> Float64

Get the solar X-ray & Lya index scaled to F10.7 [10⁻²² W / (M² ⋅ Hz)] for the instant (UTC).

source
SpaceIndices.space_index — Method
space_index(::Val{:Y81a}, instant::DateTime) -> Float64

Get the 81-day averaged solar X-ray & Lya index scaled to F10.7 [10⁻²² W / (M² ⋅ Hz)] for the instant (UTC).

source
SpaceIndices.urls — Function
urls(::Type{T}) where T<:SpaceIndexSet -> Vector{String}

Return the URLs to fetch the remote files associated with the space index set T.

source
SpaceIndices.@data_handler — Macro
@data_handler(T)

Return the optional data handler associated with space index set T. This variable stores an instance of T if the set was already initialized.

source
SpaceIndices.@object — Macro
@object(T)

Return the object associated with the space index set T.

Throws

  • Error: If the space index T was not initialized.
source
SpaceIndices.@register — Macro
@register(T)

Register the the space index set T. This macro push the data into the global vector of space files and also creates the optional data handler for the processed structure.

source
diff --git a/dev/man/api/index.html b/dev/man/api/index.html index 1210857..5e64d4f 100644 --- a/dev/man/api/index.html +++ b/dev/man/api/index.html @@ -1,5 +1,5 @@ -API · Space Indices
Edit on GitHub

SpaceIndices.jl API

This package defines an API to allow user to defin new space indices. We describe this API in the following.

Structure

Each space index set must have a structure that has SpaceIndexSet as its super-type. This structure must contain all the required field to process and return the indices provided by the set.

struct MySpaceIndex <: SpaceIndexSet
+API · SpaceIndices.jl
Edit on GitHub
SpaceIndices.jl API
This package defines an API to allow user to defin new space indices. We describe this API in the following.
Structure
Each space index set must have a structure that has SpaceIndexSet as its super-type. This structure must contain all the required field to process and return the indices provided by the set.
struct MySpaceIndex <: SpaceIndexSet
     ...
 end
Required API Functions
We must define the following functions for every space index set defined as in the previous section.
function SpaceIndices.urls(::Type{T}) where T<:SpaceIndexFile -> Vector{String}
This function must return a Vector{String} with the URLs to download the files for the indices. For example:
SpaceIndices.urls(::Type{MySpaceIndex}) = ["https://url.for.my/space.file.txt"]
function SpaceIndices.expiry_periods(::Type{T}) where T<:SpaceIndexFile -> Vector{DatePeriod}
This function must return the list with the expiry periods for the files in the space index set T. The remote files will always be downloaded if a time greater than this period has elapsed after the last download. For example:
get_filenames(::Type{MySpaceIndex}) = [Day(7)]
SpaceIndices.parse_files(::Type{T}, filepaths::Vector{String}) where T<:SpaceIndexFile -> T
This function must parse the files related to the space index set T using the files in filepaths and return an instance of T with the parsed data. For example,
function SpaceIndices.parse_files(::Type{MySpaceIndex}, filepaths::Vector{String})
     for filepath in filepaths
@@ -40,4 +40,4 @@
 [ Info: Downloading the file 'SW-All.csv' from 'https://celestrak.org/SpaceData/SW-All.csv'...
 
 julia> space_index(Val(:LeapSeconds), now())
-37.0

+37.0
diff --git a/dev/man/get/index.html b/dev/man/get/index.html index cedd17c..c0ce9d2 100644 --- a/dev/man/get/index.html +++ b/dev/man/get/index.html @@ -1,9 +1,9 @@ -Get space indices · Space Indices
Edit on GitHub

Obtaining the Space Indices

After the initialization shown in Initialization of Space Indices, the user can obtain the space index value using the function:

function space_index(::Val{:index}, jd::Number; kwargs...) -> Number
+Get space indices · SpaceIndices.jl
Edit on GitHub
Obtaining the Space Indices
After the initialization shown in Initialization of Space Indices, the user can obtain the space index value using the function:
function space_index(::Val{:index}, jd::Number; kwargs...) -> Number
 function space_index(::Val{:index}, instant::DateTime; kwargs...) -> Number
where index is the desired space index and jd is the Julian Day to obtain the information. The latter can also be specified using instant, which is a DateTime object.
julia> SpaceIndices.init()
 
 julia> space_index(Val(:F10adj), DateTime(2020, 6, 19))
 71.1
 
 julia> space_index(Val(:F10adj), 2.4590195e6)
-71.1
The following space indices are currently supported:
Space Index SetIndexDescriptionUnit
CelestrakF10obsObserved F10.7 (10.7-cm solar flux)10⁻²² W / (M² ⋅ Hz)
F10obs_avg_center81Observed F10.7 (10.7-cm solar flux) averaged over 81 days centered10⁻²² W / (M² ⋅ Hz)
F10obs_avg_last81Observed F10.7 (10.7-cm solar flux) averaged over 81 last days10⁻²² W / (M² ⋅ Hz)
F10adjAdjusted F10.7 (10.7-cm solar flux)10⁻²² W / (M² ⋅ Hz)
F10adj_avg_center81Observed F10.7 (10.7-cm solar flux) averaged over 81 days centered10⁻²² W / (M² ⋅ Hz)
F10adj_avg_last81Observed F10.7 (10.7-cm solar flux) averaged over 81 last days10⁻²² W / (M² ⋅ Hz)
ApAp index computed every three hours
Ap_dailyDaily Ap index
KpKp index computed every three hours
Kp_dailyDaily Kp index
CpDaily planetary character figure
C9Daily magnetic index on Cp basis
ISNInternational sunspot number
BSRNBartels solar rotation number
NDNumber of days into Bartels solar rotation cycleDays
JB2008DTCExospheric temperature variation caused by the Dst indexK
S10EUV index (26-34 nm) scaled to F10.710⁻²² W / (M² ⋅ Hz)
M10MG2 index scaled to F10.710⁻²² W / (M² ⋅ Hz)
Y10Solar X-ray & Lya index scaled to F10.710⁻²² W / (M² ⋅ Hz)
S81a81-day averaged EUV index (26-34 nm) scaled to F10.710⁻²² W / (M² ⋅ Hz)
M81a81-day averaged MG2 index scaled to F10.710⁻²² W / (M² ⋅ Hz)
Y81a81-day averaged solar X-ray & Lya index scaled to F10.710⁻²² W / (M² ⋅ Hz)

+71.1

The following space indices are currently supported:

Space Index SetIndexDescriptionUnit
CelestrakF10obsObserved F10.7 (10.7-cm solar flux)10⁻²² W / (M² ⋅ Hz)
F10obs_avg_center81Observed F10.7 (10.7-cm solar flux) averaged over 81 days centered10⁻²² W / (M² ⋅ Hz)
F10obs_avg_last81Observed F10.7 (10.7-cm solar flux) averaged over 81 last days10⁻²² W / (M² ⋅ Hz)
F10adjAdjusted F10.7 (10.7-cm solar flux)10⁻²² W / (M² ⋅ Hz)
F10adj_avg_center81Observed F10.7 (10.7-cm solar flux) averaged over 81 days centered10⁻²² W / (M² ⋅ Hz)
F10adj_avg_last81Observed F10.7 (10.7-cm solar flux) averaged over 81 last days10⁻²² W / (M² ⋅ Hz)
ApAp index computed every three hours
Ap_dailyDaily Ap index
KpKp index computed every three hours
Kp_dailyDaily Kp index
CpDaily planetary character figure
C9Daily magnetic index on Cp basis
ISNInternational sunspot number
BSRNBartels solar rotation number
NDNumber of days into Bartels solar rotation cycleDays
JB2008DTCExospheric temperature variation caused by the Dst indexK
S10EUV index (26-34 nm) scaled to F10.710⁻²² W / (M² ⋅ Hz)
M10MG2 index scaled to F10.710⁻²² W / (M² ⋅ Hz)
Y10Solar X-ray & Lya index scaled to F10.710⁻²² W / (M² ⋅ Hz)
S81a81-day averaged EUV index (26-34 nm) scaled to F10.710⁻²² W / (M² ⋅ Hz)
M81a81-day averaged MG2 index scaled to F10.710⁻²² W / (M² ⋅ Hz)
Y81a81-day averaged solar X-ray & Lya index scaled to F10.710⁻²² W / (M² ⋅ Hz)
diff --git a/dev/man/initialization/index.html b/dev/man/initialization/index.html index bd979aa..213b87a 100644 --- a/dev/man/initialization/index.html +++ b/dev/man/initialization/index.html @@ -1,6 +1,6 @@ -Initialization · Space Indices
Edit on GitHub

Initialization of Space Indices

The files of all the registered space indices can be automatically downloaded using:

function SpaceIndices.init(; kwargs...) -> Nothing

If a file exists, the function checks if its expiry period has passed. If so, it downloads the file again.

julia> SpaceIndices.init()

If the user does not want to download a set of space indices, they can pass them in the keyword blocklist to the function SpaceIndices.init.

julia> SpaceIndices.init(; blocklist = [SpaceIndices.Celestrak])

If the user wants to initialize only one space index set, they can pass it to the same function:

function SpaceIndices.init(::Type{T}; force_download::Bool = true) where T<:SpaceIndexSet -> Nothing

where T must be the space index set. In this case, the user have access to the keyword force_download. If it is true, the remote files will be download regardless their timestamp.

julia> SpaceIndices.init()
+Initialization · SpaceIndices.jl
Edit on GitHub
Initialization of Space Indices
The files of all the registered space indices can be automatically downloaded using:
function SpaceIndices.init(; kwargs...) -> Nothing
If a file exists, the function checks if its expiry period has passed. If so, it downloads the file again.
julia> SpaceIndices.init()
If the user does not want to download a set of space indices, they can pass them in the keyword blocklist to the function SpaceIndices.init.
julia> SpaceIndices.init(; blocklist = [SpaceIndices.Celestrak])
If the user wants to initialize only one space index set, they can pass it to the same function:
function SpaceIndices.init(::Type{T}; force_download::Bool = true) where T<:SpaceIndexSet -> Nothing
where T must be the space index set. In this case, the user have access to the keyword force_download. If it is true, the remote files will be download regardless their timestamp.
julia> SpaceIndices.init()
 [ Info: Downloading the file 'DTCFILE.TXT' from 'http://sol.spacenvironment.net/jb2008/indices/DTCFILE.TXT'...
 [ Info: Downloading the file 'SOLFSMY.TXT' from 'http://sol.spacenvironment.net/jb2008/indices/SOLFSMY.TXT'...
 [ Info: Downloading the file 'SW-All.csv' from 'https://celestrak.org/SpaceData/SW-All.csv'...
-

+
diff --git a/dev/man/quick_start/index.html b/dev/man/quick_start/index.html index ad12589..43927ac 100644 --- a/dev/man/quick_start/index.html +++ b/dev/man/quick_start/index.html @@ -1,6 +1,6 @@ -Quick start · Space Indices
Edit on GitHub

Quick Start

This quick tutorial will show how to use SpaceIndicies.jl to obtain the F10.7 index at 2020-06-19.

First, we need to initialize all the space indices:

julia> SpaceIndices.init()
+Quick start · SpaceIndices.jl
Edit on GitHub
Quick Start
This quick tutorial will show how to use SpaceIndicies.jl to obtain the F10.7 index at 2020-06-19.
First, we need to initialize all the space indices:
julia> SpaceIndices.init()
 [ Info: Downloading the file 'DTCFILE.TXT' from 'http://sol.spacenvironment.net/jb2008/indices/DTCFILE.TXT'...
 [ Info: Downloading the file 'SOLFSMY.TXT' from 'http://sol.spacenvironment.net/jb2008/indices/SOLFSMY.TXT'...
 [ Info: Downloading the file 'SW-All.csv' from 'https://celestrak.org/SpaceData/SW-All.csv'...
Afterward, we can obtain the desired space index using:
julia> space_index(Val(:F10adj), DateTime(2020, 6, 19))
-71.1

+71.1
diff --git a/dev/search/index.html b/dev/search/index.html index a310916..06a1df3 100644 --- a/dev/search/index.html +++ b/dev/search/index.html @@ -1,2 +1,2 @@ -Search · Space Indices

Loading search...

    +Search · SpaceIndices.jl

    Loading search...