midgard.site_info

Common function used by site_info classes

convert_to_utc()

Full name: midgard.site_info.convert_to_utc

Signature: (time: datetime.datetime) -> datetime.datetime

Convert datetime object to UTC

Args:

time: Time zone aware datetime object

Returns:

Time zone unaware datetime object related to UTC

midgard.site_info._site_info

Base classes for site information.

Description:

All the base classes are abstract classes. There are three base classes defined.

TODO: 'Identifier' module has no history information. ModuleBase and SiteInfoBase class are adapted to that. The question is should it be handled differently. E.g. ModuleBase.get_history() function is not needed from 'Identifier' module, but is available.

ModuleBase

Full name: midgard.site_info._site_info.ModuleBase

Signature: ()

Base class for each module of site information (e.g. Antenna, Receiver, ...).

Allows different sources of site information history to be registered.

SiteInfoBase

Full name: midgard.site_info._site_info.SiteInfoBase

Signature: (station: str, site_info: Dict[str, Any]) -> None

Site information base class defining common attributes and methods

SiteInfoHistoryBase

Full name: midgard.site_info._site_info.SiteInfoHistoryBase

Signature: (station: str, source_data: Any = None, source_path: str = None) -> None

Base class defining common attributes and methods for history classes

SiteInfoHistoryIterator

Full name: midgard.site_info._site_info.SiteInfoHistoryIterator

Signature: (site_info_history)

Iterator class for SiteInfoHistory classes

midgard.site_info.antenna

Antenna information classes

Description: This module is divided into three different types of classes:

1. Main class Antenna provides basic functionality to the user. See exampless
2. Antenna source type classes:
    - There is one class for each source type.
    - A class with all relevant antenna information for a point in time.
3. Antenna history source type classes:
    - There is one class for each source type.
    - Converts input from source_data to a object of type AntennaHistorySinex, etc and provides functions
      for accessing the history and relevant dates. 
    - The history consist of a time interval for which the entry is valid and an instance of an antenna 
      source type class for each defined time interval.

If a source type does not contain information about the antenna the module will return 'None'.

Example:

from midgard import parsers
from midgard.site_info.antenna import Antenna
from datetime import datetime

# Read SINEX data  
p = parsers.parse_file(parser_name='sinex_site', file_path='./data/site_info/igs.snx')
source_data = p.as_dict()
all_stations = source_data.keys()

# Get station information    
Antenna.get("snx", "osls", datetime(2020, 1, 1), source_data, source_path=p.file_path)
Antenna.get("snx", all_stations, datetime(2020, 1, 1), source_data, source_path=p.file_path)

Antenna.get_history("snx", "osls", source_data, source_path=p.file_path)
Antenna.get_history("snx", all_stations, source_data, source_path=p.file_path)

Antenna

Full name: midgard.site_info.antenna.Antenna

Signature: ()

Main class for converting antenna information from various sources into unified classes

AntennaGnssEu

Full name: midgard.site_info.antenna.AntennaGnssEu

Signature: (station: str, site_info: Dict[str, Any]) -> None

Antenna class handling GnssEu API antenna station information

AntennaHistoryGnssEu

Full name: midgard.site_info.antenna.AntennaHistoryGnssEu

Signature: (station: str, source_data: Any = None, source_path: str = None) -> None

AntennaHistorySinex

Full name: midgard.site_info.antenna.AntennaHistorySinex

Signature: (station: str, source_data: Any = None, source_path: str = None) -> None

AntennaHistorySsc

Full name: midgard.site_info.antenna.AntennaHistorySsc

Signature: (station: str, source_data: Any = None, source_path: str = None) -> None

AntennaSinex

Full name: midgard.site_info.antenna.AntennaSinex

Signature: (station: str, site_info: Dict[str, Any]) -> None

Antenna class handling SINEX file antenna station information

midgard.site_info.eccentricity

Eccentricity information classes

Description: This module is divided into three different types of classes:

1. Main class Eccentricity provides basic functionality to the user. See examples.
2. Eccentricity source type classes:
    - There is one class for each source type
    - A class with all relevant site coordinate information for a point in time.
3. Eccentricity history source type classes:
    - There is one class for each source type
    - Converts input from source_data to a object of type EccentricityHistorySinex, etc and provides functions
      for accessing the history and relevant dates. 
    - The history consist of a time interval for which the entry is valid and an instance of an eccentricity 
      source type class for each defined time interval.

If a source type does not contain information about the eccentricity the module will return 'None'.

Example:

from midgard import parsers
from midgard.site_info.eccentricity import Eccentricity
from datetime import datetime

# Read SINEX data  
p = parsers.parse_file(parser_name='sinex_site', file_path='./data/site_info/igs.snx')
source_data = p.as_dict()
all_stations = source_data.keys()

# Get station information
Eccentricity.get("snx", "osls", datetime(2020, 1, 1), source_data, source_path=p.file_path)
Eccentricity.get("snx", all_stations, datetime(2020, 1, 1), source_data, source_path=p.file_path)

