ctdclient.model.near_real_time_publication module

ctdclient.model.near_real_time_publication.instantiate_near_real_time_target(*args, frequency_of_action='23:59:00', **kwargs)

Return type:

NearRealTimeTarget

class ctdclient.model.near_real_time_publication.NRTList(*args, **kwargs)

Bases: UserList

update_nrt_data(clear_data=True)

create_nrt_instance(path)

get_template(template_path=PosixPath('/workspace/CTD-Software/CTD-Client/resources/templates/nrt_template.toml'))

toggle_activity(nrt)

kill_processes()

delete_nrt(nrt)

class ctdclient.model.near_real_time_publication.NearRealTimeTarget(recipient_address, target_file_suffix, target_file_directory='', geo_filter='', email_info={}, file_path='', active=False, **kwargs)

Bases: object

Stores information for near-real-time distribution of latest CTD data files. Can work in two modes: email or rsync/copy. Will distinguish between these by checking ‘recipient_adress’ for an ‘@’.

abstractmethod toggle_activity()

abstractmethod run()

Will move the recent files to the target location.

create_email_message(target_files, to_address='', from_address='', subject='', body='')

Creates an email with target files attached.

create_email_draft(msg, file_path='')

Creates an email .eml draft file, that can be opened by common email programs.

Return type:

Path

open_draft_msg(file_path)

Open an .eml file using the default email program.

run_email_logic(files_to_attach, run_manually=False)

send_email(msg)

Sends the email message using the given smtp server configuration.

copy_files(target_file)

Copies target files to given location.

get_target_files(target_file=PosixPath('.'))

Creates a list of paths to files that are meant to be published.

Return type:

list[Path]

deg_min_to_deg_decimal(value)

Return type:

float

geographic_filter(coordinate_pair, polygon_data_to_check_against='')

Checks, whether we are inside of a certain polygon. The polygon will usually be the EEZ of a certain country. Does support all data formats that geopandas can handle.

Return type:

bool

time_filter(file)

Ensure, that file has been modified in the last 24 hours.

Return type:

bool

class ctdclient.model.near_real_time_publication.DailyPublication(*args, time_to_run_at='23:59:30', single_run=False, **kwargs)

Bases: NearRealTimeTarget

action()

start()

stop()

toggle_activity()

ctdclient.model.near_real_time_publication.timer(time_to_run_at, function, single_run)

class ctdclient.model.near_real_time_publication.EachProcessingPublication(*args, **kwargs)

Bases: NearRealTimeTarget

toggle_activity()

run(target=PosixPath('.'))

Will move the recent files to the target location.