# 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).
[](https://zenodo.org/badge/latestdoi/193068064)
[](https://github.com/desy-multimessenger/nuztf/actions/workflows/continous_integration.yml)
[](https://badge.fury.io/py/nuztf)
[](https://mybinder.org/v2/gh/desy-multimessenger/nuztf/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).
# 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:
[](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)
Raw data
{
"_id": null,
"home_page": "https://github.com/desy-multimessenger/nuztf",
"name": "nuztf",
"maintainer": null,
"docs_url": null,
"requires_python": "<3.12,>=3.10",
"maintainer_email": null,
"keywords": null,
"author": "Robert Stein",
"author_email": "rdstein@caltech.edu",
"download_url": "https://files.pythonhosted.org/packages/f3/ee/0596b005da5149f821800f37c2921d18a7b93b6fdf1477c567fcedf8918f/nuztf-2.9.0.tar.gz",
"platform": null,
"description": "# NuZTF\nPython package for correlating ZTF data with external multi-messenger triggers, created by [@robertdstein](https://github.com/robertdstein).\nThis package enables ZTF follow-up analysis of neutrinos/gravitational waves/gamma-ray bursts, built using the [AMPEL platform](https://arxiv.org/abs/1904.05922).\n\n[](https://zenodo.org/badge/latestdoi/193068064)\n[](https://github.com/desy-multimessenger/nuztf/actions/workflows/continous_integration.yml)\n[](https://badge.fury.io/py/nuztf)\n[](https://mybinder.org/v2/gh/desy-multimessenger/nuztf/main)\n[](https://coveralls.io/github/desy-multimessenger/nuztf?branch=main)\n\n## Installation Instructions\n\nNuZTF can be directly installed with pip, giving the latest stable release:\n\n```pip install nuztf```\n\nAlternatively, the latest Github version of the code can be installed via pip:\n\n```git clone https://github.com/desy-multimessenger/nuztf.git```\n\n```cd nuztf```\n\n```poetry install```\n\nIn case you encounter problems with an ARM-based Mac, use conda and issue:\n```conda install -c conda-forge python-confluent-kafka fiona pyproj lalsuite ligo.skymap -y```\nThis should take care of all packages that have not yet been ported.\n\nYou 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.\n\nAdditionally, you need an AMPEL API token. This can be obtained [here](https://ampel.zeuthen.desy.de/live/dashboard/tokens).\n\n# Citing the code\n\nIf 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:\n\n[](https://zenodo.org/badge/latestdoi/193068064)\n\n# Contributors\n\n* Jannis Necker [@JannisNe](https://github.com/jannisne)\n* Simeon Reusch [@simeonreusch](https://github.com/simeonreusch)\n* Robert Stein [@robertdstein](https://github.com/robertdstein)\n\n# Acknowledgements\n\nThis code stands on the shoulders of giants. We would particularly like to acknowledge:\n\n* [Ampel](https://ampelproject.github.io/), created primarily by [@wombaugh](https://github.com/wombaugh), [@vbrinnel](https://github.com/vbrinnel) and [@jvansanten](https://github.com/jvansanten)\n* [planobs](https://github.com/simeonreusch/planobs), created by [@simeonreusch](https://github.com/simeonreusch)\n* [ztfquery](https://github.com/MickaelRigault/ztfquery), created by [@MickaelRigault](https://github.com/MickaelRigault)\n",
"bugtrack_url": null,
"license": "MIT",
"summary": "Package for multi-messenger correlation searches with ZTF",
"version": "2.9.0",
"project_urls": {
"Homepage": "https://github.com/desy-multimessenger/nuztf",
"Repository": "https://github.com/desy-multimessenger/nuztf"
},
"split_keywords": [],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "81c4871592e038edfcddf1d7d80810e13ddcae8458a84b8ec891c9cb75e03690",
"md5": "f3a6ae54ef2d7115060383a0859a055c",
"sha256": "7af4dd4f140b7cf94d26bdce22806b0e836907a111b017e0d38a5c5c0bfab924"
},
"downloads": -1,
"filename": "nuztf-2.9.0-py3-none-any.whl",
"has_sig": false,
"md5_digest": "f3a6ae54ef2d7115060383a0859a055c",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": "<3.12,>=3.10",
"size": 59710,
"upload_time": "2025-01-28T22:23:16",
"upload_time_iso_8601": "2025-01-28T22:23:16.471844Z",
"url": "https://files.pythonhosted.org/packages/81/c4/871592e038edfcddf1d7d80810e13ddcae8458a84b8ec891c9cb75e03690/nuztf-2.9.0-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "f3ee0596b005da5149f821800f37c2921d18a7b93b6fdf1477c567fcedf8918f",
"md5": "03dbf354a1442ab23624b78136f64a54",
"sha256": "0c27f5281b424a7db2cef2cd00c0b320e83d6998eecfab5fc562dc6371d32573"
},
"downloads": -1,
"filename": "nuztf-2.9.0.tar.gz",
"has_sig": false,
"md5_digest": "03dbf354a1442ab23624b78136f64a54",
"packagetype": "sdist",
"python_version": "source",
"requires_python": "<3.12,>=3.10",
"size": 50381,
"upload_time": "2025-01-28T22:23:18",
"upload_time_iso_8601": "2025-01-28T22:23:18.569307Z",
"url": "https://files.pythonhosted.org/packages/f3/ee/0596b005da5149f821800f37c2921d18a7b93b6fdf1477c567fcedf8918f/nuztf-2.9.0.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2025-01-28 22:23:18",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "desy-multimessenger",
"github_project": "nuztf",
"travis_ci": false,
"coveralls": true,
"github_actions": true,
"lcname": "nuztf"
}
JSON
