Black formatting and workflow integrations

[RemingtonRohel]

Added pre-commit and GitHub workflow integrations for enforcing code standards.

• pre-commit has the following hooks:
  • enforces newline at end of file
  • trims trailing whitespace
  • sorts requirements.txt files
  • checks validity of toml and yaml files
  • reformats code with Black
  • checks for single-backtick usage in .rst files
  • checks for poorly formatted directives in .rst files (double colons)
  • checks for improperly formatted inline code in .rst files
  • removes unused imports in Python files
  • reformats C++ code according to Google style guide
  • runs static analysis of C++ code
• Added two GitHub workflows:
  • Check Python code formatting for Black compatibility on push and pull request
  • Add links to ReadTheDocs build on each PR
• Almost every file has been reformatted by these integrations. To preserve the git blame, the two commits that reformatted Python and C++ files respectively have been added to a .git-blame-ignore-revs file which Git and GitHub respect.
• Added page to documentation about contributing to Borealis.

Most of the dependencies for using pre-commit on a machine can be installed in a virtual environment from the pyproject.toml specification for Borealis; within the Borealis directory, run pip install .[dev]. You will also need to install cppcheck, which can be installed via zypper (or your native package manager).

[tjk584]

I like the overall consistency - 90% of it looks great. There are few instances where the linter changes commands to use multiple lines, making them less readable. If we decide this is our standard, I guess its alright - we'd be consistent at least.

[RemingtonRohel]

See https://black.readthedocs.io/en/stable/the_black_code_style/current_style.html for the rules that Black adheres to when reformatting code

[Doreban]

Looks great! Overall I'm a big fan of the formatting changes. Make sure you have tested to make sure everything works properly though. Run the radar in both release and debug mode, test the scheduler, test the experiments, run any other test scripts we have that are functional, etc...

As long as everything still works properly, I think this will be a very welcome update to the code.

[Doreban]

This one is a bit rough to be split. I'm not sure my suggestion here is doable with black formatting. Maybe if this was changed to a dictionary? It would just be nice to have the --option on the same line as the option value.

Suggested change

	args = [
	"--site_id",
	self.site_id,
	"--experiments",
	line_dict["experiment"],
	"--kwargs",
	line_dict["kwargs"],
	"--module",
	"experiment_unittests",
	]
	args = [
	"--site_id", self.site_id,
	"--experiments", line_dict["experiment"],
	"--kwargs", line_dict["kwargs"],
	"--module", "experiment_unittests",
	]

[RemingtonRohel]

Sorry but that's just the way it works, your suggestion does not pass the pre-commit Black formatting check. This a feature of Black; it has an opinion about how things should be formatted, and it is rigid in enforcing it.

[Doreban]

What happened to this file? I think it's fine, a whole section seems to have been removed so I just want to make sure someone double checks it.

[RemingtonRohel]

Previously this file contained a bunch of results from having run the notebook, which I have removed.

[RemingtonRohel]

I.e. the reformatting didn't touch this file, I did

[RemingtonRohel]

I've tested running normalscan on the lab computer in release and engineeringdebug modes. All unit testing modules (scheduler, config file, experiments, and the realtime simulator) run as expected (with the caveat that the borealis_experiments repo should be on branch config_antennas. Need to merge that to develop and update the submodule commit before merging).