Locations¶

Printing known locations¶

To print all locations the application knows about, you can use the locations-show command. Adding the --details option will print all variables for each location, instead of just the names.

pollyxt_pipelines locations-show
pollyxt_pipelines locations-show --detail

Adding new locations¶

A config file is used to add new locations to the application. It is stored in different locations, depending on the operating system you are on:

• Linux: /etc/pollyxt_pipelines/locations.ini (system-wide) and ~/.config/pollyxt_pipelines/locations.ini (user)

• Windows: %APPDATA%/PollyXT_Pipelines/pollyxt_pipelines.ini

To print the path for your system, use the locations-path command:

pollyxt_pipelines locations-path
pollyxt_pipelines locations-path --user # Print only the user's path

The file is ini-formatted, where each section is a station name. For example:

[Antikythera]
scc_code = aky
lat = 23.3100
lon = 35.8600
altitude_asl = 0.1
daytime_configuration = 437
nighttime_configuration = 438
channel_id = 493, 500, 497, 499, 494, 496, 498, 495, 501, 941, 940, 502
background_low = 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0
background_high = 249, 249, 249, 249, 249, 249, 249, 249, 249, 249, 249, 249
lr_input = 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1
temperature = 20
pressure = 1008
depol_calibration_zero_state = 0
total_channel_355_nm_idx = 0
cross_channel_355_nm_idx = 1
total_channel_532_nm_idx = 4
cross_channel_532_nm_idx = 5
calibration_355nm_total_channel_ids = 1266, 1268
calibration_355nm_cross_channel_ids = 1236, 1267
calibration_532nm_total_channel_ids = 1270, 1272
calibration_532nm_cross_channel_ids = 1269, 1271
profile_name = ANTIKYTHERA
sounding_provider = noa_wrf

You can add more than one location in the same file. Verify that it worked by running pollyxt_pipelines locations-show --detail when you are done.

API¶

Locations are represented using NamedTuple objects, you can add more in pollyxt_pipelines.locations. All known locations should be added in the LOCATIONS tuple. Some helper functions are also defined to search stations by their name/IDs.

Contains information about locations

Each location (i.e. SCC station) is defined in an .ini file. For some stations, the .ini files are included with the software but custom locations can be defined.

