gwsumm.mode module¶

Job modes

class gwsumm.mode.Mode(value, names=None, *, module=None, qualname=None, type=None, start=1, boundary=None)[source]¶

Bases: OrderedEnum

Enumeration of valid processing ‘modes’

Each mode provides an association with a particular GPS interval

day = 10¶

dir_format()[source]¶

event = 1¶

gps = 2¶

is_calendar()[source]¶

month = 12¶

static = 0¶

week = 11¶

year = 13¶

class gwsumm.mode.OrderedEnum(value, names=None, *, module=None, qualname=None, type=None, start=1, boundary=None)[source]¶: Bases: Enum

gwsumm.mode.get_base(date, mode=None)[source]¶

Determine the correct base attribute for the given date and mode.

Parameters:

date:class:`datetime.datetime`: formatted date
modeint, str: enumerated interger code (or name) for the required mode

Returns:

basestr: the recommended base URL to have a correctly linked calendar

gwsumm.mode.get_mode(m=None)[source]¶: Return the enum for the given mode, defaults to the current mode.

gwsumm.mode.set_mode(m)[source]¶: Set the current mode.