# SNEWS Publishing Tool
<img src="docs/_static/images/snews_logo_bkg_light.png" alt="snews_logo" width="200"/>
[](https://snews-publishing-tools.readthedocs.io/en/latest/?badge=latest)
[](https://github.com/SNEWS2/SNEWS_Publishing_Tools/actions/workflows/tests.yml)
[](https://pypi.org/project/snews_pt/)
[](https://arxiv.org/abs/2406.17743)
This package provides users with a Python API and CLI to **publish observation messages** to SNEWS and **subscribe to receive alerts** from the SNEWS servers.
The SNEWS Publishing Tools are fully documented at [snews-publishing-tools.readthedocs.io](https://snews-publishing-tools.readthedocs.io/en/latest/).
Before you begin:
* Ensure your hop credentials are set up!
* Follow the instructions in the [**Quick Start**](https://snews-publishing-tools.readthedocs.io/en/latest/user/quickstart.html) guide.
## Fire Drills
We carry out regular multi-experiment fire drills to test the publishing tools. Fire drills are documented on [this page](https://snews-publishing-tools.readthedocs.io/en/latest/user/firedrills.html).
The `snews_pt` library uses fire-drill mode as its default option. If not desired, it can be disabled using the `firedrill_mode=True/False` arguments in the subscription and publication functions, or through the `--firedrill/--no-firedrill` flags within the CLI tools.
To publish and/or subscribe to the fire drill channels, please ensure you have the correct [hop permissions](https://my.hop.scimma.org/hopauth/).
## How to Install the SNEWS Publishing Tools
Detailed installation instructions are provided in our [Installation Guide](https://snews-publishing-tools.readthedocs.io/en/latest/user/installation.html).
We recommend that you install SNEWS the publishing tools PyPI package (`snews_pt`) using pip:
```
pip install snews_pt
```
To minimize conflicts with other Python packages, we suggest you set up a dedicated environment using [virtualenv](https://virtualenv.pypa.io/en/latest/), [conda](https://anaconda.org/anaconda/conda), or another tool used to create isolated Python environments. Also, note that the SNEWS software requires Python v3.11 or higher at the moment, so be sure to set up your enviornment with a new enough version.
## How to Publish and Subscribe
### Publishing
A main purpose of this software is to publish messages to the SNEWS server for the formation of coincident alerts. The exact protocols and interface are described in our [Publishing Guide](https://snews-publishing-tools.readthedocs.io/en/latest/user/publishing_protocols.html). Please also see our paper on the publishing tools: [M. Kara et al., JINST 19:P10017, 2024](https://arxiv.org/abs/2406.17743).
### Subscribing
The `snews_pt` package provides easy "read-only" subscriptions to alert topics, and allows subscribers to receive alerts in real time. See the [Subscription Guide](https://snews-publishing-tools.readthedocs.io/en/latest/user/subscribing.html) for detailed instructions.
## Command Line Interface (CLI)
Tools for command line interactions with the `snews_pt` library are available, and are explained in our guide to the [CLI Tools](https://snews-publishing-tools.readthedocs.io/en/latest/user/command_line_interface.html).
## Remote Commands and More
The SNEWS server allows for several remote commands. Some of them are meant only for the developers of `snews_pt` and are not intended for regular users. However, there are a few useful functionalities that the user can exploit to test their connections to the SNEWS 2.0 coincidence server.
The available functions are detailed in our [Remote commands](https://snews-publishing-tools.readthedocs.io/en/latest/user/remote_commands.html) guide.
Raw data
{
"_id": null,
"home_page": "https://snews2.org",
"name": "snews-pt",
"maintainer": null,
"docs_url": null,
"requires_python": "<4,>=3.11",
"maintainer_email": null,
"keywords": null,
"author": "SNEWS Collaboration",
"author_email": "snews2.0@lists.bnl.gov",
"download_url": "https://files.pythonhosted.org/packages/41/b4/afd539f267b5a06198e1a7a276f3409ae8b13d2b8b4348c52aed863db383/snews_pt-2.1.0.tar.gz",
"platform": null,
"description": "# SNEWS Publishing Tool\n<img src=\"docs/_static/images/snews_logo_bkg_light.png\" alt=\"snews_logo\" width=\"200\"/> \n\n[](https://snews-publishing-tools.readthedocs.io/en/latest/?badge=latest)\n[](https://github.com/SNEWS2/SNEWS_Publishing_Tools/actions/workflows/tests.yml)\n[](https://pypi.org/project/snews_pt/)\n[](https://arxiv.org/abs/2406.17743)\n\nThis package provides users with a Python API and CLI to **publish observation messages** to SNEWS and **subscribe to receive alerts** from the SNEWS servers.\n\nThe SNEWS Publishing Tools are fully documented at [snews-publishing-tools.readthedocs.io](https://snews-publishing-tools.readthedocs.io/en/latest/).\n\nBefore you begin:\n* Ensure your hop credentials are set up!\n* Follow the instructions in the [**Quick Start**](https://snews-publishing-tools.readthedocs.io/en/latest/user/quickstart.html) guide. \n## Fire Drills\n\nWe carry out regular multi-experiment fire drills to test the publishing tools. Fire drills are documented on [this page](https://snews-publishing-tools.readthedocs.io/en/latest/user/firedrills.html).\n\nThe `snews_pt` library uses fire-drill mode as its default option. If not desired, it can be disabled using the `firedrill_mode=True/False` arguments in the subscription and publication functions, or through the `--firedrill/--no-firedrill` flags within the CLI tools.\n\nTo publish and/or subscribe to the fire drill channels, please ensure you have the correct [hop permissions](https://my.hop.scimma.org/hopauth/).\n\n## How to Install the SNEWS Publishing Tools\n\nDetailed installation instructions are provided in our [Installation Guide](https://snews-publishing-tools.readthedocs.io/en/latest/user/installation.html).\n\nWe recommend that you install SNEWS the publishing tools PyPI package (`snews_pt`) using pip:\n```\npip install snews_pt\n```\nTo minimize conflicts with other Python packages, we suggest you set up a dedicated environment using [virtualenv](https://virtualenv.pypa.io/en/latest/), [conda](https://anaconda.org/anaconda/conda), or another tool used to create isolated Python environments. Also, note that the SNEWS software requires Python v3.11 or higher at the moment, so be sure to set up your enviornment with a new enough version.\n\n## How to Publish and Subscribe\n\n### Publishing\n\nA main purpose of this software is to publish messages to the SNEWS server for the formation of coincident alerts. The exact protocols and interface are described in our [Publishing Guide](https://snews-publishing-tools.readthedocs.io/en/latest/user/publishing_protocols.html). Please also see our paper on the publishing tools: [M. Kara et al., JINST 19:P10017, 2024](https://arxiv.org/abs/2406.17743).\n\n### Subscribing\n\nThe `snews_pt` package provides easy \"read-only\" subscriptions to alert topics, and allows subscribers to receive alerts in real time. See the [Subscription Guide](https://snews-publishing-tools.readthedocs.io/en/latest/user/subscribing.html) for detailed instructions.\n\n## Command Line Interface (CLI)\n\nTools for command line interactions with the `snews_pt` library are available, and are explained in our guide to the [CLI Tools](https://snews-publishing-tools.readthedocs.io/en/latest/user/command_line_interface.html).\n\n## Remote Commands and More\n\nThe SNEWS server allows for several remote commands. Some of them are meant only for the developers of `snews_pt` and are not intended for regular users. However, there are a few useful functionalities that the user can exploit to test their connections to the SNEWS 2.0 coincidence server.\n\nThe available functions are detailed in our [Remote commands](https://snews-publishing-tools.readthedocs.io/en/latest/user/remote_commands.html) guide.\n\n",
"bugtrack_url": null,
"license": "BSD-3-Clause",
"summary": "An alert application for observing supernovas",
"version": "2.1.0",
"project_urls": {
"Documentation": "https://snews-publishing-tools.readthedocs.io",
"Homepage": "https://snews2.org",
"Repository": "https://github.com/SNEWS2/SNEWS_Publishing_Tools"
},
"split_keywords": [],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "ca4a1c4145da60ccdabee263e4ddc2bece690e9a0302c4e8033330f29ef774f5",
"md5": "4c36ae258fe9327e0baaae2259640b0c",
"sha256": "1b0d70491e0f374b9221e01c3feb21d23e301d90c18624764a584da3bede5a75"
},
"downloads": -1,
"filename": "snews_pt-2.1.0-py3-none-any.whl",
"has_sig": false,
"md5_digest": "4c36ae258fe9327e0baaae2259640b0c",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": "<4,>=3.11",
"size": 26093,
"upload_time": "2025-08-29T14:54:22",
"upload_time_iso_8601": "2025-08-29T14:54:22.439988Z",
"url": "https://files.pythonhosted.org/packages/ca/4a/1c4145da60ccdabee263e4ddc2bece690e9a0302c4e8033330f29ef774f5/snews_pt-2.1.0-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "41b4afd539f267b5a06198e1a7a276f3409ae8b13d2b8b4348c52aed863db383",
"md5": "ee848623c678cbdcca355b81f2a1c4dc",
"sha256": "a32a52a2c77afeb68a75799811bd83fd4d530199121869574abf94ab0fd86f14"
},
"downloads": -1,
"filename": "snews_pt-2.1.0.tar.gz",
"has_sig": false,
"md5_digest": "ee848623c678cbdcca355b81f2a1c4dc",
"packagetype": "sdist",
"python_version": "source",
"requires_python": "<4,>=3.11",
"size": 19265,
"upload_time": "2025-08-29T14:54:23",
"upload_time_iso_8601": "2025-08-29T14:54:23.595954Z",
"url": "https://files.pythonhosted.org/packages/41/b4/afd539f267b5a06198e1a7a276f3409ae8b13d2b8b4348c52aed863db383/snews_pt-2.1.0.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2025-08-29 14:54:23",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "SNEWS2",
"github_project": "SNEWS_Publishing_Tools",
"travis_ci": false,
"coveralls": false,
"github_actions": true,
"requirements": [
{
"name": "click",
"specs": [
[
"~=",
"8.1.7"
]
]
},
{
"name": "hop-client",
"specs": [
[
"~=",
"0.10.0"
]
]
},
{
"name": "inquirer",
"specs": [
[
"~=",
"2.8"
]
]
},
{
"name": "ipython",
"specs": [
[
"~=",
"7.32.0"
]
]
},
{
"name": "numpy",
"specs": [
[
"~=",
"1.26.3"
]
]
},
{
"name": "python-dotenv",
"specs": [
[
"~=",
"0.21.1"
]
]
},
{
"name": "setuptools",
"specs": [
[
"~=",
"66.1.0"
]
]
},
{
"name": "snews-data-formats",
"specs": [
[
"~=",
"1.0.0"
]
]
},
{
"name": "wheel",
"specs": [
[
"~=",
"0.34.2"
]
]
},
{
"name": "pytest",
"specs": [
[
"~=",
"8.3.2"
]
]
},
{
"name": "pytest-cov",
"specs": [
[
"~=",
"4.1.0"
]
]
}
],
"lcname": "snews-pt"
}
JSON
