sidpy.io.interface_utils.check_ssh

sidpy.io.interface_utils.check_ssh()[source]

Checks whether or not the python kernel is running locally (False) or remotely (True)

Returns:

output – Whether or not the kernel is running over SSH (remote machine)

Return type:

bool

Notes

When developing workflows that need to work on remote or virtual machines in addition to one’s own personal computer such as a laptop, this function is handy at letting the developer know where the code is being executed

Examples

>>> import sidpy
>>> mode = sidpy.interface_utils.check_ssh()
>>> print('Running on remote machine: {}'.format(mode))