feat: logging 0 - add logger configuration and update logging in step 1

[hollandjg]

Hi all, here's a draft of a possibility to add a logger.

The benefits of redirecting the output to stdout are definitely the speed and ease, but I'm worried that it's a bit hacky and might make life less understandable for future developers.
This way gives us a bit more gradation in the output we want or not – the default also hides all the output, but adding --debug or --verbose directly after the icesat2waves like this:

icesat2waves --debug load-file --track-name 20190502052058_05180312_005_01 --batch-key SH_testSLsinglefile2 --output-dir ./output 

... will give more output.

Things which are needed to complete this are (for each file in src/):

• Add import logging
• Add a _logger = logging.getLogger(__name__) after the imports
• replace print and echo with _logger.debug everywhere
• For files you might run manually and want to see the info and debug outputs, add

  if __name__ == "__main__":
      logging.basicConfig(level=logging.WARNING)  # <-- this line
      load_file_app()

  ... which will hide info and debug outputs, and just show any warnings.

[hollandjg]

There are some std output we can do as a feedback to the user on what is happening. For example that the operation finished, or file was saved.

We can totally do that, but I'd do that in a separate PR – this set is large enough and I want to minimize the merge conflicts. But adding an info at the start and the end of each main function in the analysis directory would be neat.

[cpaniaguam]

👍

[kmilo9999]

Looks good

[cpaniaguam]

Thanks for your contributions to this project, John!

I pointed out some files that are not uniformly formatted and a class that is not named according to PEP8 -- I guess it slipped through the cracks.

[cpaniaguam]

This file does not seem to be uniformly formatted. Also, the color class is not named according to PEP8.

[hollandjg]

I've reformatted everything in a follow-on PR #198 – I don't want to deal with the merge conflicts or increase the number of changes here.

• Fixed in chore: reformat all the files using black  #198

[hollandjg]

The color class is indeed not named according to PEP8. Not in scope for this PR – I'll open an issue.

• Rename color class to match PEP8. #199

[kmilo9999]

Looks good to me