Fixing example

[julianstirling]

This branch is trying to fix the example so it runs on a clean install.

Needed to directly name the pyoptic2 when importing. Needed to update a number of the module names that have changed case.

Adding a show() function to the example so if run from command line the mlab figure doesn't close instantly.

Currently a couple of things are needed before this could be merged but require some input:

• The SphericalSurface and PlaneSurface are commented out as they don't work. Volume.circ doesn't exist.
• It would be good to stop doing import *. import * not only clutters the namespace it also makes it near impossible for a new user to find where which file the functions being used are to learn their inputs. from pyoptic2 import sources and sources.SphericalSurface(...) is far clearer as an example.

[David-Baddeley]

Unfortunately the example is very broken as it hasn't been updated since the original pyoptic and a lot has changed since. Will push a better one tonight.

…

On Wed, 24 May 2023, 16:00 Julian Stirling, ***@***.***> wrote: This branch is trying to fix the example so it runs on a clean install. Needed to directly name the pyoptic2 when importing. Needed to update a number of the module names that have changed case. Adding a show() function to the example so if run from command line the mlab figure doesn't close instantly. Currently a couple of things are needed before this could be merged but require some input: - The SphericalSurface and PlaneSurface are commented out as they don't work. Volume.circ doesn't exist. - It would be good to stop doing import *. import * not only clutters the namespace it also makes it near impossible for a new user to find where which file the functions being used are to learn their inputs. from pyoptic2 import sources and sources.SphericalSurface(...) is far clearer as an example. ------------------------------ You can view, comment on, or merge this pull request online at: #3 Commit Summary - b39336a <b39336a> Add GPL license file as discussed in Glasgow - defe4ed <defe4ed> Update setup.py to use standard setuptools setup - 665b7e4 <665b7e4> Starting to fix the example to get it working on a clean install of pyoptic2 - ea4deb4 <ea4deb4> Fixing syntax for diplay3d.show and adding to example File Changes (6 files <https://github.com/David-Baddeley/pyoptic2/pull/3/files>) - *A* LICENSE <https://github.com/David-Baddeley/pyoptic2/pull/3/files#diff-c693279643b8cd5d248172d9c22cb7cf4ed163a3c98c8a3f69c2717edd3eacb7> (674) - *M* README.md <https://github.com/David-Baddeley/pyoptic2/pull/3/files#diff-b335630551682c19a781afebcf4d07bf978fb1f8ac04c6bf87428ed5106870f5> (4) - *M* examples/sphericalReflector.py <https://github.com/David-Baddeley/pyoptic2/pull/3/files#diff-3c7257ba4a7427726ab98746a5d2e467630939074257dd0e850bfe94a57faf62> (41) - *M* pyoptic2/display3d.py <https://github.com/David-Baddeley/pyoptic2/pull/3/files#diff-14c3088f957fea76ed081a9caa955356cd25750c9291416b1606b46e2e552712> (12) - *M* pyoptic2/sources.py <https://github.com/David-Baddeley/pyoptic2/pull/3/files#diff-69575b6486d97c83de944cb94d461b9addfe008c021ebe8c4d85d5ab8bf606c0> (4) - *M* setup.py <https://github.com/David-Baddeley/pyoptic2/pull/3/files#diff-60f61ab7a8d1910d86d9fda2261620314edcae5894d5aaa236b821c7256badd7> (64) Patch Links: - https://github.com/David-Baddeley/pyoptic2/pull/3.patch - https://github.com/David-Baddeley/pyoptic2/pull/3.diff — Reply to this email directly, view it on GitHub <#3>, or unsubscribe <https://github.com/notifications/unsubscribe-auth/AEUSWYBDMCXKSCLJ4B2D5KLXHYO7BANCNFSM6AAAAAAYNQRYSI> . You are receiving this because you are subscribed to this thread.Message ID: ***@***.***>

[David-Baddeley]

Have just uploaded a very minimal example notebook. Not very polished, but should give some more clues. Will try and upload something with individual surfaces later.