Software documentation

There are four levels of documentation below, of increasing detail:

1. Quickstart - for those who just need to calculate predictions of some published model

2. Tutorial - overview of main Gepard functionalities

3. Sections from “Data points, sets and files” to “Fitting theory to data” - in depth manual

4. “Detailed package info” and “Developer info” - for power users and developers

• Installation
  • Installation from sources
  • Requirements
  • Installation in virtual environment
  • Availability within Jupyter
• Quickstart
  • DataPoint
  • Theory
• Tutorial
• Data points, sets and files
  • DataPoint Attributes
  • Coordinate frames
  • Working with datasets
  • Dataset files
• GPDs and form factors
  • Generic Gepard model
  • GPDs
  • CFFs
  • TFFs
  • EFFs
• Processes and observables
  • Processes
  • Observables
• Building the theory
• Fitting theory to data
• Detailed package info
  • 1. Theory framework
  • 2. Perturbative QCD
  • 3. Fitting
  • 4. Utilites
• Developer info
  • Installing package locally
  • Testing and benchmarking
  • Code style
  • Building this documentation site
• TODO items