/sims_maf_notebooks

Repo with iPython notebooks and other examples for 2015 cadence workshops

This repository contains a set of sims_maf ipython notebooks, demonstrating various uses and capabilities of MAF.

Most of these notebooks assume you have installed and setup the LSST simulations package (sims_maf version >= 1.0). For instructions on installing and setting up MAF see here: https://confluence.lsstcorp.org/display/SIM/MAF+Installation+and+Initial+Examples

These notebooks require the OpSim sqlite database enigma_1189_sqlite.db, it can be downloaded from here: http://ops2.tuc.noao.edu/runs/enigma_1189/data/enigma_1189_sqlite.db.gz

Notebook Summaries

Introductory Notebooks

  • IntroductionNotebook.v3.ipynb: Our introductory notebook, including installation instructions.
  • Slicers.v3.ipynb: Shows how the same metric can be run with three different slicers to produce different outputs.
  • TestNotebook.v3.ipynb: Test that ipython is working and you can load the MAF modules. (Optional notebook, could be useful if you are wondering about ipython and your notebook environment).

Advanced Capabilities

  • Stackers.v3.ipynb: Example of calculating and adding a new column to the OpSim output "on-the-fly" with MAF. Here, we calculate the hour angle of each pointing and then look at the distribution. The Dithers notebook (below) may also be helpful to understand Stackers.
  • UsingMetricBundleData.v3.ipynb: Example of restoring analysis results from disk, and then adjusting and combining plots. The data used in this notebook can be generated by the NVisitsCoadd_AllFilters_DitherComparison.v3.ipynb notebook.
  • WritingNewMetric.v3.ipynb: A guide on how you can write and add your own algorithm into MAF by sub-classing an existing metric.

Static Science Notebooks

Solar System and Astrometry Notebooks

Transient Notebooks

  • TransientMetric.v3.ipynb: Example of our transient metric where you can set a simple transient light-curve shape and set a variety of detection criteria to measure the fraction of such transients LSST can recover.

Variable Notebooks

  • Our variable metrics are in the sims_maf_contrib repo. A notebook example of them can be found here.
  • Time delay lens challenge metrics are in the sims_maf_contrib repo. A notebook example of them can be found here.

etc