QT Gui workflow, and a few questions

[damca]

I have been enjoying the QT app quite a bit. It's extremely useful. A workflow I've enjoyed using is something like the following:

1. Have a script meant to be run with run -i script.py from the QT Gui console:

# custom_lens.py
opm = app.model
opm.radius_mode = True

sm  = opm['seq_model']
osp = opm['optical_spec']

opm['system_spec'].title = 'Custom Lens'
opm['system_spec'].dimensions = 'mm'

osp['pupil'] = PupilSpec(osp, key=['object', 'epd'], value=6)
osp['fov'] = FieldSpec(osp, key=['object', 'real height'], value=5)
osp['wvls'] = WvlSpec([('F', 0.5), (587.5618, 1.0), ('C', 0.5)], ref_wl=1)

sm.gaps[0].thi = 1e10  # approximate collimated light
sm.add_surface([4.0, 5.0, 'N-LAK9', 'Schott'])
sm.set_stop()
sm.add_surface([0.0, 9.0])

opm.update_model()

However, I'd like to rerun run -i script.py without adding more lenses to the system. One work around to this is to have the script like the following:

# custom_lens2.py
def create_model():
    opm = OpticalModel()
    opm.radius_mode = True

    sm  = opm['seq_model']
    osp = opm['optical_spec']

    opm['system_spec'].title = 'Custom Lens'
    opm['system_spec'].dimensions = 'mm'

    osp['pupil'] = PupilSpec(osp, key=['object', 'epd'], value=6)
    osp['fov'] = FieldSpec(osp, key=['object', 'real height'], value=5)
    osp['wvls'] = WvlSpec([('F', 0.5), (587.5618, 1.0), ('C', 0.5)], ref_wl=1)

    sm.gaps[0].thi = 1e10  # approximate collimated light
    sm.add_surface([4.0, 5.0, 'N-LAK9', 'Schott'])
    sm.set_stop()
    sm.add_surface([0.0, 9.0])

    opm.update_model()
    return opm


app.set_model(create_model())

This can then be run multiple times without introducing new lenses. And it seems to work correctly until I click the "First order data" button. Which throws an error. And I think this is because some references to opm are not updating with the custom_lens2.py above. Even when I click 'setup opm' after running.

In[2]   : opm
Out[2]: <rayoptics.optical.opticalmodel.OpticalModel at 0x11eee0c80>

In[3]   : app.model
Out[3]: <rayoptics.optical.opticalmodel.OpticalModel at 0x11eee0c80>

In[4]   : run -i custom_lens2.py

# Click 'setup opm' here

In[5]   : opm
Out[5]: <rayoptics.optical.opticalmodel.OpticalModel at 0x11eee0c80>  # not changed!

In[6]   : app.model
Out[6]: <rayoptics.optical.opticalmodel.OpticalModel at 0x12e5a97c0>  # changed!

I am thinking the issue might be In the source code, for ipyconsole.py line 111:

    opt_model = opt_model if opt_model else gui_parent.app_manager.model
    opm_vars = {
                'opm': opt_model,
                'sm': opt_model['seq_model'],
                'osp': opt_model['optical_spec'],
                'ss': opt_model['specsheet'],
                'pm': opt_model['parax_model'],
                'em': opt_model['ele_model'],
                'pt': opt_model['part_tree'],
                'ar': opt_model['analysis_results'],
                }
    cmd_button_2.clicked.connect(
        lambda: ipy_console.push_vars(opm_vars))

Here the check on opt_model seems to never run, and this might be a python closure issue:

A = 4
def outer(a, b):
    def inner():
        x = a if a else A
        return x
    return inner
i = outer(1, 2)
i()  # returns 1
A = 2
i() # returns 1

Anyways, that was a long digression. So my essential questions are 1. is there a cleaner way to structure the scripts meant to be run in the global namespace ideally for 're-runnability' and 2. what is the role of 'setup opm' and how is it supposed to work?

Many thanks for this amazing package!

[mjhoptics]

Hello @damca,

Thank you for your interesting example. I had to take your code for custom_lens2.py and add:
global app
at the start of the file. When I did this, the app.set_model() call actually did something and app.model had the new instance of OptModel. Clicking on "First Order Data" gave useful results.

I think you're right that the "setup opm" button isn't doing anything useful for this case. The way it's currently written, the opm used for ipyconsole creation is baked into the button action. It's main purpose is to conveniently get the current opm, sm, osp, etc. into the global namespace. Since I put the button in the UI I've revised the New and Open File menu picks to ensure these variables are set up correctly and I find myself rarely using the button. There's probably a way to build the opm_vars dict when the button is pressed vs. when the button is created, as now.

Thank you for the kind words about ray-optics. Feel free to make suggestions for improving the GUI; I haven't had much feedback.

Regards,

Mike Hayford