Eccentricity.get_history("snx", "osls", source_data, source_path=p.file_path)
Eccentricity.get_history("snx", all_stations, source_data, source_path=p.file_path)

Eccentricity

Full name: midgard.site_info.eccentricity.Eccentricity

Signature: ()

Main class for converting eccentricity information from various sources into unified classes

EccentricityGnssEu

Full name: midgard.site_info.eccentricity.EccentricityGnssEu

Signature: (station: str, site_info: Dict[str, Any]) -> None

Eccentricity class handling gnssEu API eccentricity station information

EccentricityHistoryGnssEu

Full name: midgard.site_info.eccentricity.EccentricityHistoryGnssEu

Signature: (station: str, source_data: Any = None, source_path: str = None) -> None

EccentricityHistorySinex

Full name: midgard.site_info.eccentricity.EccentricityHistorySinex

Signature: (station: str, source_data: Any = None, source_path: str = None) -> None

EccentricityHistorySsc

Full name: midgard.site_info.eccentricity.EccentricityHistorySsc

Signature: (station: str, source_data: Any = None, source_path: str = None) -> None

EccentricitySinex

Full name: midgard.site_info.eccentricity.EccentricitySinex

Signature: (station: str, site_info: Dict[str, Any]) -> None

Eccentricity class handling SINEX file eccentricity station information

midgard.site_info.gnsseu

midgard.site_info.gnsseu.api

Python wrapper around the gnss-metadata.eu API

Description:

Creates functions automatically based on the services listed on the Swagger help page referred to by URL.

Example: from åsgard import gnsseu

Get instance of GnssEuApi class with API methods based on default URL

api = gnsseu.api.GnssEuApi()

Get instance of GnssEuApi class with API methods based on defined URL

