Rename SimPSFToolkit.py module

Question

Rename SimPSFToolkit.py module

jeipollack opened this issue 9 months ago · 3 comments

The module named SimPSFToolkit is too similar in name as the OU-SHE PSF code. This is bound to cause confusion (I was confused when I first started). I would like to propose changing the name of the module to something like PSFBuilder, PSFSimulator, etc.

Answer 1 · 2024-01-30T13:45:45.000Z

Sounds good to me, I like PSFSimulator

Answer 2 · 2024-02-05T06:49:28.000Z

@nadamoukaddem can you open a new branch to change the name of the SimPSFToolkit.py module and class to PSFSimulator? Note, you have to update all package and class imports throughout the codebase including unit tests. Make sure to run tests to ensure no breaking behaviour.

Answer 3 · 2024-03-04T19:19:13.000Z

Actually to follow PEP8 style rules, class names should be CapWords and module names should have short lower case names with underscores to improve readability. So please rename the module: psf_simulator.py and use PSFSimulator for the class name. Thanks.