snmachine
main |
dev |
|---|---|
Welcome to version 2.0.0 of snmachine! As described in (Lochner et al. (2016)), this is a flexible python library for reading in photometric supernova light curves, extracting useful features from them and subsequently performing supervised machine learning to classify supernovae based on their light curves. The library is also flexible enough to easily extend to general transient classification.
Up-to-date documentation of snmachine can be found via the following Github Pages link.
Usage Policy
snmachine was developed within the DESC, using DESC resources, and so meets the criteria given in the DESC Publication Policy for being a “DESC product” (DESC Publication Policy). This software is released with a BSD 3-Clause License.
Release
The list of released versions of this package can be found here, with the dev branch including the most recent (non-released) development.
Contributors
The following people have contributed to snmachine v1.0: Michelle Lochner, Robert Schuhmann, Jason McEwen, Hiranya Peiris, Rahul Biswas, Ofer Lahav, Johnny Holland, Max Winter
The following people have contributed to snmachine v2.0.0: Catarina Alves, Hiranya Peiris, Michelle Lochner, Jason McEwen, Tarek Allam Jr, Rahul Biswas, Christian Setzer, Robert Schuhmann
Contributing to snmachine
We welcome developers! Simply fork it into your own private repository and submit a pull request when ready. You can contribute by adding new dataset-reading methods, new feature extraction methods or new classification algorithms. Please create an issue if you have any questions or problems with the code.
See this page for a useful guide to contributing to snmachine.
Citation
If you use snmachine in your work please cite:
-
BibTex: Lochner, M., McEwen, J., Peiris, H., Lahav, O., Winter, M. (2016) “Photometric Supernova Classification with Machine Learning”, The Astrophysical Journal Supplement Series, 225, 31
-
BibTex: Alves, C. S., Peiris, H. V., Lochner, M., McEwen, J. D., Allam Jr, T., & Biswas, R. (2021) "Considerations for optimizing photometric classification of supernovae from the Rubin Observatory", arXiv preprint arXiv:2107.07531.
Installation
snmachine is compatible with Python3.
The installation is detailed in the online documentation. (Install Guide):
Alternativelly, use pip to install snmachine.