Feat: Input validation required fields and angles

NSLS-II-SST / rsoxs_scans

stand alone package for loading and validating RSoXS scans for NSLS-II SST-1 beamline

BSD 3-Clause "New" or "Revised" License

0 stars 0 forks source link

Feat: Input validation required fields and angles #24

Closed BijalBPatel closed 1 year ago

BijalBPatel commented 1 year ago

[x] Implement a check that fields marked 'required' on the spreadsheet have values. This check should be non-blocking and just add a warning.
[x] Add the limits on angles that we discussed on March 9th: Grazing True: 0-90, Grazing False: -14 to 90

EliotGann commented 1 year ago

I'm confused about the "required" you seem to be reading this from the sheet itself? shouldn't we have this as a lookup in the default.py rather than counting on something that can be edited by a user?

BijalBPatel commented 1 year ago

Yeah in hindsight that's better. I didn't even think Abt users editing the documentation rows.

The benefit of pulling it from the sheet is that the rules and public documentation come from the same place (so they can't be mismatched).

It is more error prone this way tho and also it leads to the whole "you don't get validation if you import a sheet without header rows"

Probably better to just put it in defaults then.

EliotGann commented 1 year ago

Those are good points too… I like linking the documentation and defaults somehow…

BijalBPatel commented 1 year ago

Maybe the best would be to have all the header info ( default value , description, limits , type, example, etc) in defaults.py

Then generate the spreadsheet headers from that.

Then the wiki text from that as well.

It's technically possible just a lot of excel wrangling.

EliotGann commented 1 year ago

Ooh. Yeah that shouldn’t be too difficult I think… I can work on that.

On Sun, Mar 12, 2023 at 12:28 PM Bijal B. Patel @.***> wrote:

Maybe the best would be to have all the header info ( default value , description, limits , type) in defaults.py

Then generate the spreadsheet headers from that.

Then the wiki text from that as well.

It's technically possible just a lot of excel wrangling.

— Reply to this email directly, view it on GitHub https://github.com/NSLS-II-SST/rsoxs_scans/issues/24#issuecomment-1465241516, or unsubscribe https://github.com/notifications/unsubscribe-auth/AI7VUOBHLIHH5LWYKEVV5SLW3YBSNANCNFSM6AAAAAAVWTE4J4 . You are receiving this because you commented.Message ID: @.***>