spinifex.ionospheric.ionex_download

Utilities for downloading IONEX files from various servers.

Attributes

`_download_ionex`
`download_ionex`

Functions

`_download_ionex_coro`(→ list[pathlib.Path])	Download IONEX files from a server.
`chapman_format`(→ str)	Format a URL for an IRTG file from Chapman.
`download_from_cddis`(→ list[pathlib.Path])	Download IONEX files from CDDIS.
`download_from_chapman`(→ list[pathlib.Path])	Download IONEX files from Chapman.
`download_from_igsiono`(→ list[pathlib.Path])	Download IONEX files from IGSIONO.
`download_ionex_coro`(→ list[pathlib.Path])	Download IONEX files from a server.
`igsiono_format`(→ str)	Format a URL for an IGS IONO file from IGSIONO.
`new_cddis_format`(→ str)	Get the URL for a new IONEX file from CDDIS.
`old_cddis_format`(→ str)	Get the URL for an old IONEX file from CDDIS.
`should_use_new_cddis_format`(→ bool)	Determine if the new CDDIS format should be used.

Module Contents

async spinifex.ionospheric.ionex_download._download_ionex_coro(times: astropy.time.Time, options: spinifex.ionospheric.tec_data.IonexOptions | None = None) → list[pathlib.Path][source]

Download IONEX files from a server.

Parameters

timesTime: Times to download for.
optionsIonexOptions: Options for the ionex model.

Returns

list[Path]: List of downloaded files

Raises

IonexError: If the server is not supported.
NotImplementedError: If the server is not implemented yet.

spinifex.ionospheric.ionex_download.chapman_format(time: astropy.time.Time, prefix: str = 'uqr', url_stem: str | None = None) → str[source]

Format a URL for an IRTG file from Chapman.

Parameters

timeTime: Time to get the URL for.
prefixstr, optional: Ionex prefix, by default “irt”
url_stemstr | None, optional: URL stem, by default None

Returns

str: File URL

async spinifex.ionospheric.ionex_download.download_from_cddis(times: astropy.time.Time, prefix: str = 'cod', time_resolution: astropy.units.Quantity | None = None, url_stem: str | None = None, solution: spinifex.ionospheric.tec_data.SOLUTION = 'final', output_directory: pathlib.Path | None = None) → list[pathlib.Path][source]

Download IONEX files from CDDIS.

Parameters

timesTime: Times to download for.
prefixstr, optional: Analysis centre prefix, by default “cod”
time_resolutionu.Quantity | None, optional: Time resolution, by default None, will default to the server time resolution.
url_stemstr | None, optional: URL steam, by default None, will default to CDDIS.
solutionSOLUTION, optional: Solution type, by default “final”, must be “final” or “rapid”.
output_directoryPath | None, optional: Output directory path, by default None, will default to ionex_files in the current working directory.

Returns

list[Path]: List of downloaded files

async spinifex.ionospheric.ionex_download.download_from_chapman(times: astropy.time.Time, prefix: str = 'uqr', url_stem: str | None = None, output_directory: pathlib.Path | None = None) → list[pathlib.Path][source]

Download IONEX files from Chapman.

Parameters

timesTime: Times to download for.
prefixstr, optional: Ionex prefix, by default “irt”
url_stemstr | None, optional: URL stem, by default None
output_directoryPath | None, optional: Output directory path, by default None

Returns

list[Path]: List of downloaded file paths

Raises

IonexError: If the date is before 2021/024.

async spinifex.ionospheric.ionex_download.download_from_igsiono(times: astropy.time.Time, prefix: str = 'igs', time_resolution: astropy.units.Quantity | None = None, url_stem: str | None = None, solution: spinifex.ionospheric.tec_data.SOLUTION = 'final', output_directory: pathlib.Path | None = None) → list[pathlib.Path][source]

Download IONEX files from IGSIONO.

Parameters

timesTime: Times to download for.
prefixstr, optional: URL prefix, by default “igs”
time_resolutionu.Quantity | None, optional: Ionex resolution, by default None
url_stemstr | None, optional: URL stem, by default None
solutionSOLUTION, optional: Type of solution, by default “final”
output_directoryPath | None, optional: Output directory path, by default None

