Review - Documentation

[jwagemann]

• We see you plan to document functions using sphinx, it would be good to have some basic doc files already

• Notebooks are barely commented, could you please expand on the reasons behind the different steps? Ideally, each notebook should be self explanatory (like a stand-alone tutorial).

[tommylees112]

Which notebooks are you referring to?

The notebooks in notebooks/draft are more for internal visualisations and testing the use of the pipeline.

Are the notebooks in notebooks/docs better commented?

[tommylees112]

We see you plan to document functions using sphinx, it would be good to have some basic doc files already

Please see the branch: docs/sphinx. We’ve done our best to ensure all the classes and functions which we intend to expose have good docstrings, so a lot of the functionality can be exposed using the help function.

In addition, the major steps of the pipeline - and the appropriate code to run them - is in the scripts directory, along with an accompanying readme.