Issue/49/delight

examples/HowToDelightPZ.md

@@ -0,0 +1,131 @@
+# DelightPZ README.md
+
+- sylvielsstfr, 
+  - creation date : Feb 24th 2021
+  - update : May 9th 2021
+
+## Delight reference package
+
+- You must have a working Delight package installed.
+
+- Get it from https://github.com/LSSTDESC/Delight
+
+- Then install Delight according the instructions here
+
+- **https://delight.readthedocs.io/en/latest/install.html**
+
+
+Get the Delight data https://github.com/LSSTDESC/Delight/tree/master/data
+
+in some path defined in RAIL config file (see file **DelightPZ.yaml**).
+
+
+
+## LSSTDESC/RAIL
+
+### Installation of RAIL
+
+Installation from here 
+- **https://github.com/LSSTDESC/RAIL**
+
+      git clone git@github.com:LSSTDESC/RAIL.git
+      cd RAIL
+
+
+For the moment, the following files are under developpment in the branch **issue/49/delight**
+
+      git checkout issue/49/delight
+
+
+- **RAIL/examples/configs/delightPZ.yaml**
+- **RAIL/rail/estimation/algos/delightPZ.py**
+- **RAIL/rail/estimation/algos/include_delightPZ/**
+
+Note **include_delightPZ** includes scripts interfaces from Delight.
+
+
+
+      rail
+      ├── README.md
+      ├── __init__.py
+      ├── creation
+      │   ├── README.md
+      │   └── __init__.py
+      ├── estimation
+      │   ├── README.md
+      │   ├── __init__.py
+      │   ├── algos
+      │   │   ├── __init__.py
+      │   │   ├── delightPZ.py
+      │   │   ├── flexzboost.py
+      │   │   ├── include_delightPZ
+      │   │   │   ├── __init__.py
+      │   │   │   ├── calibrateTemplateMixturePriors.py
+      │   │   │   ├── convertDESCcat.py
+      │   │   │   ├── delightApply.py
+      │   │   │   ├── delightLearn.py
+      │   │   │   ├── getDelightRedshiftEstimation.py
+      │   │   │   ├── makeConfigParam.py
+      │   │   │   ├── processFilters.py
+      │   │   │   ├── processSEDs.py
+      │   │   │   ├── simulateWithSEDs.py
+      │   │   │   └── templateFitting.py
+      │   │   ├── randomPZ.py
+      │   │   ├── sklearn_nn.py
+      │   │   └── trainZ.py
+      │   ├── estimator.py
+      │   └── utils.py
+      └── evaluation
+      ├── README.md
+      └── __init__.py
+
+
+### Build RAIL
+
+
+    python setup.py install
+
+
+### Run RAIL
+
+
+- delightPZ generates the configuration file **parametersTest.cfg** required by Delight
+
+The path of the configuration file is defined in **DelightPZ.yaml** (RAIL/example/configs) .
+
+#### RAIL temporay files
+
+The recommended temporary structure in **examples/** directory from where one issue the command to run RAILS with Delight:
+
+    python main.py config/delightPZ.yaml
+
+- Some temporary directories must be created in **examples/** for Delight input and output data.
+
+- The recommended structure is the following
+
+#### For DC2 data
+tree tmp
+
+    tmp
+    ├── delight_data
+    ├── delight_indata
+    │   ├── BROWN_SEDs
+    │   ├── CWW_SEDs
+    │   └── FILTERS
+
+
+
+#### For internal mock data (simulation)
+tree tmpsim
+
+    tmpsim
+    ├── delight_data
+    ├── delight_indata
+    │   ├── BROWN_SEDs
+    │   ├── CWW_SEDs
+    │   └── FILTERS
+
+
+Note the directories BROWN_SEDs, CWW_SEDs, FILTERS must be copied from Delight installation
+https://github.com/LSSTDESC/Delight/tree/master/data .
+

examples/configs/delightPZ.yaml

@@ -0,0 +1,76 @@
+##########################################################################################
+#
+# RAIL configuration file for delightPZ module
+#
+# Steering Delight from RAIL
+# Used on Vera C. Rubin LSST only estimation
+#
+# Author        : Sylvie Dagoret-Campagne
+# Affiliation   : IJCLab/IN2P3/CNRS/France
+# Creation date : March 2021
+# Last update   : May 8th 2021
+#
+############################################################################################
+run_params:
+  class_name: delightPZ
+  run_name: test_delightPZ
+#------------------------------------------------
+# redshift range and binning for delight
+# dlght_ prepend means a parameter used by Delight
+#------------------------------------------------
+  dlght_redshiftMin: 0.01
+  dlght_redshiftMax: 3.01
+  dlght_redshiftNumBinsGPpred: 300
+  dlght_redshiftBinSize: 0.01
+  dlght_redshiftDisBinSize: 0.2
+#-----------------------------------------------
+# Delight input data (Filters and SED templates), note Delight will write inside this directory
+# example recommended:
+# - DC2 mode : dlght_inputdata: "./tmp/delight_indata"
+# - tutorial mode : dlght_inputdata: "./tmpsim/delight_indata"
+#----------------------------------------------
+  dlght_inputdata: "./tmp/delight_indata"
+#---------------------------------------
+# temporary directory for delight work
+# example recommended:
+# - DC2 mode : tempdir: "./tmp" and tempdatadir: "./tmp/delight_data"
+# - tutorial mode : tempdir: "./tmpsim" and tempdatadir: "./tmpsim/delight_data"
+#---------------------------------------
+  tempdir: "./tmp"
+  tempdatadir: "./tmp/delight_data"
+#----------------------------------------
+# delight configuration file filename
+#----------------------------------------
+  delightparamfile: "parametersTest.cfg"
+#------------------------------------------------------------------------
+# Running mode
+# tutorial mode :
+#   - True  : activate internal flux simulation
+#   - False : activate use of DC2 datasets for training and Validation
+#-----------------------------------------------------------------------
+  dlght_tutorialmode: False
+#------------------------------------------------------------------------
+# Filtering of training and Validation dataset
+# according flux SNR
+#-------------------------------------------------------------------------
+  flag_filter_training: True
+  snr_cut_training: 5
+  flag_filter_validation: True
+  snr_cut_validation: 3
+#-----------------------------------------------------------------------
+# Special run
+# Should not be used
+#-------------------------------------------------------------------------
+  dlght_calibrateTemplateMixturePrior: False
+#-------------------------------------------------------------------------
+# Delight hyper-parameters that must be optimized
+#---------------------------------------------------------------------------
+  zPriorSigma: 0.2
+  ellPriorSigma: 0.5
+  fluxLuminosityNorm: 1.0
+  alpha_C: 1.0e3
+  V_C: 0.1
+  alpha_L: 1.0e2
+  V_L: 0.1
+  lineWidthSigma: 20
+