Astronomy units for the Ampel system to analyze nuclear events like TDEs
Project description
Ampel-nuclear
Central repository to host AMPEL code to search for and analyze nuclear transients. At the moment, this is exclusively code from the ZTFbh science working group.
Installation
Prerequisites
You need to export environment variables for the AMPEL ZTF archive (tokens are available here), for Fritz, and for the dropbox API (ask Sjoert).
Furthermore, you need a running instance of MongoDB.
Setup
Create a fresh Python 3.10 conda env
conda create -n tde_filter_upgrade python=3.10
conda activate tde_filter_upgrade
Install is done via poetry:
pip install poetry
git clone https://github.com/AmpelProject/ampel-nuclear
cd Ampel-nuclear
poetry install
Now we have to build the ampel config. Issue
ampel config build -out ampel_conf.yaml
Note: this will throw some import errors, but you can ignore these because those packages are not needed locally.
Now you need to export the following tokens
export AMPEL_ARCHIVE_TOKEN=''
export DROPBOX_TOKEN=''
export FRITZ_TOKEN=''
Test
To run the test, start your local MongoDB. And then issue
./run_tde_scan.py -i
The -i
initiates (and saves) a new archive API stream token. To change the date, use -d YYYY-MM-DD
for a certain day. The script will request alerts for the 24 hours after this date.
Note: When requesting a full day with -d
from the archive, the first run will probably fail, as the archive database has not fully ramped up yet (URL is locked
). In this case, just rerun ./run_tde_scan.py -d YYYY-MM-DD
(without i
to prevent requesting a new stream token and overwriting the current one) until the archive starts serving alerts (you will see them getting ingested).
To check the output, go to the temp
directory that gets created when script is run without -p
(push to dropbox).
To see all available commands of the test script, run ./run_tde_scan.py -h
.
Project details
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
Built Distribution
Hashes for ampel_nuclear-0.8.3a0-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 937ec790648d6b2d42cb0c8c45b3fd16834c80ae169ea784fb43081bb4e7a640 |
|
MD5 | b19a8f7d1990fc80e00f0379cc93e9dd |
|
BLAKE2b-256 | 7e7d6408eab861ee1f3d472c7f826b0ce8b50757ee1b1c9ae5cf3c81468d89d7 |