pollyxt_pipelines.locations.LOCATIONS = {'Antikythera': Location(name='Antikythera', profile_name='ANTIKYTHERA', sounding_provider='noa_wrf', scc_code='aky', lat=23.31, lon=35.86, altitude_asl=0.1, daytime_configuration=437, nighttime_configuration=438, calibration_configuration_355nm=461, calibration_configuration_532nm=462, calibration_configuration_1064nm=None, depol_calibration_zero_state=0, channel_id=['no000', 'no007', 'no004', 'no006', 'no001', 'no003', 'no005', 'no002', 'no008', 'no009', 'no010', 'no011'], background_low=[0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0], background_high=[249, 249, 249, 249, 249, 249, 249, 249, 249, 249, 249, 249], lr_input=[1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1], temperature=20, pressure=1008, total_channel_355_nm_idx=0, cross_channel_355_nm_idx=1, total_channel_532_nm_idx=4, cross_channel_532_nm_idx=5, total_channel_1064_nm_idx=None, cross_channel_1064_nm_idx=None, calibration_355nm_total_channel_ids=['no0024', 'no0026'], calibration_355nm_cross_channel_ids=['no0014', 'no0025'], calibration_532nm_total_channel_ids=['no0028', 'no0030'], calibration_532nm_cross_channel_ids=['no0027', 'no0029'], calibration_1064nm_total_channel_ids=None, calibration_1064nm_cross_channel_ids=None, sunrise_time='04:00', sunset_time='16:00'), 'CVO': Location(name='CVO', profile_name='mindelo', sounding_provider='cloudnet', scc_code='cvo', lat=16.87, lon=-24.99, altitude_asl=10.0, daytime_configuration=712, nighttime_configuration=713, calibration_configuration_355nm=714, calibration_configuration_532nm=715, calibration_configuration_1064nm=716, depol_calibration_zero_state=0, channel_id=[1995, 1996, 1997, 1998, 1999, 2000, 2001, 2002, 2005, 2006, 2007, 2008, 2009, 2004, 2003], background_low=[0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0], background_high=[240, 240, 240, 240, 240, 240, 240, 240, 240, 240, 240, 240, 240, 240, 240], lr_input=[1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1], temperature=15, pressure=1000, total_channel_355_nm_idx=0, cross_channel_355_nm_idx=1, total_channel_532_nm_idx=4, cross_channel_532_nm_idx=5, total_channel_1064_nm_idx=7, cross_channel_1064_nm_idx=14, calibration_355nm_total_channel_ids=[2010, 2011], calibration_355nm_cross_channel_ids=[2012, 2013], calibration_532nm_total_channel_ids=[2014, 2015], calibration_532nm_cross_channel_ids=[2016, 2017], calibration_1064nm_total_channel_ids=[2018, 2019], calibration_1064nm_cross_channel_ids=[2020, 2021], sunrise_time='0', sunset_time='0'), 'Finokalia': Location(name='Finokalia', profile_name='FINOKALIA', sounding_provider='noa_wrf', scc_code='fik', lat=25.6698, lon=35.3377, altitude_asl=0.1, daytime_configuration=186, nighttime_configuration=302, calibration_configuration_355nm=461, calibration_configuration_532nm=462, calibration_configuration_1064nm=None, depol_calibration_zero_state=0, channel_id=[493, 500, 497, 499, 494, 496, 498, 495, 501, 941, 940, 502], background_low=[0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0], background_high=[249, 249, 249, 249, 249, 249, 249, 249, 249, 249, 249, 249], lr_input=[1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1], temperature=20, pressure=1008, total_channel_355_nm_idx=0, cross_channel_355_nm_idx=1, total_channel_532_nm_idx=4, cross_channel_532_nm_idx=5, total_channel_1064_nm_idx=None, cross_channel_1064_nm_idx=None, calibration_355nm_total_channel_ids=[1266, 1268], calibration_355nm_cross_channel_ids=[1236, 1267], calibration_532nm_total_channel_ids=[1270, 1272], calibration_532nm_cross_channel_ids=[1269, 1271], calibration_1064nm_total_channel_ids=None, calibration_1064nm_cross_channel_ids=None, sunrise_time='+69', sunset_time='-15')}¶

List of all known locations

class pollyxt_pipelines.locations.Location(name: str, profile_name: str, sounding_provider: str, scc_code: str, lat: float, lon: float, altitude_asl: float, daytime_configuration: int, nighttime_configuration: int, calibration_configuration_355nm: Optional[int], calibration_configuration_532nm: Optional[int], calibration_configuration_1064nm: Optional[int], depol_calibration_zero_state: int, channel_id: Union[List[int], List[str]], background_low: List[int], background_high: List[int], lr_input: List[int], temperature: int, pressure: int, total_channel_355_nm_idx: Optional[int], cross_channel_355_nm_idx: Optional[int], total_channel_532_nm_idx: Optional[int], cross_channel_532_nm_idx: Optional[int], total_channel_1064_nm_idx: Optional[int], cross_channel_1064_nm_idx: Optional[int], calibration_355nm_total_channel_ids: Union[List[int], List[str]], calibration_355nm_cross_channel_ids: Union[List[int], List[str]], calibration_532nm_total_channel_ids: Union[List[int], List[str]], calibration_532nm_cross_channel_ids: Union[List[int], List[str]], calibration_1064nm_total_channel_ids: Union[List[int], List[str]], calibration_1064nm_cross_channel_ids: Union[List[int], List[str]], sunrise_time: str, sunset_time: str)[source]¶

Bases: NamedTuple

Represents a physical location of PollyXT installation.

altitude_asl: float¶

Altitude of station

background_high: List[int]¶

Value for the Background_High variable

background_low: List[int]¶

Value for the Background_Low variable

calibration_1064nm_cross_channel_ids: Union[List[int], List[str]]¶

Calibration channel SCC IDs for 1064nm. Comma separated list. First value must be the +45° channel, second value must be the -45° channel.

