Command line tools#

The yet_another_wizz package can be used with a command line tool called yaw_cli. This tool is no longer shipped with the yaw python library, but requires a (separate installation):

pip install yet_another_wizz_cli

Features#

The aim of this command line tool is to cover and automate the most common use cases of computing clustering redshifts and the mitigation of galaxy bias. A few advantages are:

  • Automatic data management in project directories.

  • Automatic summary of the input data and parameters, including a list of applied tasks. This allows to reproduce the results as long as the original input files are available.

  • Event logging for debugging purposes.

  • Batch computing of clustering redshifts from a single configuration file.

Usage#

A first overview of its features can be obtained from the built-in help tool of the main command yaw_cli. This generates a listing of all subcommands with a brief summary of their purpose:

$ yaw_cli --help
usage: yaw_cli [-h] [--version]
               {init,cross,auto,ztrue,cache,merge,zcc,plot,run} ...

yet_another_wizz: modular clustering redshift pipeline.

options:
  -h, --help            show this help message and exit
  --version             show program's version number and exit

modules:
  The pipeline is split into modules which perform specifc tasks as listed
  below. Each module has its own dedicated --help command.

  {init,cross,auto,ztrue,cache,merge,zcc,plot,run}
    init                initialise and configure a new a project directory
    cross               measure angular cross-correlation functions
    auto                measure angular autocorrelation functions
    ztrue               compute true redshift distributions for unknown data
                        (requires point estimate)
    cache               mange or clean up cache directories
    merge               merge correlation measurements from different sources
    zcc                 compute clustering redshift estimates for the unknown
                        data, task can be added repeatedly if different a
                        'tag' is used
    plot                generate automatic check plots
    run                 perform tasks specified in a setup file

Thank you for using yet_another_wizz. Please consider citing 'A&A 642, A200
(2020)' when publishing results obtained with this code.

The details of these subcommands are described in the following sections.

On this page