astrolabsoftware / fink-tutorials Goto Github PK

Tutorials and notebooks using Fink API

License: Apache License 2.0

Jupyter Notebook 99.73% Singularity 0.01% Python 0.25% Shell 0.01%

fink-tutorials's Introduction

Fink broker tutorials

This repository contains materials (notebooks & presentation) to explore the Fink broker alert data. As of November 2021, Fink has collected more than 120 million alerts from the ZTF public stream, and processed more than 40 millions (after quality cuts). Among these, you will find extragalatic sources (supernovae, AGN, ...), galactic sources (many classes of transients incl. variables stars from our galaxy or gravitational microlensing events, ...) and moving objects from our Solar System (asteroids, comets, and made-man objects like space-debris!). Some sources are already confirmed, many are candidates!

Materials

The repository contains a number of notebooks focusing on the use of the Fink REST API. We shortly present different science cases:

Extragalactic science: AGN & supernovae (see notebook)
Galactic science: variable stars & microlensing (see notebook)
Solar system science: asteroids, comets & space debris (see notebook)
Solar system science: phase curves (see notebook)
Multi-messenger astronomy: searching for kilonovae (see notebook)
Multi-messenger astronomy: correlating with gravitational waves sky maps (see notebook)
Broker interfaces: presentation on the livestream service, the Science Portal and its API, and the Fink TOM module (see the presentation)

These sciences are not exhaustive and we welcome new collaborations to expand them! In addition, there are notebooks focusing on other specific aspects:

How to tune the output rate of a Fink filter? Example for the Early SN Ia candidate filter (see notebook)

You can try the notebooks using Google Colab (follow the link above). You can also clone the repo, and try it locally (very little external libraries are required).

We also provide a Singularity script to work in a contained environment (thanks @bregeon):

Build with singularity build --fakeroot fink.sif Singularity
Run with singularity run fink.sif
Open the link in your browser (from the host)

How to contribute

How to contribute:

Clone (or fork) this repo, and open a new branch.
Create a new folder with a meaningful name (e.g. supernovae, grb, ...)
Read and copy an existing notebook to get an idea of the structure of a tutorial.
Once your notebook is finished, open a Pull Request such that we review the tutorial and merge it!

fink-tutorials's People

Contributors

Stargazers

Watchers

Forkers

emilleishida bregeon rmartinezra callang258

fink-tutorials's Issues

SSO amateur notebook fink fat presentation

Tutorial on resolvers

To be then added in

fink portal API
news

Something is missing in pyLIMA

When running galactic.ipynb, I got the following import error for pyLIMA.
Even if I install by pip install directly or git clone.
Thanks for having a look at it.

ImportError Traceback (most recent call last)
Cell In[1], line 21
19 from pyLIMA import event
20 from pyLIMA import telescopes
---> 21 from pyLIMA import microlmodels, microltoolbox
22 from pyLIMA.microloutputs import create_the_fake_telescopes
24 import matplotlib.pyplot as plt

ImportError: cannot import name 'microlmodels' from 'pyLIMA' (/Users/dagoret/anaconda3/envs/fink2024/lib/python3.10/site-packages/pyLIMA/init.py)

Bug Report: Inconsistency in Nearest Source Estimation in `dc_mag` Calculation

Hey,

During our work on anomaly detection(cc: Mr. @ManuGangler), we've identified a discrepancy in the calculation of dc_mag.

Nearest Source Estimation Error:
Upon further investigation, we've observed an inconsistency in the nearest source estimation process across filters (red/green) for the same object. Contrary to expectation, in certain cases, we've found that the nearest source varies between filters. This discrepancy arises from instances where noise detection is erroneously classified as a source in one filter but not in the other.

The issue is in: photometry_tutorial.ipynb (refer to [In [6]] section).

Please check this notebook; we explained in detail the error and suggested a modification.

Best regards,

basic conda install instructions

Would the few lines below be of some help, like in a simple "conda_install.txt" file?

# install conda
wget https://repo.anaconda.com/miniconda/Miniconda3-py39_4.9.2-Linux-x86_64.sh
chmod +x Miniconda3-py39_4.9.2-Linux-x86_64.sh
./Miniconda3-py39_4.9.2-Linux-x86_64.sh
source PATH_TO_MINICONDA/miniconda3/etc/profile.d/conda.sh

# create conda env and fill it up
conda config --add channels conda-forge 
conda create --name fink-nb python=3.7
conda activate fink-nb
git clone [email protected]:astrolabsoftware/fink-notebook-template.git
cd fink-notebook-template/
conda install numpy pandas matplotlib gatspy seaborn jupyter requests
pip install fink-science pyLIMA

# run jupyter
jupyter notebook

ZTF photometry: add a notebook to explain how it works

add notebook
update documentation

jupyter nbconvert --to script any_notebook.ipynb
python any_notebook.py

We would just check that there is no error while running the notebook (missing import, crash, etc.)

Update with new Portal URL

We should use https://fink-portal.org instead of the IP (which is still valid though)