lsst-uk / lasair-project-management

Event handling site for LSST:UK
Apache License 2.0
9 stars 0 forks source link

Write Sherlock documentation #66

Closed andyxerxes closed 4 years ago

andyxerxes commented 4 years ago

Aimed at the user. Integration into Lasair website in separate card.

smarttgit commented 4 years ago

What this specifically means for now is

Create a tab on the left hand bar on https://lasair.roe.ac.uk/ called "Sherlock"

Link this to a new page with the following text.

Sherlock Version 2.0

Sherlock is a software package and integrated massive database system that provides a rapid and reliable spatial cross-match service for any astrophysical variable or transient. The concept originated in the PhD thesis of D. Young at QUB, and has been developed by Young et al. in many iterations and cycles since. It associates the position of a transient with all major astronomical catalogues and assigns a basic classification to the transient. At its most basic, it separates stars, AGN and supernova-like transients. It has been tested within QUB on a daily basis with ATLAS and Pan-STARRS transients, and within PESSTO as part of the PESSTO marshall system that allows prioritising of targets. It is thus a boosted decision tree algorithm. A full paper describing the code, catalogues and algorithms is in preparation (Young et al. in prep). A summary is included in Section 4.2 of "Design and Operation of the ATLAS Transient Science Server" (Smith, Smartt, Young et al. 2020, submitted to PASP : https://arxiv.org/abs/2003.09052). We label the current version as the official release of Sherlock 2.0. The major upgrade from previous versions are that it includes Pan-STARRS DR1 (including the Tachibana & Miller 2018 star-galaxy separation index) and Gaia DR2 catalogues, along with some adjustments to the ranking algorithm.

That section is copied here and users should currently cite that paper (Smith et al. 2020) for Sherlock use :

Relevant part of Section 4.2 of Smith et al (paraphrased in some cases) :

Sherlock: Once an object ..... Ken - copy in the text here from the paper. You may have to adjust and remove references to Tables/Figures etc

The code for Sherlock is public ADD GITHUB LINK HERE but the code requires access to a number of large databases which are custom built from their original, public, releases. The latter is proprietary and therefore would require some effort from users to reproduce. As part of the Lasair project we are exploring public access to the integrated Sherlock code and database information through an API.

Sherlock 2.0 was reviewed as a LSST:UK Deliverable in March 2020. The review noted that an algorithm enhancement would be to take into account stellar proper motions, since some proper motion stars will be variable and if cross-matched with a static catalogue will fall outside the nominal match radius. This is an enhancement we will take forward for future versions.

genghisken commented 4 years ago

Actually I've made good progress with the overleaf conversion of the STANDALONE Sherlock document into HTML I need to merge it with the text above. When I've got it ready I'll need Roy to put it in the right place, since the Lasair web code is currently deployed under his account.

genghisken commented 4 years ago

The HTML is now written and I've committed the changes to Lasair. Roy just needs to do a git pull and restart the webserver. I can't see if there are issues until the updated web pages (and image) are deployed!

RoyWilliams commented 4 years ago

Its now in github, lasair, and lasair-dev. I also replaced several links in /schema and /about from readthedocs to /sherlock. Can you check if it all looks OK?

genghisken commented 4 years ago

Looks fine! Thanks Roy! There's at least one more link to the readthedocs pages on the Filters & Queries page...

smarttgit commented 4 years ago

Could we make this bold font:

That section is copied here and users should currently cite that paper (Smith et al. 2020) for Sherlock use:

And also add the link to https://arxiv.org/abs/2003.09052 in the sentence.

Otherwise, this is closed and done.

genghisken commented 4 years ago

Changes made and checked in. Roy - feel free to do another git pull on both the lasair and lasair-dev webservers. You do NOT need to restart the webserver. (It's just a template change.)

RoyWilliams commented 4 years ago

done

genghisken commented 4 years ago

Can you roll it out to live as well! (I can see it on lasair-dev OK.)

andyxerxes commented 4 years ago

as matter of principle we should not roll it to live until we have done our “readiness review” tomorrow

andy


Andy Lawrence : Regius Professor of Astronomy, University of Edinburgh Institute for Astronomy, Royal Observatory, Blackford Hill, Edinburgh, EH9 3HJ Email al@roe.ac.uk / Phone +44-(0)131-668-8346 / Skype andyxlawrence

The University of Edinburgh is a charitable body, registered in Scotland, with registration number SC005336.

On 7 Apr 2020, at 14:31, genghisken notifications@github.com wrote:

Can you roll it out to live as well! (I can see it on lasair-dev OK.)

— You are receiving this because you authored the thread. Reply to this email directly, view it on GitHub, or unsubscribe.

genghisken commented 4 years ago

OK

genghisken commented 4 years ago

I've changed the "Sherlock" link to "Classification and Annotation" and added a couple of sentences at the beginning of the Sherlock page, which is now also headed "Classification and Annotation." Roy - can you do a git pull on lasair-dev? Everyone else - feel free to comment and I'll integrate any further changes. No need to restart the webserver - changes are in the template docs only.