Feat31 sst1 summarize bp

[BijalBPatel]

Expanded functionality of the summarize_run function in SST1RSiXSDB.py (#31). I believe the signature matches that of the old version, so existing code should remain functional.

New Features:

• Slightly expanded set of preset keyword search terms, made many case-insensitive, made many regex-based.
• Allowed for additional search terms to be provided as keyword arguments, specifying the match method
• If the catalog is reduced to zero, the user is notified which search term failed to match.
• Expanded the variety of metadata that is output to the dataframe and provided a set of preset collections of metadata through the outputType parameter, including scan numbers only
• Allowed for additional output metadata fields to be requested through the userOutputs keyword argument
• Implemented failing gracefully at multiple stages
• Implemented limited 'troubleshooting tips' on bad user input

See signature docstring for full documentation and example functions.

[pbeaucage]

Tagging issue #31 which didn't tag in title, weird. Will take a look soon.

The CI failures appear to be an unrelated issue with Python3.8 and xarray. I will open a separate issue and get those fixed.

[pbeaucage]

One request that explicitly should not hold up merging: would you be willing to write a little how-to, largely adapted from the docstring, in the sphinx docs?

If you can think of any ways this method might be unit-tested it would be good to document them as well. Logistically we actually can't unit test this class until there is a public BNL Tiled server, though we could ask Dan Allan to add a rsoxs example to the public Tiled demonstration server. That wouldn't get us a rsoxs catalog, though. update: you can actually write the test function over in tests/ and then just decorate the functions with @pytest.mark.skip(reason="cannot test until BNL Tiled is public")

[BijalBPatel]

[BijalBPatel]

Woops - sorry for close/opening, meant to just reply to a comment.

[BijalBPatel]

One request that explicitly should not hold up merging: would you be willing to write a little how-to, largely adapted from the docstring, in the sphinx docs?

If you can think of any ways this method might be unit-tested it would be good to document them as well. Logistically we actually can't unit test this class until there is a public BNL Tiled server, though we could ask Dan Allan to add a rsoxs example to the public Tiled demonstration server. That wouldn't get us a rsoxs catalog, though. update: you can actually write the test function over in tests/ and then just decorate the functions with @pytest.mark.skip(reason="cannot test until BNL Tiled is public")

No problem - unless someone else gets to it first, I'll take a crack at the sphinx documentation and tests in a couple of weeks.