Skip to content

Latest commit

 

History

History
104 lines (85 loc) · 3.3 KB

README.md

File metadata and controls

104 lines (85 loc) · 3.3 KB
Raw

Source code for

Anomaly detection in the Zwicky Transient Facility DR3

ascl:2106.033 GithHub actions badge

This guide allows you to use the ZTF anomaly detection tool presented by Malanchev et al., 2020.

Package installation

Install current version by

pip install git+https://github.com/snad-space/zwad

Development

Before working with the code, the package should be installed in the development mode:

git clone [email protected]:snad-space/zwad.git
cd zwad
pip install -e .

Data download

Light curve feature data for ZTF DR3 fields used in the research are available on Zenodo. You can download it from the website or by:

cd data
zwad-zenodo

Example

# Run one algorithm
zwadp -c iso --oid oid_m31.dat --feature feature_m31.dat > m31_iso.csv

# zwadp uses only one core by default. Number of parallel
# jobs may be increased with the -j option.
zwadp -c iso -j 4 --oid oid_m31.dat --feature feature_m31.dat > m31_iso.csv

# Run a few more algorithms
for ALGO in iso lof gmm svm; do
  zwadp -c ${ALGO} --oid oid_m31.dat --feature feature_m31.dat > m31_${ALGO}.csv
done

# Combine data-sets:
zwadp -c iso --oid oid_m31.dat --oid fakes/oid_m31_fake.dat --feature feature_m31.dat --feature fakes/feature_m31_fake.dat > m31_iso_fake.csv

# See the help
zwadp -h

Active anomaly detection

Lets use the same data from Zenodo.

cd data
zwad-zenodo

It is better to create temporary directory to run active anomaly detection:

mkdir ../tmp
cd ../tmp
# Run AAD algorithm with M31 dataset
zwaad --random_seed 42 --budget 4 --oid ../data/oid_m31.dat --feature ../data/feature_m31.dat --feature-names ../data/feature_m31.name --anomalies my_anomalies.txt aad

The script output may be as the following:

Check https://ztf.snad.space/dr4/view/695211400088968 for details
Is 695211400088968 anomaly? [y/N]: y

It is waiting for our decision now. Let us decide that 695211400088968 is an anomaly and continue:

Check https://ztf.snad.space/dr4/view/695211400088968 for details
Is 695211400088968 anomaly? [y/N]: y
Check https://ztf.snad.space/dr4/view/695211400053697 for details
Is 695211400053697 anomaly? [y/N]: n
Check https://ztf.snad.space/dr4/view/695211100037499 for details
Is 695211100037499 anomaly? [y/N]: n
Check https://ztf.snad.space/dr4/view/695211200008024 for details
Is 695211200008024 anomaly? [y/N]: y

Now we have examined all four samples within our budget.

# Check found anomalies
cat my_anomalies.txt
695211400088968
695211200008024

Related repositories