search

CosmoStat / wf-psf

Data-driven wavefront-based PSF modelling framework.
MIT License
19 stars 9 forks source link

Rename SimPSFToolkit.py module #112

Closed jeipollack closed 7 months ago

jeipollack commented 9 months ago

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.

tobias-liaudat commented 9 months ago

Sounds good to me, I like PSFSimulator

jeipollack commented 8 months ago

@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.

jeipollack commented 7 months ago

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.