Skip to content

Documentation

Created by: mariaubiali

Outstanding to-do-list

Done

  • Added a link to the docs in the wiki and substitute obsolete wiki pages with new pages on the official documentation @mariaubiali
  • Add list of Git repos to GitHub instructions @voisey
  • Add list of rules for the mailing lists to the doc pages @mariaubiali
  • Add page on documentation on the documentation @siranipour
  • Split up documentation on theory cov. matrix in different pages @RosalynLP
  • Finalise page on how to generate APPLgrids @enocera Add missing tutorial pages:
  • how to compare PDF sets @voisey @siranipour
  • how to get a list of available fits @voisey
  • how to generate a report @voisey @siranipour
  • how to run a fit @JesusUrtasun
  • how to make code reviews @Zaharid
  • n3fit
  • how code testing works in python @Zaharid
  • Add a list of theories and theory specs @voisey
  • Postfit docs that include the selection criteria, how to change them, where they're recorded @voisey
  • validphys --help @RosalynLP
  • Sort out structure of docs - add intros for sections explaining what's in there @RosalynLP @voisey #1121 #1122
  • Move section on filter to a independent section outside of vp-guide @siranipour (decided not to do this)
  • how to add new plotting functionalities in VP @RosalynLP
  • how to include theory covariance matrix in a fit @RosalynLP
  • How to plot PDFs @RosalynLP
  • namespaces @RosalynLP
  • PLOTTING files @siranipour
  • Positivity & integrability implementation in n3fit @tgiani
  • Add links to validphys report tutorial @voisey
  • Fix search bar #1125 @RosalynLP
  • reportengine @Zaharid
  • The reportengine execution model @Zaharid
  • [ ] libnnpdf (we want a light introduction) @wilsonmr
  • reportengine reports @Zaharid
  • General introduction to the code/code layout

To do