From ae9e7d3ba4548848bee6718e97d9946428103d8e Mon Sep 17 00:00:00 2001 From: Catarina Alves Date: Sat, 10 Jul 2021 13:22:02 +0100 Subject: [PATCH 1/6] The code will now be public and not only used within DESC --- README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/README.md b/README.md index 0dbeb7db..621572dd 100644 --- a/README.md +++ b/README.md @@ -12,7 +12,7 @@ Up-to-date documentation of `snmachine` can be found via the following Github Pa ## Usage Policy -This code is made available within the LSST DESC Collaboration. `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](http://lsstdesc.org/sites/default/files/LSST_DESC_Publication_Policy.pdf)). We are aware that the codebase might be useful within other collaborations and welcome requests for access to the code for non-DESC use. If you wish to use the code outside DESC please submit your request [here](https://docs.google.com/forms/d/e/1FAIpQLSfHKNf-GeIGeRWODtwpVz_byXsUDBYISjlQk5lv1W9M0hgB3g/viewform?usp=sf_link). +`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](http://lsstdesc.org/sites/default/files/LSST_DESC_Publication_Policy.pdf)). ## Contributors From ac2aedde8dd4b91543b7d44db89c0f592616034b Mon Sep 17 00:00:00 2001 From: Catarina Alves Date: Sat, 10 Jul 2021 13:24:15 +0100 Subject: [PATCH 2/6] snmachine is only compatible with python 3 --- README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/README.md b/README.md index 621572dd..4982f16c 100644 --- a/README.md +++ b/README.md @@ -30,6 +30,6 @@ Lochner, M., McEwen, J., Peiris, H., Lahav, O., Winter, M. (2016) “Photometric ## Installation -snmachine is now compatible with Python2 and Python3. +snmachine is compatible Python3. The installation is detailed in the online documentation. ([Install Guide](https://lsstdesc.github.io/snmachine/install.html)): From 6df0ee348e56a9f8739b63f98f125cafb823643d Mon Sep 17 00:00:00 2001 From: Catarina Alves Date: Sat, 10 Jul 2021 13:29:54 +0100 Subject: [PATCH 3/6] Add a link to the release page --- README.md | 6 +++++- 1 file changed, 5 insertions(+), 1 deletion(-) diff --git a/README.md b/README.md index 4982f16c..9aa5aae0 100644 --- a/README.md +++ b/README.md @@ -12,7 +12,11 @@ Up-to-date documentation of `snmachine` can be found via the following Github Pa ## 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](http://lsstdesc.org/sites/default/files/LSST_DESC_Publication_Policy.pdf)). +`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](http://lsstdesc.org/sites/default/files/LSST_DESC_Publication_Policy.pdf)). This software is released with a BSD 3-Clause License. + +## Release + +The list of released versions of this package can be found [here](https://github.com/LSSTDESC/snmachine/releases), with the `dev` branch including the most recent (non-released) development. ## Contributors From 9433ad3bf92e72c9b60e66421e964cb991a5b812 Mon Sep 17 00:00:00 2001 From: Catarina Alves Date: Sat, 10 Jul 2021 13:35:33 +0100 Subject: [PATCH 4/6] Add contributors --- README.md | 5 ++++- 1 file changed, 4 insertions(+), 1 deletion(-) diff --git a/README.md b/README.md index 9aa5aae0..0118dd86 100644 --- a/README.md +++ b/README.md @@ -23,6 +23,9 @@ The list of released versions of this package can be found [here](https://github 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: +Michelle Lochner, Jason McEwen, Hiranya Peiris, Catarina Alves, 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. @@ -34,6 +37,6 @@ Lochner, M., McEwen, J., Peiris, H., Lahav, O., Winter, M. (2016) “Photometric ## Installation -snmachine is compatible Python3. +`snmachine` is compatible with Python3. The installation is detailed in the online documentation. ([Install Guide](https://lsstdesc.github.io/snmachine/install.html)): From dc153ef84767ba2216c57aa530cc35831d945b65 Mon Sep 17 00:00:00 2001 From: Catarina Alves Date: Sat, 10 Jul 2021 13:39:36 +0100 Subject: [PATCH 5/6] Add link to contributions tutorial --- README.md | 4 +++- 1 file changed, 3 insertions(+), 1 deletion(-) diff --git a/README.md b/README.md index 0118dd86..e8fd9642 100644 --- a/README.md +++ b/README.md @@ -23,13 +23,15 @@ The list of released versions of this package can be found [here](https://github 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: +The following people have contributed to snmachine v2.0.0: Michelle Lochner, Jason McEwen, Hiranya Peiris, Catarina Alves, 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](https://github.com/LSSTDESC/snmachine/blob/dev/CONTRIBUTING.md) for a useful guide to contributing to `snmachine`. + ## Citation If you use snmachine in your work please cite ([BibTex](http://adsabs.harvard.edu/cgi-bin/nph-bib_query?bibcode=2016ApJS..225...31L&data_type=BIBTEX&db_key=AST&nocookieset=1)): From 8bc5cc910b7935f0f4b3834ed3fbed3dfa7e4850 Mon Sep 17 00:00:00 2001 From: Catarina Alves Date: Tue, 13 Jul 2021 01:54:51 +0100 Subject: [PATCH 6/6] New snmachine version --- README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/README.md b/README.md index e8fd9642..5170e638 100644 --- a/README.md +++ b/README.md @@ -4,7 +4,7 @@ | ------------- | ------------- | | [![Build Status](https://dev.azure.com/zcicg57/snmachine/_apis/build/status/LSSTDESC.snmachine?branchName=master)](https://dev.azure.com/zcicg57/snmachine/_build/latest?definitionId=3&branchName=master) | [![Build Status](https://dev.azure.com/zcicg57/snmachine/_apis/build/status/LSSTDESC.snmachine?branchName=dev)](https://dev.azure.com/zcicg57/snmachine/_build/latest?definitionId=3&branchName=dev) | -Welcome to version 1.0 of `snmachine`! As described in ([Lochner et al. (2016)](https://arxiv.org/abs/1603.00882)), 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. +Welcome to version 2.0.0 of `snmachine`! As described in ([Lochner et al. (2016)](https://arxiv.org/abs/1603.00882)), 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.