Work in progress#

This page will disappear once the documentation is complete.

Statistics guidelines#

For each statistic, we need :

  • A file with

    • a brief description of the statistic (see the article)

    • An explanation of the main features of the code, with code snippets and tips/notes

    • A standard of storage for this statitic (optional)

  • A notebook with an example of how to compute this statitic on a mock data catalog

Custom boxes#

TODO

To note the things to do in the pipeline and doc

Question ?

To note the questions to answer in the pipeline and doc

Project dependant

To note the things that depend on the project and need to be adapted

Some tips for redaction#

Content 1

Content 2

Warning

This is a warning

Note

This is a note

Tip

This is a tip

Other admonitions

Markdown syntax extensions

TODO#

  • Add some emoji (it’s fun ✨) ?

Sections#

  • Getting started

    • Installation

      • Requirements

      • Installation guide

  • Pipeline

    • Overview

    • Galaxy-Halo model

      • Theory

      • Code

    • Statistics

    • Emulator

      • Theory

      • Code (ACM)

    • Inference

  • Code

    • Overview

    • projects (guidelines and organisation)

    • Data storage conventions

    • i/o functions

  • Statistics

    • Densitysplit

    • Others statistics ?

  • Credits

    • Contributors (see readme)

    • Dependencies

    • Citations

  • Tutorials

  • API