Skip to content
AleCandido edited this page May 21, 2020 · 7 revisions

Mainly used for docs ToDo

Plan

Structure of the docs:

  • Introduction, informations and general descriptions
  • docstrings
  • tutorials
  • dev guides
    • how to use the benchmark tools
    • whatever we spend enough time to implement

ToDo

  • coefficient functions references
  • heavy flavours
    • theory, main
  • scale variations
    • implementation (ESF), docstrings
    • references, docstrings
    • theory, main
  • TMC
    • implementation, docstrings
    • references, docstrings
    • theory, main
  • convolution
    • theory (convolution -> integration conversion, distributions description), main
  • interpolation
    • very brief description (lagrange in logx) and eko reference, main
    • interpolation in dis and comparison with other tools (apfel & lhapdf), main
  • Package Structure
    • overall description, main
    • brief summary of each class (or group of classes), main
    • ESF, docstrings
    • ESFResult, docstrings
    • StructureFunction, docstrings
    • Output, docstrings
    • Runner, docstrings

Refactor

Currently the docs are full of cut&pasted elements (in particular the docstring in the code), so it would be great to find a comfortable way to factorize instead of repeating (DRY).