Metadata-Version: 2.3
Name: nuztf
Version: 3.0.0
Summary: Package for multi-messenger correlation searches with ZTF
License: MIT
Author: Robert Stein
Author-email: rdstein@caltech.edu
Requires-Python: >=3.10,<3.12
Classifier: License :: OSI Approved :: MIT License
Classifier: Operating System :: OS Independent
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3.10
Classifier: Programming Language :: Python :: 3.11
Provides-Extra: cli
Provides-Extra: slackbot
Requires-Dist: ampel-interface (<=0.10.3)
Requires-Dist: ampel-ztf[archive] (>=0.10.0,<0.11.0)
Requires-Dist: astropy (>=5.1,<7.0)
Requires-Dist: astropy-healpix (>=0.6,<1.2)
Requires-Dist: astroquery (==0.4.6)
Requires-Dist: backoff (>=2.0)
Requires-Dist: dotenv (>=0.9.9,<0.10.0)
Requires-Dist: flask (>=2.2.3,<3.0.0) ; extra == "slackbot"
Requires-Dist: geopandas (>=0.11,<1.1)
Requires-Dist: gunicorn (>=20.1,<24.0) ; extra == "slackbot"
Requires-Dist: gwemopt (>=0.0.76,<0.0.85)
Requires-Dist: healpy (>=1.16.0,<2.0.0)
Requires-Dist: ipykernel (>=6.15.1)
Requires-Dist: jupyter (>=1.0.0)
Requires-Dist: lalsuite (>=7.5,<8.0)
Requires-Dist: ligo-gracedb (>=2.7.7,<3.0.0)
Requires-Dist: ligo.skymap (>=2.1.2,<3.0.0)
Requires-Dist: lxml (>=4.9.1,<6.0.0)
Requires-Dist: matplotlib (>=3)
Requires-Dist: mocpy (>=0.11,<0.18)
Requires-Dist: numpy (>=2.0.0)
Requires-Dist: pandas (>=1.4.3,<3.0.0)
Requires-Dist: penquins (>=2.4.2,<3.0.0)
Requires-Dist: pydantic (>=2.10.6,<3.0.0)
Requires-Dist: python-ligo-lw (>=1.8.1,<2.0.0)
Requires-Dist: pyvo (>=1.3)
Requires-Dist: requests (>2.28.1,<2.33.0)
Requires-Dist: scipy (>=1.8.1)
Requires-Dist: seaborn (>=0.11.2)
Requires-Dist: setuptools (>=65.3)
Requires-Dist: slackclient (>=2.9.4,<3.0.0) ; extra == "slackbot"
Requires-Dist: slackeventsapi (>=3.0.1,<4.0.0) ; extra == "slackbot"
Requires-Dist: tqdm (>=4.64.0)
Requires-Dist: typer (>=0.15.1,<0.16.0) ; extra == "cli"
Requires-Dist: wget (>=3.2)
Requires-Dist: ztfquery (>=1.28.0,<2.0.0)
Project-URL: Repository, https://github.com/desy-multimessenger/nuztf
Description-Content-Type: text/markdown

# NuZTF
Python package for correlating ZTF data with external multi-messenger triggers, created by [@robertdstein](https://github.com/robertdstein).
This package enables ZTF follow-up analysis of neutrinos/gravitational waves/gamma-ray bursts, built using the [AMPEL platform](https://arxiv.org/abs/1904.05922).

[![DOI](https://zenodo.org/badge/193068064.svg)](https://zenodo.org/badge/latestdoi/193068064)
[![CI](https://github.com/desy-multimessenger/nuztf/actions/workflows/continuous_integration.yml/badge.svg)](https://github.com/desy-multimessenger/nuztf/actions/workflows/continous_integration.yml)
[![PyPI version](https://badge.fury.io/py/nuztf.svg)](https://badge.fury.io/py/nuztf)
[![Binder](https://mybinder.org/badge_logo.svg)](https://mybinder.org/v2/gh/desy-multimessenger/nuztf/main)
[![Coverage Status](https://coveralls.io/repos/github/desy-multimessenger/nuztf/badge.svg?branch=main)](https://coveralls.io/github/desy-multimessenger/nuztf?branch=main)

## Installation Instructions

NuZTF can be directly installed with pip, giving the latest stable release:

```pip install nuztf```

Alternatively, the latest Github version of the code can be installed via pip:

```git clone https://github.com/desy-multimessenger/nuztf.git```

```cd nuztf```

```poetry install```

In case you encounter problems with an ARM-based Mac, use conda and issue:
```conda install -c conda-forge python-confluent-kafka fiona pyproj lalsuite ligo.skymap -y```
This should take care of all packages that have not yet been ported.

You will need the [IRSA login details](https://irsa.ipac.caltech.edu/account/signon/logout.do) with a ZTF-enabled account to fully utilise all features.

Additionally, you need an AMPEL API token. This can be obtained [here](https://ampel.zeuthen.desy.de/live/dashboard/tokens).

# CLI for IceCube neutrino counterparts
 `nuztf` comes with a command line interface to scan for counterparts to IceCube neutrino alerts. To be eble to use it, you must install the `cli` extra dependencies:

```pip install nuztf[cli]```

or

```poetry install -E cli```

For usage information run:

```nuztf --help```


# Citing the code

If you make use of this code, please cite it! A DOI is provided by Zenodo, which can reference both the code repository, or specific releases:

[![DOI](https://zenodo.org/badge/193068064.svg)](https://zenodo.org/badge/latestdoi/193068064)

# Contributors

* Jannis Necker [@JannisNe](https://github.com/jannisne)
* Simeon Reusch [@simeonreusch](https://github.com/simeonreusch)
* Robert Stein [@robertdstein](https://github.com/robertdstein)

# Acknowledgements

This code stands on the shoulders of giants. We would particularly like to acknowledge:

* [Ampel](https://ampelproject.github.io/), created primarily by [@wombaugh](https://github.com/wombaugh), [@vbrinnel](https://github.com/vbrinnel) and [@jvansanten](https://github.com/jvansanten)
* [planobs](https://github.com/simeonreusch/planobs), created by [@simeonreusch](https://github.com/simeonreusch)
* [ztfquery](https://github.com/MickaelRigault/ztfquery), created by [@MickaelRigault](https://github.com/MickaelRigault)

