QuickStartTool

class ctapipe.tools.quickstart.QuickStartTool(**kwargs: Any)

Bases: Tool

Generate quick start files and directory structure.

Attributes Summary

aliases
contact_email	Contact email
contact_name	Contact name
contact_organization	Contact organization
description
examples
name
workdir	working directory where configuration files should be written

Methods Summary

finish()	Finish up.
setup()	Set up the tool.
start()	Main function of the tool.

Attributes Documentation

aliases: StrDict = {('d', 'workdir'): 'QuickStartTool.workdir', ('e', 'email'): 'QuickStartTool.contact_email', ('n', 'name'): 'QuickStartTool.contact_name', ('o', 'org'): 'QuickStartTool.contact_organization'}

contact_email

Contact email

contact_name

Contact name

contact_organization

Contact organization

description: str | Unicode[str, str | bytes] = '\n    Generate quick start files and directory structure.\n    '

examples: str | Unicode[str, str | bytes] = '\n    To be prompted for contact info:\n\n        ctapipe-quickstart --workdir MyProduction\n\n    Or specify it all in the command-line:\n\n        ctapipe-quickstart --name "my name" --email "me@thing.com" --org "My Organization" --workdir Work\n    '

name: str | Unicode[str, str | bytes] = 'ctapipe-quickstart'

workdir

working directory where configuration files should be written

Methods Documentation

finish()

Finish up.

This is called automatically after start when run is called.

setup()

Set up the tool.

This method runs after the configuration and command line options have been parsed.

Here the tool should construct all Components, open files, etc.

start()

Main function of the tool.

This is automatically called after initialize when run is called.