Documentation To-Do

Things that need doing, or doing better:

  • Write a decent to-do list

  • Create pages for all classes

  • Work out what a ‘module index’ is, and if we want one

  • Create + properly document the Efficiency Vector class

  • Document the private members of LogLikelihood

  • Document the Likelihood Data class

  • Document the Probability Functions

  • Document the Misc functions

  • Document the LogLikelihoodPrior

  • Document the Descent Functor class

  • Document the Star class

  • Document all GlobalVariables

  • Document the DataLoading functions

  • Document the starAllocation script

  • Write an example-usage page

  • Link to paper in Background

  • Get full definitions of needlet_u vector from Douglas

  • Complete the probability model description in Background

  • How are the stellar observation lists generated / where can they be retrieved from?

  • I’m not a 100% sure on what needlets and needlet-mappings do in Code Inputs, would be nice to get confirmation of that

  • Write a more in-depth description of the spatial forward and backward transforms

  • Code output page

  • Document + clean up the Optimiser

  • Document parallelisation scheme

  • Document minibatching scheme