Basic Linting of the repo

[surbhigoel77]

Fixes #4

The PR is to lint the entire repo to improve the quality of the code. Things formatted are in the form of:

• Docstrings
• Blank Lines
• White spaces
• Extra long lines

Type of change

• New feature (non-breaking change which adds functionality)
• Optimization (back-end change that speeds up the code)
• Bug fix (non-breaking change which fixes an issue)
• Documentation

Key checklist

• Make sure you've run the pre-commit checks: $ pre-commit run -a
• All tests pass: $ poetry run pytest

Further checks

• Code is commented, particularly in hard-to-understand areas
• Tests added that prove fix is effective or that feature works

[surbhigoel77]

Using ruff to lint the existing code. One of the most highlighted formatting error is missing docstrings for defined classes and functions.

[surbhigoel77]

Doctsrings have been added to all the classes and existing functions. Restructuring the code may require updating these docstrings accordingly in future.

[jatkinson1000]

All seem sensible so far - mostly formatting changes.

The docstrings are somewhat hybrid at the moment, but we should make sure they conform to the numpy style: https://numpydoc.readthedocs.io/en/latest/format.html
Main one I can spot at the moment is args should be Parameters.

[mondus]

To merge after addition of CI and once Jacks final comments is addressed (internally). Open a new issue on Docstrings so that these can be updated with a bit more detail after #5.

[surbhigoel77]

All seem sensible so far - mostly formatting changes.

The docstrings are somewhat hybrid at the moment, but we should make sure they conform to the numpy style: https://numpydoc.readthedocs.io/en/latest/format.html Main one I can spot at the moment is args should be Parameters.

Not changing this at the moment as the ML code is being refactored. Once that is done, I will update the docstrings acc to the numpy format.

[jatkinson1000]

I realise that this is failing CI, but that's sort of the point of this PR.
I suggest merging now and then working to come towards compliance with the rest of the code, perhaps in #5 and #6 which will require a rebase on top of main once this is merged.