Issue #106: Implement logging module

[Mark2000]

Description

Closes #106

Implements the python logging module. @LorenzzoQM would be interested to hear your opinions about if we should log less/more and what logging levels are appropriate. There's a lot that could be done here, like coloring logs, etc. but this feels like a good minimal product.

How should this pull request be reviewed?

• By commit
• All changes at once

Type of change

• Bug fix (non-breaking change which fixes an issue)
• New feature (non-breaking change which adds functionality)
• Breaking change (fix or feature that would cause existing functionality to not work as expected)

How Has This Been Tested?

Updated tests.

• Unit tests (General Environment only) pytest --cov bsk_rl/envs/general_satellite_tasking --cov-report term-missing tests/unittest
• Integrated tests (General Environment only) pytest --cov bsk_rl/envs/general_satellite_tasking --cov-report term-missing tests/integration

Test Configuration

• Python: 3.10.11
• Basilisk: 2.2.2
• Platform: MacOS

Checklist:

• My code follows the style guidelines of this project (passes Black, ruff, and isort)
• I have performed a self-review of my code
• I have commented my code, particularly in hard-to-understand areas
• I have made corresponding changes to the documentation
• Commit messages are atomic, are in the form Issue #XXX: Message and have a useful message
• My changes generate no new warnings
• I have added tests that prove my fix is effective or that my feature works
• New and existing unit tests pass locally with my changes

[Mark2000]

Pushed fixes that should eliminate erroneous logging. Also fixed the logger when multiple environments are instantiated, sequentially, could still be a problem in parallel applications, like training. Will read up on logging filters and think about it more.

[LorenzzoQM]

I agree with the three log levels; for now, I think they are enough. I also agree with the amount of information being logged at each level. Over time, we can add more if we see it as necessary. This is an excellent feature to have!

[LorenzzoQM]

Do you think adding a color scheme would be interesting to make it easier to identify when it is INFO, DEBUG, or WARNING? Something like blue, brown, and yellow would help (maybe just the words info, debug, and warning), especially when debugging when we have a lot of info (if it is not too much work now).

[LorenzzoQM]

Also, is it worth adding the option to save the log in a file? I can see some cases where it might be useful and easier to use the file than the terminal.

[Mark2000]

Lol I was already working on color scheme when you said this, this is what I just pushed. Not shown in the pic are colors for warnings (yellow) and errors (red)

[Mark2000]

Was considering adding to-file logging, should be pretty easy I think.

[LorenzzoQM]

Excellent! The colors look nice!