Skip to content

Commit 15b3500

Browse files
HeloiseSHeloise Stevancejackleland
authored
Paper ready for submission! (#27)
* first draft paper * update * dunno * paper * updated paper and docs * updated the toml file - copied main over * updated data access section to be shorter * fixed refs i think * bla * updated README * Specify packages to install in setuptools * updated paper text * fixed typos * typo and middle names --------- Co-authored-by: Heloise Stevance <hfstevance@gmail.com> Co-authored-by: Jack Leland <jack.leland@dtc.ox.ac.uk>
1 parent 355248b commit 15b3500

File tree

2 files changed

+89
-22
lines changed

2 files changed

+89
-22
lines changed

paper/paper.bib

Lines changed: 53 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,56 @@
1+
2+
@ARTICLE{soxs,
3+
author = {{Radhakrishnan Santhakumari}, Kalyan Kumar and {Battaini}, Federico and {Di Filippo}, Simone and {Di Rosa}, Silvio and {Cabona}, Lorenzo and {Claudi}, Riccardo and {Lessio}, Luigi and {Dima}, Marco and {Young}, David and {Landoni}, Marco and {Colapietro}, Mirko and {D'Orsi}, Sergio and {Aliverti}, Matteo and {Genoni}, Matteo and {Munari}, Matteo and {Zanmar Sanchez}, Ricardo and {Vitali}, Fabrizio and {Ricci}, Davide and {Schipani}, Pietro and {Campana}, Sergio and {Achren}, Jani and {Araiza-Duran}, Jose and {Arcavi}, Iair and {Baruffolo}, Andrea and {Ben-Ami}, Sagi and {Bitchkovsky}, Alex and {Brucalassi}, Anna and {Bruch}, Rachel and {Capasso}, Giulio and {Cappellaro}, Enrico and {Cosentino}, Rosario and {D'Alessio}, Francesco and {D'Avanzo}, Paolo and {Della Valle}, Massimo and {Di Benedetto}, Rosario and {Gal-Yam}, Avishay and {Hernandez Diaz}, Marcos and {Hershko}, Ofir and {Kotilainen}, Jari and {Kuncarayakti}, Hanindyo and {Li Causi}, Gianluca and {Marafatto}, Luca and {Martinetti}, Eugenio and {Marty}, Laurent and {Mattila}, Seppo and {Micciche}, Antonio and {Nicotra}, Gaetano and {Oggioni}, Luca and {Perez Ventura}, Hector and {Pariani}, Giorgio and {Pignata}, Giuliano and {Rappaport}, Michael and {Riva}, Marco and {Rubin}, Adam and {Salasnich}, Bernardo and {Savarese}, Salvatore and {Scuderi}, Salvatore and {Smartt}, Steven and {Stritzinger}, Maximilian},
4+
title = "{What is your favorite transient event? SOXS is almost ready to observe!}",
5+
journal = {arXiv e-prints},
6+
keywords = {Astrophysics - Instrumentation and Methods for Astrophysics, Astrophysics - Earth and Planetary Astrophysics},
7+
year = 2024,
8+
month = jul,
9+
eid = {arXiv:2407.17288},
10+
pages = {arXiv:2407.17288},
11+
doi = {10.48550/arXiv.2407.17288},
12+
archivePrefix = {arXiv},
13+
eprint = {2407.17288},
14+
primaryClass = {astro-ph.IM},
15+
adsurl = {https://ui.adsabs.harvard.edu/abs/2024arXiv240717288R},
16+
adsnote = {Provided by the SAO/NASA Astrophysics Data System}
17+
}
18+
19+
@INPROCEEDINGS{erasmus2024spie,
20+
author = {{Erasmus}, Nicolas and {Potter}, Stephen B. and {van Gend}, Carel H.~D.~R. and {Loubser}, Egan and {Rosie}, Kathryn and {Titus}, Keegan and {Chandra}, Sunil and {Worters}, Hannah L. and {Gajjar}, Hitesh and {Hlakola}, Moloko and {Julie}, Roufurd},
21+
title = "{Instrumentation at the SAAO for autonomous rapid-response observing}",
22+
booktitle = {Ground-based and Airborne Instrumentation for Astronomy X},
23+
year = 2024,
24+
editor = {{Bryant}, Julia J. and {Motohara}, Kentaro and {Vernet}, Jo{\"e}l. R.~D.},
25+
series = {Society of Photo-Optical Instrumentation Engineers (SPIE) Conference Series},
26+
volume = {13096},
27+
month = jul,
28+
eid = {130968K},
29+
pages = {130968K},
30+
doi = {10.1117/12.3015250},
31+
adsurl = {https://ui.adsabs.harvard.edu/abs/2024SPIE13096E..8KE},
32+
adsnote = {Provided by the SAO/NASA Astrophysics Data System}
33+
}
34+
35+
@software{heloise_2025vra,
36+
author = {Heloise and
37+
genghisken},
38+
title = {HeloiseS/atlasvras: VRA 1.1},
39+
month = mar,
40+
year = 2025,
41+
publisher = {Zenodo},
42+
version = {v1.1},
43+
doi = {10.5281/zenodo.14983116},
44+
url = {https://doi.org/10.5281/zenodo.14983116},
45+
swhid = {swh:1:dir:d58f7330359b6c76e796cc182ac71d0d1524d84f
46+
;origin=https://doi.org/10.5281/zenodo.14363396;vi
47+
sit=swh:1:snp:46746f947d79fd3b95b63ea09ee85fd2e8b3
48+
a397;anchor=swh:1:rel:5af41e199f18b3e1baafe237eb35
49+
1b4dc7d05a62;path=HeloiseS-atlasvras-f64733f
50+
},
51+
}
52+
53+
154
@ARTICLE{class2025arc,
255
author = {{Erasmus}, N. and {Cunnama}, D. and {Potter}, S. and {Stevance}, H.},
356
title = "{SAAO IO Transient Classification Report for 2025-02-04}",
@@ -28,7 +81,6 @@ @ARTICLE{class2025cy
2881
}
2982

3083

31-
3284
@ARTICLE{smith2020,
3385
author = {{Smith}, K.~W. and {Smartt}, S.~J. and {Young}, D.~R. and {Tonry}, J.~L. and {Denneau}, L. and {Flewelling}, H. and {Heinze}, A.~N. and {Weiland}, H.~J. and {Stalder}, B. and {Rest}, A. and {Stubbs}, C.~W. and {Anderson}, J.~P. and {Chen}, T. -W. and {Clark}, P. and {Do}, A. and {F{\"o}rster}, F. and {Fulton}, M. and {Gillanders}, J. and {McBrien}, O.~R. and {O'Neill}, D. and {Srivastav}, S. and {Wright}, D.~E.},
3486
title = "{Design and Operation of the ATLAS Transient Science Server}",

paper/paper.md

Lines changed: 36 additions & 21 deletions
Original file line numberDiff line numberDiff line change
@@ -9,62 +9,77 @@ authors:
99
orcid: 0000-0002-0504-4323
1010
equal-contrib: true
1111
affiliation: "1,2" # (Multiple affiliations must be quoted)
12-
- name: Ken Smith
13-
orcid: 0000-0001-9535-3199
14-
corresponding: true # (This is how to denote the corresponding author)
15-
affiliation: "1,2"
1612
- name: Jack Leland
1713
orcid: 0000-0001-9262-3587
1814
equal-contrib: true # (This is how you can denote equal contributions between multiple authors)
1915
affiliation: 3
16+
- name: Ken W. Smith
17+
orcid: 0000-0001-9535-3199
18+
corresponding: true # (This is how to denote the corresponding author)
19+
affiliation: "1,2"
2020
affiliations:
2121
- name: Astrophysics sub-Department, Department of Physics, University of Oxford, Keble Road, Oxford, OX1 3RH, UK
2222
index: 1
2323
- name: Astrophysics Research Center, Queen's University Belfast, Belfast, BT7 1NN, UK
2424
index: 2
25-
- name: Oxford Research Software Engineering, Doctoral Training Centre, University of Oxford, Keble Road, Oxford, OX1 3RH, UK
25+
- name: Oxford Research Software Engineering Group, Doctoral Training Centre, University of Oxford, Keble Road, Oxford, OX1 3RH, UK
2626
index: 3
27-
date: 17 December 2024
27+
date: 15 May 2025
2828
bibliography: paper.bib
2929

3030
---
3131

3232
# Summary
3333

3434
The Asteroid Terrestrial-impact Last Alert System (ATLAS) is an all-sky optical
35-
sky survey with a cadence of 24 to 48 hours [@tonry2018].
36-
The ATLAS Transient Server [@smith2020] processes the alert stream to enable the discovery
37-
and follow-up of extra-galactic transients.
38-
As part of routine operations, many other types of objects are detected, which are available on the ATLAS transient server.
39-
Accessing these data is done through the ATLAS API.
40-
Here we make available a python client to facilitate the use of tha ATLAS API
41-
and ensure that production codes that make calls to the server can remain
42-
unaffected by internal changes to the API.
35+
sky survey with a cadence of 24 to 48 hours [@tonry2018], and
36+
the ATLAS Transient Server [@smith2020] processes the alert stream to enable the discovery
37+
and follow-up of extra-galactic transients.
38+
The data from the ATLAS server can be accessed through a REST API,
39+
which has allowed the development of bots that need direct access to the data
40+
to help rank alerts and
41+
trigger follow-up observations of promising targets.
42+
Here we present the python client we have developed for the ATLAS API
43+
to help connect bots and scientists to our data.
44+
4345

4446

4547
# Statement of need
4648

47-
`atlasapiclient` is a python client that facilitates the use of the ATLAS API.
49+
50+
`atlasapiclient` is a python client that facilitates the use of the ATLAS REST API.
4851
It provides a class-based interface to all the read-write utilities of the API and
4952
abstracts away the endpoint URLs and the token management.
5053
The `atlasapiclient` was initially designed to be used in our transient
51-
stream processing pipeline, but it can now also be used to connect
54+
stream processing pipeline, particularly for the ATLAS Virtual Research Assistant [@heloise_2025vra],
55+
but it can now also be used to connect
5256
other astronomy projects to the ATLAS data and its stream.
5357
It is currently allowing the follow-up of ATLAS alerts by the Mookodi telescope
54-
in the South African Astronomical Observatory, which has allowed automated triggering
58+
in the South African Astronomical Observatory [@erasmus2024spie], which has allowed automated triggering
5559
and classification of transients within 100 Mpc (e.g. [@class2025arc], [@class2025cy]), since early 2025.
60+
In the future this will allow us to connect our stream to other surveys and
61+
follow-up facilities (e.g. [@soxs])
5662

5763
We expect the API to evolve over time which could break the production codes
58-
that connect to the ATLAS servers.
64+
that connect to the ATLAS servers.
5965
By having a dedicated client package that includes a full set of unit and
60-
integration tests we can mitigate these issues by releasing updates to the client
66+
integration tests we can release updates to the client
6167
that are compatible with the new API but do not require users to change their
6268
existing code.
69+
Decoupling the user's code form the implementation of the API therefore
70+
increases robustness from the users side.
6371

72+
# Data Access
73+
In order to gain access to the servers, prospective users will need to fill a
74+
[Data Request Form](https://forms.gle/Jvy18eejkvxmcN2f6) including
75+
a short (no longer than 1 page) science case justifying their access needs
76+
(length of time; Read-only or Read-Write access).
77+
We have also included data policies compliant with the General Data Protection Regulation (GDPR).
6478

65-
# Acknowledgements
6679

80+
# Acknowledgements
6781
HFS and JL are supported by the Schmidt Sciences foundation.
68-
KS is supported by **[TBD]**.
82+
KS is supported by the Royal Society.
83+
6984

7085
# References

0 commit comments

Comments
 (0)