Returns

list[Path]: List of downloaded file paths

async spinifex.ionospheric.ionex_download.download_ionex_coro(times: astropy.time.Time, server: str = 'chapman', prefix: str = 'uqr', url_stem: str | None = None, time_resolution: astropy.units.Quantity | None = None, solution: spinifex.ionospheric.tec_data.SOLUTION = 'final', output_directory: pathlib.Path | None = None) → list[pathlib.Path][source]

Download IONEX files from a server.

Parameters

timesTime: Times to download for.
serverstr: Server to download from, by default “cddis”. Must be a supported server.
prefixstr, optional: Analysis centre prefix, by default “cod”. Must be a supported analysis centre.
url_stemstr | None, optional: URL stem, by default None, will default to the server URL.
time_resolutionu.Quantity | None, optional: Time resolution, by default None, will default to the server time resolution.
solutionSOLUTION, optional: Solution type, by default “final”, must be “final” or “rapid”.
output_directoryPath | None, optional: Output directory path, by default None, will default to ionex_files in the current working directory.

Returns

list[Path]: List of downloaded files

Raises

IonexError: If the server is not supported.
NotImplementedError: If the server is not implemented yet.

spinifex.ionospheric.ionex_download.igsiono_format(time: astropy.time.Time, prefix: str = 'igs', time_resolution: astropy.units.Quantity | None = None, url_stem: str | None = None, solution: spinifex.ionospheric.tec_data.SOLUTION = 'final') → str[source]

Format a URL for an IGS IONO file from IGSIONO.

Parameters

timeTime: Time to get the URL for.
prefixstr, optional: Ionex prefix, by default “igs”
time_resolutionu.Quantity | None, optional: Ionex resolution, by default None
url_stemstr | None, optional: URL stem, by default None
solutionSOLUTION, optional: Type of solution, by default “final”

Returns

str: File URL

spinifex.ionospheric.ionex_download.new_cddis_format(time: astropy.time.Time, prefix: str = 'cod', time_resolution: astropy.units.Quantity | None = None, url_stem: str | None = None, solution: spinifex.ionospheric.tec_data.SOLUTION = 'final') → str[source]

Get the URL for a new IONEX file from CDDIS.

Parameters

timeTime: Time to get the URL for.
prefixstr, optional: Analysis centre prefix, by default “cod”. Must be a supported analysis centre.
time_resolutionu.Quantity | None, optional: Time resolution, by default None, will default to the server time resolution.
url_stemstr | None, optional: URL steam, by default None, will default to CDDIS.
solutionSOLUTION, optional: Solution type, by default “final”, must be “final” or “rapid”.

Returns

str: File URL

spinifex.ionospheric.ionex_download.old_cddis_format(time: astropy.time.Time, prefix: str = 'cod', time_resolution: astropy.units.Quantity | None = None, url_stem: str | None = None, solution: spinifex.ionospheric.tec_data.SOLUTION = 'final') → str[source]

Get the URL for an old IONEX file from CDDIS.

Parameters

timeTime: Time to get the URL for.
prefixstr, optional: Analysis centre prefix, by default “cod”
time_resolutionu.Quantity | None, optional: Time resolution, by default None, will default to the server time resolution.
url_stemstr | None, optional: URL steam, by default None, will default to CDDIS.
solutionSOLUTION, optional: Solution type, by default “final”, must be “final” or “rapid”.

Returns

str: File URL

Raises

IonexError: If the prefix is not a supported analysis centre.

spinifex.ionospheric.ionex_download.should_use_new_cddis_format(day: astropy.time.Time, prefix: str) → bool[source]

Determine if the new CDDIS format should be used.

Parameters

dayTime: Day to pull from CDDIS.
prefixstr: Analysis centre prefix.

Returns

bool: Whether the new format should be used

spinifex.ionospheric.ionex_download._download_ionex[source]

spinifex.ionospheric.ionex_download.download_ionex[source]