Python package to access ZTF data
Project description
ztfquery
This package is made to ease access to Zwicky Transient Facility data and data-products. It is maintained by M. Rigault (CNRS/IN2P3) and S. Reusch (DESY).
ztfquery: a python tool to access ztf (and SEDM) data
ztfquery contains a list of tools:
-
ZTF products: a wrapper of the IRSA web API that enable to get ztf data (requires access for full data, but not public data):
- Images and pipeline products, e.g. catalog ; See the
ztfquery.query.pydocumentation - LightCurves (not from image subtraction): See the
ztfquery.lightcurve.pydocumentation - ZTF observing logs: See the
ztfquery.skyvision.pydocumentation
- Images and pipeline products, e.g. catalog ; See the
-
Marshal/Fritz: Download the source information and data, such as lightcurves, spectra, coordinates and redshift:
- from the ZTF-I Marshal: See the
ztfquery.marshal.pydocumentation - from the ZTF-II Fritz: See the
ztfquery.fritz.pydocumentation
- from the ZTF-I Marshal: See the
-
SEDM Data: tools to download SEDM data, including IFU cubes and target spectra, from pharos See the
ztfquery.sedm.pydocumentation -
ZTF alert: Currently only a simple alert reader. See the
ztfquery.alert.pydocumentation
Credits
Citation
Mickael Rigault. (2018, August 14). ztfquery, a python tool to access ZTF data (Version doi). Zenodo. http://doi.org/10.5281/zenodo.1345222
Acknowledgments
If you have used ztfquery for a research you are publishing, please include the following in your acknowledgments:
"The ztfquery code was funded by the European Research Council (ERC) under the European Union's Horizon 2020 research and innovation programme (grant agreement n°759194 - USNAC, PI: Rigault)."
Corresponding Authors:
- M. Rigault: m.rigault@ipnl.in2p3.fr, CNRS/IN2P3
- S. Reusch: simeon.reusch@desy.de, DESY
Installation
ztfquery requires python >= 3.8
Install the code
using pip: pip install ztfquery (favored)
or for the latest version:
go wherever you want to save the folder and then
git clone https://github.com/MickaelRigault/ztfquery.git
cd ztfquery
poetry install
Set your environment
You should also create the global variable $ZTFDATA (usually in your ~/.bash_profile or ~/.cshrc). Data you will download from IRSA will be saved in the directory indicated by $ZTFDATA following the IRSA data structure.
Login and Password storage
Your credentials will requested the first time you need to access a service (IRSA, Marshal, etc.). They will then be stored, crypted, under ~/.ztfquery.
Use ztfquery.io.set_account(servicename) to reset it.
You can also directly provide account settings when running load_metadata and download_data using the auth=[your_username, your_password] parameter. Similarly, directly provide the username and password to the ztf ops page when loading NightSummary using the ztfops_auth parameter.
Quick Examples
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 ztfquery-1.27.1-py3-none-any.whl
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 | a717ff9bed70d31f3cee7b80baffd9945d6c8bbc669b736b2410251d92c9e6b2 |
|
| MD5 | 82e9f2181e91b2dd65a1d1f3c7331f42 |
|
| BLAKE2b-256 | 69141f52b27ab404393cdb67a5311d6a7ce1a82413b0108244ef64a5794ac5a8 |