calibration_1064nm_total_channel_ids: Union[List[int], List[str]]¶

Calibration channel SCC IDs for 1064nm. Comma separated list. First value must be the +45° channel, second value must be the -45° channel.

calibration_355nm_cross_channel_ids: Union[List[int], List[str]]¶

Calibration channel SCC IDs for 355nm. Comma separated list. First value must be the +45° channel, second value must be the -45° channel.

calibration_355nm_total_channel_ids: Union[List[int], List[str]]¶

Calibration channel SCC IDs for 355nm. Comma separated list. First value must be the +45° channel, second value must be the -45° channel.

calibration_532nm_cross_channel_ids: Union[List[int], List[str]]¶

Calibration channel SCC IDs for 532nm. Comma separated list. First value must be the +45° channel, second value must be the -45° channel.

calibration_532nm_total_channel_ids: Union[List[int], List[str]]¶

Calibration channel SCC IDs for 532nm. Comma separated list. First value must be the +45° channel, second value must be the -45° channel.

calibration_configuration_1064nm: Optional[int]¶

SCC Lidar Configuration ID - Calibration (532 nm)

calibration_configuration_355nm: Optional[int]¶

SCC Lidar Configuration ID - Calibration (355 nm)

calibration_configuration_532nm: Optional[int]¶

SCC Lidar Configuration ID - Calibration (532 nm)

channel_id: Union[List[int], List[str]]¶

Mapping of PollyXT Channels to SCC Channels Comma-separated list. The order of the list is the order of the channels in the PollyXT netCDF file.

cross_channel_1064_nm_idx: Optional[int]¶

Index in Polly netCDF file for the cross channel (1064nm)

cross_channel_355_nm_idx: Optional[int]¶

Index in Polly netCDF file for the cross channel (355nm)

cross_channel_532_nm_idx: Optional[int]¶

Index in Polly netCDF file for the cross channel (532nm)

daytime_configuration: int¶

SCC Lidar Configuration ID - Daytime

depol_calibration_zero_state: int¶

Value of depol_cal_angle when there is no calibration taking place

has_depol_channels()[source]¶

Returns a dictionary of wavelengths to booleans, true if that corresponding wavelength has depolarization channels.

Return type:

Dict[Wavelength, bool]

lat: float¶

Latitude of station

lon: float¶

Longitude of station

lr_input: List[int]¶

Value for the lr_input variable

name: str¶

Location friendly name

nighttime_configuration: int¶

SCC Lidar Configuration ID - Nightime

pressure: int¶

Pressure at the lidar station (Pressure_at_Lidar_Station variable)

print()[source]¶

Prints this location as a Table in the terminal

profile_name: str¶

How are the WRF profile names prefixed

scc_code: str¶

SCC Station code

sounding_provider: str¶

Which radiosonde provider to use

sunrise_time: str¶

MM) or offset (minutes from calculated sunrise in +X or -X format, where X an integer)

Type:

Sunrise time (HH

sunset_time: str¶

MM) or offset (minutes from calculated sunrise in +X or -X format, where X an integer)

Type:

Sunrise time (HH

temperature: int¶

Temperature at the lidar station (Temperature_at_Lidar_Station variable)

total_channel_1064_nm_idx: Optional[int]¶

Index in Polly netCDF file for the total channel (1064nm)

total_channel_355_nm_idx: Optional[int]¶

Index in Polly netCDF file for the total channel (355nm)

total_channel_532_nm_idx: Optional[int]¶

Index in Polly netCDF file for the total channel (532nm)

pollyxt_pipelines.locations.get_location_by_scc_code(code)[source]¶

Returns a location by its SCC code or None if it doesn’t exist.

Return type:

Optional[Location]

pollyxt_pipelines.locations.location_from_section(name, section)[source]¶

Create a Location from a ConfigParser Section (SectionProxy)

Return type:

Location

pollyxt_pipelines.locations.read_locations()[source]¶

Reads all built-in and custom locations into a dictionary: name -> Location

Return type:

Dict[str, Location]

pollyxt_pipelines.locations.unknown_location_error(name)[source]¶

Prints an error message that the given location is not found, along with a list of known locations