api = gnsseu.api.GnssEuApi(url=""https://gnss-metadata.eu/site/api-json")

GnssEuApi

Full name: midgard.site_info.gnsseu.api.GnssEuApi

Signature: (url: str = 'https://gnss-metadata.eu/site/api-json') -> None

A wrapper around the gnss-metadata.eu API

midgard.site_info.identifier

Identifier information classes

Description: This module is divided into three different types of classes:

1. Main class Identifier provides basic functionality to the user. See examples.
2. Identifier source type classes:
    - There is one class for each source type
    - A class with all relevant site coordinate information for a point in time.

If a source type does not contain information about the identifier the module will return 'None'.

Example:

from midgard import parsers
from midgard.site_info.identifier import Identifier
from datetime import datetime

# Read SINEX data  
p = parsers.parse_file(parser_name='sinex_site', file_path='./data/site_info/igs.snx')
source_data = p.as_dict()
all_stations = source_data.keys()

# Get station information
Identifier.get("snx", "osls", datetime(2020, 1, 1), source_data, source_path=p.file_path)
Identifier.get("snx", all_stations, datetime(2020, 1, 1), source_data, source_path=p.file_path)

Identifier

Full name: midgard.site_info.identifier.Identifier

Signature: ()

Main class for converting identifier information from various sources into unified classes

IdentifierGnssEu

Full name: midgard.site_info.identifier.IdentifierGnssEu

Signature: (station: str, source_data: Any = None, source_path: str = None) -> None

Identifier class handling gnssEu API identifier station information

IdentifierSinex

Full name: midgard.site_info.identifier.IdentifierSinex

Signature: (station: str, source_data: Any = None, source_path: str = None) -> None

Identifier class handling SINEX file identifier station information

IdentifierSsc

Full name: midgard.site_info.identifier.IdentifierSsc

Signature: (station: str, source_data: Any = None, source_path: str = None) -> None

Identifier class handling SSC file identifier station information

midgard.site_info.receiver

Receiver information classes

Description: This module is divided into three different types of classes:

1. Main class Receiver provides basic functionality to the user. See examples.
2. Receiver source type classes:
    - There is one class for each source type
    - A class with all relevant receiver information for a point in time.
3. Receiver history source type classes:
    - There is one class for each source type
    - Converts input from source_data to a object of type ReceiverHistorySinex, etc and provides functions
      for accessing the history and relevant dates. 
    - The history consist of a time interval for which the entry is valid and an instance of a receiver 
      source type class for each defined time interval.

If a source type does not contain information about the receiver the module will return 'None'.

Example:

from midgard import parsers
from midgard.site_info.receiver import Receiver
from datetime import datetime

# Read SINEX data  
p = parsers.parse_file(parser_name='sinex_site', file_path='./data/site_info/igs.snx')
source_data = p.as_dict()
all_stations = source_data.keys()

# Get station information
Receiver.get("snx", "osls", datetime(2020, 1, 1), source_data, source_path=p.file_path)
Receiver.get("snx", all_stations, datetime(2020, 1, 1), source_data, source_path=p.file_path)

Receiver.get_history("snx", "osls", source_data, source_path=p.file_path)
Receiver.get_history("snx", all_stations, source_data, source_path=p.file_path)

Receiver

Full name: midgard.site_info.receiver.Receiver

Signature: ()

Main class for converting receiver information from various sources into unified classes

ReceiverGnssEu

Full name: midgard.site_info.receiver.ReceiverGnssEu

Signature: (station: str, site_info: Dict[str, Any]) -> None

Receiver class handling gnssEu API receiver station information

ReceiverHistoryGnssEu

Full name: midgard.site_info.receiver.ReceiverHistoryGnssEu

Signature: (station: str, source_data: Any = None, source_path: str = None) -> None

ReceiverHistorySinex

Full name: midgard.site_info.receiver.ReceiverHistorySinex

Signature: (station: str, source_data: Any = None, source_path: str = None) -> None

ReceiverHistorySsc

Full name: midgard.site_info.receiver.ReceiverHistorySsc

Signature: (station: str, source_data: Any = None, source_path: str = None) -> None

ReceiverSinex

Full name: midgard.site_info.receiver.ReceiverSinex

Signature: (station: str, site_info: Dict[str, Any]) -> None

Receiver class handling SINEX file receiver station information

midgard.site_info.site_coord

Site cooridnate information classes

Description: This module is divided into three different types of classes:

1. Main class SiteCoord provides basic functionality to the user. See exampless
2. Site coordinate source type classes:
    - There is one class for each source type.
    - A class with all relevant site coordinate information for a point in time.
3. Site coordinate history source type classes:
    - There is one class for each source type.
    - Converts input from source_data to a object of type SiteCoordHistorySinex, etc and provides functions
      for accessing the history and relevant dates. 
    - The history consist of a time interval for which the entry is valid and an instance of a site coordinate 
      source type class for each defined time interval.

If a source type does not contain information about the site coordinates the module will return 'None'.

Example:

from midgard import parsers
from midgard.site_info.site_coord import SiteCoord
from datetime import datetime

# Read SINEX data    
p = parsers.parse_file(parser_name='sinex_site', file_path='./data/site_info/igs.snx')
source_data = p.as_dict()
all_stations = source_data.keys()

# Get station information
SiteCoord.get("snx", "osls", datetime(2020, 1, 1), source_data, source_path=p.file_path)
SiteCoord.get("snx", all_stations, datetime(2020, 1, 1), source_data, source_path=p.file_path)

SiteCoord.get_history("snx", "osls", source_data, source_path=p.file_path)
SiteCoord.get_history("snx", all_stations, source_data, source_path=p.file_path)

SiteCoord

Full name: midgard.site_info.site_coord.SiteCoord

Signature: ()

Main class for converting site coordinates from various sources into unified classes

SiteCoordHistoryGnssEu

Full name: midgard.site_info.site_coord.SiteCoordHistoryGnssEu

Signature: (station: str, source_data: Any = None, source_path: str = None) -> None

SiteCoordHistorySinex

Full name: midgard.site_info.site_coord.SiteCoordHistorySinex

Signature: (station: str, source_data: Any = None, source_path: str = None) -> None

SiteCoordHistorySsc

Full name: midgard.site_info.site_coord.SiteCoordHistorySsc

Signature: (station: str, source_data: Any = None, source_path: str = None) -> None

SiteCoordSinex

Full name: midgard.site_info.site_coord.SiteCoordSinex

Signature: (station: str, site_info: Dict[str, Any]) -> None

Site coordinate class handling SINEX file station coordinate information

SiteCoordSsc

Full name: midgard.site_info.site_coord.SiteCoordSsc

Signature: (station: str, site_info: Dict[str, Any]) -> None

Site coordinate class handling SSC file station coordinate information

midgard.site_info.site_info

Module that provides site information as unified objects independent of source.

Description:

Site information consists of antenna, eccentricity and receiver information and coordinates for a station. If a source type does not contain information about the antenna, receiver or coordinate the corresponding entry will be set to 'None'.

Example:

from midgard import parsers
from midgard.site_info.site_info import SiteInfo
from datetime import datetime

p = parsers.parse_file(parser_name='sinex_site', file_path='./data/site_info/igs.snx')
source_data = p.as_dict()
all_stations = source_data.keys()

SiteInfo.get("snx", "osls", datetime(2020, 1, 1), source_data, source_path=p.file_path)
SiteInfo.get("snx", all_stations, datetime(2020, 1, 1), source_data, source_path=p.file_path)

SiteInfo.get_history("snx", "osls", source_data, source_path=p.file_path)
SiteInfo.get_history("snx", all_stations, source_data, source_path=p.file_path)

Description:

SiteInfo

Full name: midgard.site_info.site_info.SiteInfo

Signature: ()

Main site information class for site information from various sources into unified classes

Keys	Action
`?`	Open this help
`n`	Next page
`p`	Previous page
`s`	Search