helenqu / scone

SCONE: Supernova Classification with a Convolutional Neural Network

This repository contains the code for SCONE (original paper, applied to early-time supernova lightcurves), a convolutional neural network-based framework for photometric supernova classification.

Installation

git clone this repository!

Requirements

Tensorflow/Keras, Astropy, George, Pandas, Numpy, Scipy requirements.txt coming soon!

Overview

SCONE classifies supernovae (SNe) by type using multi-band photometry data (lightcurves)

Input Data

SCONE takes in supernova (SN) photometry data in the format output by SNANA simulations. Photometry data must be separated into two types of files: metadata and observation data.

Multiple metadata and observation data files are acceptable (and preferred for large datasets), but there should be a 1-1 correspondence between metadata and observation data files, i.e. the observation data for all objects in a particular metadata file should exist in a single corresponding observation file.

Filenames

Identifying corresponding metadata and observation data files is done through the naming scheme: metadata and observation data files must have the same filename except metadata filenames must include HEAD and observation files must include PHOT.

i.e. metadata filename: SN_01_HEAD.FITS, corresponding observation data filename: SN_01_PHOT.FITS

Metadata Format

Metadata is expected in FITS format with a minimum of the following columns:

• SNID: int, a unique ID for each SN that will be used to cross-reference with the observation data
• SNTYPE: int, representation of the true type of the SN
• PEAKMJD: float, the time of peak flux for the SN in Modified Julian Days (MJD)
• MWEBV: float, milky way extinction Optional:
• REDSHIFT_FINAL: float, redshift of the SN
• REDSHIFT_FINAL_ERR: float, redshift error

Observation Data Format

Observation data is expected in FITS format with a minimum of the following columns:

• SNID: int, a unique integer ID for each SN that will be used to cross-reference with the metadata
• MJD: float, the time of the observation, in Modified Julian Days (MJD)
• FLT: string, filter used for the observation (i.e. 'u', 'g')
• FLUXCAL: float, the observed flux
• FLUXCAL_ERR: float, the error on the observed flux

Quickstart

1. Write a configuration file in YAML format

Required fields:

• Either:
  • input_path (parent directory of the PHOT and HEAD files mentioned above), or
  • a list of metadata_paths + a list of lcdata_paths (absolute paths to the HEAD and PHOT files mentioned above, respectively)
• heatmaps_path: desired output directory where the heatmaps will be written to
• mode: string, train or predict
• num_epochs: int, number of epochs to train for (400 in all paper results)

Optional fields:

• sn_type_id_to_name: mapping between integer SN type ID to string name, i.e. SNII, defaults to SNANA default values
• class_balanced: true/false, whether you want class balancing to be done for your input data, defaults to false
• categorical: true/false, whether you are doing categorical (by type) classification, defaults to false (i.e. binary Ia vs. non-Ia classification)
• max_per_type: int, maximum number of lightcurves per type to keep when performing class balancing (class balancing will take the number of the least abundant class if max_per_type not specified)
• with_z: true/false, classification with/without redshift information (note that the redshift information for each lightcurve has to be included when making heatmaps, just this option = true is not enough)
• trained_model: path, load in a trained model to do prediction with it (goes with mode: predict)

2. Run create_heatmaps/run.py to make heatmaps from your data

python {/path/to/scone/}create_heatmaps/run.py --config_path {/path/to/config} Simply fill in the path to the config file you wrote in the previous step! This script reads the config file, performs class balancing if desired, and launches jobs to create heatmaps using sbatch.

Note: So far this only works on NERSC! If a different computing system is desired, contact [e-mail].

3. When the heatmaps are successfully made, run run_model.py to run the model on your new heatmaps

python {/path/to/scone}/run_model.py --config_path {/path/to/config}

Note: So far this only works on NERSC! If a different computing system is desired, contact [e-mail].

Use with Pippin

coming soon!