Add code documentation

[jatkinson1000]

Add docstrings.
Lint with pylint and write according to pydocstyle with numpy convention.

Other documentation?

• ReadMe
• Sphinx?

[jatkinson1000]

I have started adding docstrings as part of the linting and cleaning process.

Once in a sensible state I will open a PR and @arthurBarthe can fill in any scientific information or data that I can't get from reading code.

[jatkinson1000]

PR #17 will Add towards this by adding docstrings, linting, and processing with black.

[jatkinson1000]

Changed this to explicitly address code documentation.
#18 has been opened to deal with project documentation.

[raehik]

#15 added CI which runs pylint, black and pydocstyle. The CI is currently failing because we haven't run these and gone through the report. That can be tracked in #16 .

[arthurBarthe]

I've added most of the docstrings requested. There are conflicts before I can merge with documentation though, and there are a few things I might want to discuss for the remaining docstrings.

[raehik]

I'm closing this issue as it's a little general, and we have matching issues for points discussed so far:

• readme work: Add documentation about how to reproduce the figures from the paper. #59 , Add data and training process to the README.md #48 , Add general project documentation #18
• linting: Run black on all Python code #35 , Lint and format code to follow common conventions #36 , above
• docstrings: above , Annotate code with docstrings; partial code lint #27