CLI

If you do not require a custom implementation of a ParentSample or WISEData but rather want to use the functionality off the shelf then you can easily do so on the command line.

Config File

timewise will read the instructions from a configuration YAML file. All possible keywords are:

Mandatory

  • base_name: The name for your project, determines the output directory in the TIMEWISE_DATA directory

  • filename: Path to a CSV file containing the parent sample

  • instructions: A dictionary containing the methods of WISEData you want to call and the respective arguments

Optional

  • class_name (default= WiseDataByVisit): The name of the WISEData class

  • class_module (default= timewise): The module where class_name is implemented (can be outside of timewise).

  • min_sep_arcsec (default=6): The value for the separation [arcsec] to associate datapoints to a source

  • n_chunks (default=1): The number of chunks in which to split the sample when downloading. If you are looking at sample with <1e5 objects then one chunk is enough!

  • default_keymap (default is ra = ra etc.): A mapping from ra, dec and id to the respective columns in the CSV file

An example is shown below:

base_name: test
filename: <path/to/file>
default_keymap:
 ra: RAdeg
 dec: DEdeg
 id: AllWISE_designation
timewise_instructions:
 - get_photometric_data:
    service: gator
 - plot_lc:
    parent_sample_idx: 0
    service: gator
   plot_diagnostic_binning:
    ind: 0
    service: gator

Command Line Command

To execute the YAML file, invoke the timewise command:

timewise <path/to/yaml/file>