diff --git a/README.md b/README.md index 6f940bd..90f3ebf 100644 --- a/README.md +++ b/README.md @@ -6,21 +6,12 @@ This repository contains materials (notebooks & presentation) to explore the [Fi ## Materials -The repository contains a number of notebooks focusing on the use of the Fink REST API. We shortly present different science cases: +The repository contains a number of notebooks focusing on the use of the Fink REST API for two different surveys: LSST and ZTF. +- LSST: The Vera C. Rubin Legacy Survey of Space and Time. Fink is one of the Fink Community Brokers processing LSST data from 2026. +- ZTF: Zwicky Transient Facility. Fink has been processing data from ZTF since November 2019. -- Extragalactic science: AGN & supernovae ([see notebook](extragalactic/extragalactic.ipynb)) -- Galactic science: variable stars & microlensing ([see notebook](galactic/galactic.ipynb)) -- Solar system science: asteroids, comets & space debris ([see notebook](sso/sso.ipynb)) -- Solar system science: phase curves ([see notebook](sso/fink_sso_imcce.ipynb)) -- Multi-messenger astronomy: searching for kilonovae ([see notebook](MMA/MMA.ipynb)) -- Multi-messenger astronomy: correlating with gravitational waves sky maps ([see notebook](MMA/gravitational_waves.ipynb)) -- Broker interfaces: presentation on the livestream service, the Science Portal and its API, and the Fink TOM module ([see the presentation](interfaces/README.md)) -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](extragalactic/tuning_snia_output_rate.ipynb)) - -You can try the notebooks using Google Colab (follow the link above). You can also clone the repo, and try it locally. Most notebooks will work with any Python verson higher than 3.5, except the one on [microlensing](galactic/galactic.ipynb) which requires Python < 3.12 due to dependencies. We advise to work on a virtual environment: +You can try the notebooks using Google Colab (follow the link above). You can also clone the repo, and try it locally. Most notebooks will work with any Python verson higher than 3.5, except the one on [ZTF microlensing](ztf/galactic/galactic.ipynb) which requires Python < 3.12 due to dependencies. We advise to work on a virtual environment: ``` python -m venv myenv diff --git a/lsst/README.md b/lsst/README.md new file mode 100644 index 0000000..9a16b1f --- /dev/null +++ b/lsst/README.md @@ -0,0 +1,38 @@ +# Fink broker tutorials + +[![Open In Colab](https://colab.research.google.com/assets/colab-badge.svg)](https://colab.research.google.com/github/astrolabsoftware/fink-notebook-template/blob/main) + +This repository contains materials (notebooks & presentation) to explore the [Fink broker](https://fink-broker.org) alert data from Vera C. Rubin Legacy Survey of Space and Time (LSST). + +## Materials + +The repository contains a number of notebooks focusing on the use of the Fink LSST REST API. + +You can try the notebooks using Google Colab (follow the link above). You can also clone the repo, and try it locally. Most notebooks will work with any Python verson higher than 3.5. We advise to work on a virtual environment: + +``` +python -m venv myenv +source myenv/bin/activate + +pip install -r requirements.txt +# ... wait a bit + +jupyter-notebook +# play with notebooks +``` + +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! diff --git a/MMA/MMA.ipynb b/ztf/MMA/MMA.ipynb similarity index 100% rename from MMA/MMA.ipynb rename to ztf/MMA/MMA.ipynb diff --git a/MMA/gravitational_waves.ipynb b/ztf/MMA/gravitational_waves.ipynb similarity index 100% rename from MMA/gravitational_waves.ipynb rename to ztf/MMA/gravitational_waves.ipynb diff --git a/ztf/README.md b/ztf/README.md new file mode 100644 index 0000000..6f940bd --- /dev/null +++ b/ztf/README.md @@ -0,0 +1,50 @@ +# Fink broker tutorials + +[![Open In Colab](https://colab.research.google.com/assets/colab-badge.svg)](https://colab.research.google.com/github/astrolabsoftware/fink-notebook-template/blob/main) + +This repository contains materials (notebooks & presentation) to explore the [Fink broker](https://fink-broker.org) alert data. As of November 2024, Fink has processed more than 180 millions alerts from the ZTF public alert stream. 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](extragalactic/extragalactic.ipynb)) +- Galactic science: variable stars & microlensing ([see notebook](galactic/galactic.ipynb)) +- Solar system science: asteroids, comets & space debris ([see notebook](sso/sso.ipynb)) +- Solar system science: phase curves ([see notebook](sso/fink_sso_imcce.ipynb)) +- Multi-messenger astronomy: searching for kilonovae ([see notebook](MMA/MMA.ipynb)) +- Multi-messenger astronomy: correlating with gravitational waves sky maps ([see notebook](MMA/gravitational_waves.ipynb)) +- Broker interfaces: presentation on the livestream service, the Science Portal and its API, and the Fink TOM module ([see the presentation](interfaces/README.md)) + +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](extragalactic/tuning_snia_output_rate.ipynb)) + +You can try the notebooks using Google Colab (follow the link above). You can also clone the repo, and try it locally. Most notebooks will work with any Python verson higher than 3.5, except the one on [microlensing](galactic/galactic.ipynb) which requires Python < 3.12 due to dependencies. We advise to work on a virtual environment: + +``` +python -m venv myenv +source myenv/bin/activate + +pip install -r requirements.txt +# ... wait a bit + +jupyter-notebook +# play with notebooks +``` + +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! diff --git a/events/2022/README.md b/ztf/deprecated_events/2022/README.md similarity index 100% rename from events/2022/README.md rename to ztf/deprecated_events/2022/README.md diff --git a/events/2022/bayestar.fits.gz b/ztf/deprecated_events/2022/bayestar.fits.gz similarity index 100% rename from events/2022/bayestar.fits.gz rename to ztf/deprecated_events/2022/bayestar.fits.gz diff --git a/events/2022/images/rest_api.png b/ztf/deprecated_events/2022/images/rest_api.png similarity index 100% rename from events/2022/images/rest_api.png rename to ztf/deprecated_events/2022/images/rest_api.png diff --git a/events/2022/mycatalog.csv b/ztf/deprecated_events/2022/mycatalog.csv similarity index 100% rename from events/2022/mycatalog.csv rename to ztf/deprecated_events/2022/mycatalog.csv diff --git a/events/2022/rest_api_how_to.ipynb b/ztf/deprecated_events/2022/rest_api_how_to.ipynb similarity index 100% rename from events/2022/rest_api_how_to.ipynb rename to ztf/deprecated_events/2022/rest_api_how_to.ipynb diff --git a/events/2022/supernova.ipynb b/ztf/deprecated_events/2022/supernova.ipynb similarity index 100% rename from events/2022/supernova.ipynb rename to ztf/deprecated_events/2022/supernova.ipynb diff --git a/events/2022/xmatch.ipynb b/ztf/deprecated_events/2022/xmatch.ipynb similarity index 100% rename from events/2022/xmatch.ipynb rename to ztf/deprecated_events/2022/xmatch.ipynb diff --git a/events/2022/zooniverse_template.py b/ztf/deprecated_events/2022/zooniverse_template.py similarity index 100% rename from events/2022/zooniverse_template.py rename to ztf/deprecated_events/2022/zooniverse_template.py diff --git a/extragalactic/extragalactic.ipynb b/ztf/extragalactic/extragalactic.ipynb similarity index 100% rename from extragalactic/extragalactic.ipynb rename to ztf/extragalactic/extragalactic.ipynb diff --git a/extragalactic/tuning_snia_output_rate.ipynb b/ztf/extragalactic/tuning_snia_output_rate.ipynb similarity index 100% rename from extragalactic/tuning_snia_output_rate.ipynb rename to ztf/extragalactic/tuning_snia_output_rate.ipynb diff --git a/gaia/Fink_Gaia_alerts.ipynb b/ztf/gaia/Fink_Gaia_alerts.ipynb similarity index 100% rename from gaia/Fink_Gaia_alerts.ipynb rename to ztf/gaia/Fink_Gaia_alerts.ipynb diff --git a/gaia/gaia_xmatch.csv b/ztf/gaia/gaia_xmatch.csv similarity index 100% rename from gaia/gaia_xmatch.csv rename to ztf/gaia/gaia_xmatch.csv diff --git a/galactic/galactic.ipynb b/ztf/galactic/galactic.ipynb similarity index 100% rename from galactic/galactic.ipynb rename to ztf/galactic/galactic.ipynb diff --git a/galactic/legacy/Gaia.dat b/ztf/galactic/legacy/Gaia.dat similarity index 100% rename from galactic/legacy/Gaia.dat rename to ztf/galactic/legacy/Gaia.dat diff --git a/galactic/legacy/README.md b/ztf/galactic/legacy/README.md similarity index 100% rename from galactic/legacy/README.md rename to ztf/galactic/legacy/README.md diff --git a/galactic/legacy/ZTF18abktckv.ipynb b/ztf/galactic/legacy/ZTF18abktckv.ipynb similarity index 100% rename from galactic/legacy/ZTF18abktckv.ipynb rename to ztf/galactic/legacy/ZTF18abktckv.ipynb diff --git a/galactic/legacy/ml_fit.png b/ztf/galactic/legacy/ml_fit.png similarity index 100% rename from galactic/legacy/ml_fit.png rename to ztf/galactic/legacy/ml_fit.png diff --git a/galactic/rrlyr_fit.png b/ztf/galactic/rrlyr_fit.png similarity index 100% rename from galactic/rrlyr_fit.png rename to ztf/galactic/rrlyr_fit.png diff --git a/galactic/rrlyr_search.png b/ztf/galactic/rrlyr_search.png similarity index 100% rename from galactic/rrlyr_search.png rename to ztf/galactic/rrlyr_search.png diff --git a/interfaces/README.md b/ztf/interfaces/README.md similarity index 100% rename from interfaces/README.md rename to ztf/interfaces/README.md diff --git a/interfaces/home.png b/ztf/interfaces/home.png similarity index 100% rename from interfaces/home.png rename to ztf/interfaces/home.png diff --git a/interfaces/infrastructure.png b/ztf/interfaces/infrastructure.png similarity index 100% rename from interfaces/infrastructure.png rename to ztf/interfaces/infrastructure.png diff --git a/interfaces/search.png b/ztf/interfaces/search.png similarity index 100% rename from interfaces/search.png rename to ztf/interfaces/search.png diff --git a/interfaces/skymap.png b/ztf/interfaces/skymap.png similarity index 100% rename from interfaces/skymap.png rename to ztf/interfaces/skymap.png diff --git a/interfaces/sn_view.png b/ztf/interfaces/sn_view.png similarity index 100% rename from interfaces/sn_view.png rename to ztf/interfaces/sn_view.png diff --git a/interfaces/sso_view.png b/ztf/interfaces/sso_view.png similarity index 100% rename from interfaces/sso_view.png rename to ztf/interfaces/sso_view.png diff --git a/interfaces/table.png b/ztf/interfaces/table.png similarity index 100% rename from interfaces/table.png rename to ztf/interfaces/table.png diff --git a/interfaces/tom_button.png b/ztf/interfaces/tom_button.png similarity index 100% rename from interfaces/tom_button.png rename to ztf/interfaces/tom_button.png diff --git a/interfaces/tom_form.png b/ztf/interfaces/tom_form.png similarity index 100% rename from interfaces/tom_form.png rename to ztf/interfaces/tom_form.png diff --git a/interfaces/topic_monitor.png b/ztf/interfaces/topic_monitor.png similarity index 100% rename from interfaces/topic_monitor.png rename to ztf/interfaces/topic_monitor.png diff --git a/interfaces/view.png b/ztf/interfaces/view.png similarity index 100% rename from interfaces/view.png rename to ztf/interfaces/view.png diff --git a/photometry/forcedphotometry_req00100242_lc.txt b/ztf/photometry/forcedphotometry_req00100242_lc.txt similarity index 100% rename from photometry/forcedphotometry_req00100242_lc.txt rename to ztf/photometry/forcedphotometry_req00100242_lc.txt diff --git a/photometry/forcedphotometry_req00149191_lc.txt b/ztf/photometry/forcedphotometry_req00149191_lc.txt similarity index 100% rename from photometry/forcedphotometry_req00149191_lc.txt rename to ztf/photometry/forcedphotometry_req00149191_lc.txt diff --git a/photometry/forcedphotometry_req00229009_lc.txt b/ztf/photometry/forcedphotometry_req00229009_lc.txt similarity index 100% rename from photometry/forcedphotometry_req00229009_lc.txt rename to ztf/photometry/forcedphotometry_req00229009_lc.txt diff --git a/photometry/photometry_tutorial.ipynb b/ztf/photometry/photometry_tutorial.ipynb similarity index 100% rename from photometry/photometry_tutorial.ipynb rename to ztf/photometry/photometry_tutorial.ipynb diff --git a/resolvers/resolver.ipynb b/ztf/resolvers/resolver.ipynb similarity index 100% rename from resolvers/resolver.ipynb rename to ztf/resolvers/resolver.ipynb diff --git a/sso/SSO@amateur/Readme.md b/ztf/sso/SSO@amateur/Readme.md similarity index 100% rename from sso/SSO@amateur/Readme.md rename to ztf/sso/SSO@amateur/Readme.md diff --git a/sso/SSO@amateur/SSO_Fink_FAT_tuto.ipynb b/ztf/sso/SSO@amateur/SSO_Fink_FAT_tuto.ipynb similarity index 100% rename from sso/SSO@amateur/SSO_Fink_FAT_tuto.ipynb rename to ztf/sso/SSO@amateur/SSO_Fink_FAT_tuto.ipynb diff --git a/sso/SSO@amateur/requirements.txt b/ztf/sso/SSO@amateur/requirements.txt similarity index 100% rename from sso/SSO@amateur/requirements.txt rename to ztf/sso/SSO@amateur/requirements.txt diff --git a/sso/SSO@amateur/spec-file.txt b/ztf/sso/SSO@amateur/spec-file.txt similarity index 100% rename from sso/SSO@amateur/spec-file.txt rename to ztf/sso/SSO@amateur/spec-file.txt diff --git a/sso/SSO@amateur/ssotuto_utils.py b/ztf/sso/SSO@amateur/ssotuto_utils.py similarity index 100% rename from sso/SSO@amateur/ssotuto_utils.py rename to ztf/sso/SSO@amateur/ssotuto_utils.py diff --git a/sso/esa_risklist.ipynb b/ztf/sso/esa_risklist.ipynb similarity index 100% rename from sso/esa_risklist.ipynb rename to ztf/sso/esa_risklist.ipynb diff --git a/sso/fink_api.ipynb b/ztf/sso/fink_api.ipynb similarity index 100% rename from sso/fink_api.ipynb rename to ztf/sso/fink_api.ipynb diff --git a/sso/fink_sso_imcce.ipynb b/ztf/sso/fink_sso_imcce.ipynb similarity index 100% rename from sso/fink_sso_imcce.ipynb rename to ztf/sso/fink_sso_imcce.ipynb diff --git a/sso/phase_curve_models.ipynb b/ztf/sso/phase_curve_models.ipynb similarity index 100% rename from sso/phase_curve_models.ipynb rename to ztf/sso/phase_curve_models.ipynb diff --git a/sso/riskList.csv b/ztf/sso/riskList.csv similarity index 100% rename from sso/riskList.csv rename to ztf/sso/riskList.csv diff --git a/sso/sso_search.png b/ztf/sso/sso_search.png similarity index 100% rename from sso/sso_search.png rename to ztf/sso/sso_search.png diff --git a/statistics/fink_stats.ipynb b/ztf/statistics/fink_stats.ipynb similarity index 100% rename from statistics/fink_stats.ipynb rename to ztf/statistics/fink_stats.ipynb