Skip to content

Package to interact with `LSST` `OpSim` outputs for simulations of Time Domain Astronomy objects.

License

Notifications You must be signed in to change notification settings

LSSTDESC/OpSimSummary

Repository files navigation

Build Status DOI

OpSimSummary is a codebase developed to interact with the LSST Operations Simulator outputs. Currently they are used for catalog Time Domain Simulations. This includes a library that can be called by simulation codes to obtain the set of LSST pointings observing a particular point, as well as a script which uses the library and precomputes such pointings and store them in an observation library. This storage is in a format specific to SNANA

Using OpSimSummary

OpSimSumamry is open source and licensed under BSD 3-clause. While a release is available at zenodo the software will continue to be developed as needed in this github repository. If you plan to use a released version on zenodo, you can cite the specific release (for example the current release using the doi (for example see the Export section of the zenodo page for the release.) Alternatively, you can cite the a specific non-release version on the github repository through the git SHA.

Additionally, in both cases, please cite the code paper. If you are using bibtex, NASA ADS provides a bibtex for this reference (as also other formatted forms).

  • Documentation is hosted at github_pages. The overview section has snippets for the use as an API as well as documentation of the script needed to create SNANA simlib files. (This is described in greater detail in the a demo notebook)

Installation and Software Requirements

opsimsummary runs on python 3.6+ . The list of required software to run opsimsummary is listed here. For installation methods, please see the documentation