pydarn.radar.radInfoIo

Module: pydarn.radar.radInfoIo

Input/Output for radar information (location, boresight, interferometer position...) is read from a local dblite database (radar.db). The functions in this module provide tools to populate/update said database (from hdw.dat and radar.dat files), or simply read hdw.dat and radar.dat files. It also provide a function to manually update the local radar.db database using the remote db database (requires an active internet connection).

Classes:

• pydarn.radar.radInfoIo.updateRadars

Functions:

• pydarn.radar.radInfoIo.hdwRead(): reads hdw.dat files
• pydarn.radar.radInfoIo.radarRead(): reads radar.dat file

pydarn.radar.radInfoIo.hdwRead(fname, path=None)

Reads hdw.dat files for given radar specified by its hdw.dat file name

Args:

• fname (str): hdw.dat file name
• [path] (str): path to hdw.dat file; defaults to RST environment variable SD_HDWPATH

Returns:

• A dictionary with keys matching the hdw.dat variables each containing values of length #site updates.

Example:

hdw = pydarn.radar.hdwRead('hdw.dat.bks')

Written by Sebastien, 2012-09

pydarn.radar.radInfoIo.radarRead(path=None)

Reads radar.dat file

Args:

• [path] (str): path to radar.dat file; defaults to RST environment variable SD_RADAR

Returns:

• A dictionary with keys matching the radar.dat variables each containing values of length #radars.

Example:

radars = pydarn.radar.radarRead()

Written by Sebastien, 2012-09

class pydarn.radar.radInfoIo.updateRadars

update local radar.sqlite from remote db database, or from local files if the database cannot be reached. Currently, the remote database is housed on the VT servers.

Members:

• sql_path (str): path to sqlite file
• sql_file (str): sqlite file name

Methods:

• updateRadars.sqlInit()
• updateRadars.sqlUpdate()
• updateRadars.dbConnect()

Example:

obj = pydarn.radar.updateRadars()

Written by Sebastien, 2013-05

dbConnect()

Try to establish a connection to remote db database

Belongs to: updateRadars

Args:

• None

Returns:

• isConnected (bool): True if the connection was successfull

sqlInit()

Initialize sqlite file (only if file does not already exists)

Belongs to: updateRadars

Args:

• None

Returns:

• isConnected (bool): True if sqlite file already exists or was sussessfully created

sqlUpdate()

Update sqlite file with provided db selections (if possible).

Belongs to: updateRadars

Args:

• None

Returns:

• isConnected (bool): True if sqlite file update was successfull

pydarn.radar.radInfoIo

alias of pydarn.radar.radInfoIo