'''
Module provides dialog for setting SAS_OPENCL variable, which defines
device choice for OpenCL calculation
Created on Nov 29, 2016
@author: wpotrzebowski
'''
import json
import platform
import logging
import os
import sys
import wx
try:
import pyopencl as cl
except ImportError:
cl = None
import sasmodels
import sasmodels.model_test
import sasmodels.sasview_model
from sas.sasgui.guiframe.documentation_window import DocumentationWindow
logger = logging.getLogger(__name__)
[docs]class CustomMessageBox(wx.Dialog):
"""
Custom message box for OpenCL results
"""
def __init__(self, parent, msg, title):
wx.Dialog.__init__(self, parent, title=title)
self.static_box = wx.StaticBox(self, -1, "OpenCL test completed!")
self.boxsizer = wx.BoxSizer(orient=wx.VERTICAL)
self.text = wx.TextCtrl(self, -1, size=(500, 300),
style=wx.TE_MULTILINE|wx.TE_READONLY)
self.text.SetValue(msg)
self.text.SetBackgroundColour(self.GetBackgroundColour())
self.text.SetFocus()
self.text.SetInsertionPoint(self.text.GetLastPosition())
self.boxsizer.Add(self.text, proportion=1, flag=wx.EXPAND)
self.fit_hsizer = wx.StaticBoxSizer(self.static_box, orient=wx.VERTICAL)
self.fit_hsizer.Add(self.boxsizer, 0, wx.ALL, 5)
self.vbox = wx.BoxSizer(wx.VERTICAL)
self.vbox.Add(self.fit_hsizer, 0, wx.ALL, 10)
self.message_text = wx.StaticText(self, -1, "If tests fail on OpenCL devices, "
"please select No OpenCL option.\n\n"
"In case of large number of failing tests, "
"please consider sending\n"
"above report to help@sasview.org.")
self.vbox.Add(self.message_text, 0, wx.LEFT|wx.EXPAND|wx.ADJUST_MINSIZE, 10)
self.ok_btn = wx.Button(self, wx.ID_OK)
self.btn_sizer = wx.BoxSizer(wx.HORIZONTAL)
self.btn_sizer.Add((10, 20), 1) # stretchable whitespace
self.btn_sizer.Add(self.ok_btn, 0)
self.vbox.Add(self.btn_sizer, 0, wx.EXPAND|wx.ALL, 10)
self.SetSizer(self.vbox)
self.vbox.Fit(self)
self.SetAutoLayout(True)
self.ShowModal()
self.Destroy()
[docs]class GpuOptions(wx.Dialog):
"""
"OpenCL options" Dialog Box
Provides dialog for setting SAS_OPENCL variable, which defines
device choice for OpenCL calculation
"""
def __init__(self, *args, **kwds):
kwds["style"] = wx.DEFAULT_DIALOG_STYLE
wx.Dialog.__init__(self, *args, **kwds)
clinfo = self._get_clinfo()
self.panel1 = wx.Panel(self, -1)
static_box1 = wx.StaticBox(self.panel1, -1, "Available OpenCL Options:")
boxsizer = wx.BoxSizer(orient=wx.VERTICAL)
self.option_button = {}
self.buttons = []
#Check if SAS_OPENCL is already set as environment variable
self.sas_opencl = os.environ.get("SAS_OPENCL", "")
for clopt in clinfo:
button = wx.CheckBox(self.panel1, -1, label=clopt[1], name=clopt[1])
if clopt != "No OpenCL":
self.option_button[clopt[1]] = clopt[0]
if self.sas_opencl == clopt[0]:
button.SetValue(1)
else:
self.option_button[clopt] = "None"
if self.sas_opencl.lower() == "none":
button.SetValue(1)
self.Bind(wx.EVT_CHECKBOX, self.on_check, id=button.GetId())
self.buttons.append(button)
boxsizer.Add(button, 0, 0)
fit_hsizer = wx.StaticBoxSizer(static_box1, orient=wx.VERTICAL)
fit_hsizer.Add(boxsizer, 0, wx.ALL, 5)
self.panel1.SetSizer(fit_hsizer)
self.vbox = wx.BoxSizer(wx.VERTICAL)
self.vbox.Add(self.panel1, 0, wx.ALL, 10)
accept_btn = wx.Button(self, wx.ID_OK)
accept_btn.SetToolTipString("Accept new OpenCL settings. This will"
" override SAS_OPENCL variable if set")
help_id = wx.NewId()
help_btn = wx.Button(self, help_id, 'Help')
help_btn.SetToolTipString("Help on the GPU options")
reset_id = wx.NewId()
reset_btn = wx.Button(self, reset_id, 'Reset')
reset_btn.SetToolTipString("Restore initial settings")
test_id = wx.NewId()
test_btn = wx.Button(self, test_id, 'Test')
test_btn.SetToolTipString("Test if models compile on the given infrastructure")
self.Bind(wx.EVT_BUTTON, self.on_OK, accept_btn)
self.Bind(wx.EVT_BUTTON, self.on_test, test_btn)
self.Bind(wx.EVT_BUTTON, self.on_reset, reset_btn)
self.Bind(wx.EVT_BUTTON, self.on_help, help_btn)
test_text = wx.StaticText(self, -1, "WARNING: Running tests can take a few minutes!")
test_text2 = wx.StaticText(self, -1, "NOTE: No test will run if No OpenCL is checked")
test_text.SetForegroundColour(wx.RED)
self.vbox.Add(test_text2, 0, wx.LEFT|wx.EXPAND|wx.ADJUST_MINSIZE, 10)
self.vbox.Add(test_text, 0, wx.LEFT|wx.EXPAND|wx.ADJUST_MINSIZE, 10)
btn_sizer = wx.BoxSizer(wx.HORIZONTAL)
btn_sizer.Add((10, 20), 1) # stretchable whitespace
btn_sizer.Add(accept_btn, 0)
btn_sizer.Add((10, 20), 0) # non-stretchable whitespace
btn_sizer.Add(test_btn, 0)
btn_sizer.Add((10, 20), 0) # non-stretchable whitespace
btn_sizer.Add(reset_btn, 0)
btn_sizer.Add((10, 20), 0) # non-stretchable whitespace
btn_sizer.Add(help_btn, 0)
# Add the button sizer to the main sizer.
self.vbox.Add(btn_sizer, 0, wx.EXPAND|wx.ALL, 10)
self.SetSizer(self.vbox)
self.vbox.Fit(self)
self.SetTitle("OpenCL options")
self.Centre()
def _get_clinfo(self):
"""
Reading in information about available OpenCL infrastructure
:return:
"""
clinfo = []
platforms = []
if cl is None:
logger.warn("Unable to import the pyopencl package. It may not "
"have been installed. If you wish to use OpenCL, try "
"running pip install --user pyopencl")
else:
try:
platforms = cl.get_platforms()
except cl.LogicError as err:
logger.warn("Unable to fetch the OpenCL platforms. This likely "
"means that the opencl drivers for your system are "
"not installed.")
logger.warn(err)
p_index = 0
for platform in platforms:
d_index = 0
devices = platform.get_devices()
for device in devices:
if len(devices) > 1 and len(platforms) > 1:
combined_index = ":".join([str(p_index), str(d_index)])
elif len(platforms) > 1:
combined_index = str(p_index)
else:
combined_index = str(d_index)
clinfo.append((combined_index, ":".join([platform.name, device.name])))
d_index += 1
p_index += 1
clinfo.append(("None", "No OpenCL"))
return clinfo
[docs] def on_check(self, event):
"""
Action triggered when box is selected
:param event:
:return:
"""
selected_button = event.GetEventObject()
for btn in self.buttons:
if btn != selected_button:
btn.SetValue(0)
if selected_button.GetValue():
self.sas_opencl = self.option_button[selected_button.Name]
else:
self.sas_opencl = None
[docs] def on_OK(self, event):
"""
Close window on accpetance
"""
#If statement added to handle Reset
if self.sas_opencl:
os.environ["SAS_OPENCL"] = self.sas_opencl
else:
if "SAS_OPENCL" in os.environ:
del os.environ["SAS_OPENCL"]
sasmodels.sasview_model.reset_environment()
event.Skip()
[docs] def on_reset(self, event):
"""
Resets selected values
"""
for btn in self.buttons:
btn.SetValue(0)
self.sas_opencl = None
[docs] def on_test(self, event):
"""
Run sasmodels check from here and report results from
"""
#The same block of code as for OK but it is needed if we want to have
#active response to Test button
no_opencl_msg = False
if self.sas_opencl:
os.environ["SAS_OPENCL"] = self.sas_opencl
if self.sas_opencl.lower() == "none":
no_opencl_msg = True
else:
if "SAS_OPENCL" in os.environ:
del os.environ["SAS_OPENCL"]
sasmodels.sasview_model.reset_environment()
try:
env = sasmodels.kernelcl.environment()
clinfo = [(ctx.devices[0].platform.vendor,
ctx.devices[0].platform.version,
ctx.devices[0].vendor,
ctx.devices[0].name,
ctx.devices[0].version)
for ctx in env.context]
except Exception:
clinfo = None
failures = []
tests_completed = 0
for test in sasmodels.model_test.model_tests():
try:
test()
except Exception:
failures.append(test.description)
tests_completed += 1
info = {
'version': sasmodels.__version__,
'platform': platform.uname(),
'opencl': clinfo,
'failing tests': failures,
}
msg_info = 'OpenCL tests results'
msg = str(tests_completed)+' tests completed.\n'
if len(failures) > 0:
msg += str(len(failures))+' tests failed.\n'
msg += 'Failing tests: '
msg += json.dumps(info['failing tests'])
msg += "\n"
else:
msg += "All tests passed!\n"
msg += "\nPlatform Details:\n\n"
msg += "Sasmodels version: "
msg += info['version']+"\n"
msg += "\nPlatform used: "
msg += json.dumps(info['platform'])+"\n"
if no_opencl_msg:
msg += "\nOpenCL driver: None"
else:
msg += "\nOpenCL driver: "
msg += json.dumps(info['opencl'])+"\n"
CustomMessageBox(self.panel1, msg, msg_info)
[docs] def on_help(self, event):
"""
Provide help on opencl options.
"""
TreeLocation = "user/sasgui/perspectives/fitting/gpu_setup.html"
anchor = "#device-selection"
DocumentationWindow(self, -1,
TreeLocation, anchor, "OpenCL Options Help")