# PromptX
\nPrompt X-ray emission from neutron star mergers, calculated for structured relativistic outflows at any viewing angle.
\n## Overview
\nPromptX simulates the emission from gamma-ray burst (GRB) jets and magnetar-powered winds using phenomenological models. It supports Gaussian, power-law, and top-hat outflows, calculating spectra and light curves observed from arbitrary angles.
\n## Features
\n- Structured jet and wind emission modeling
- Doppler-boosted observer-frame calculations
- Light curve and spectrum generation across X-ray and gamma-ray bands
## System Compatibility
\nThe code has currently only been tested on macOS. It may work on other operating systems, but has not been extensively tested or officially supported. All documentation assumes a Unix-based system (e.g., macOS or Linux).
\n## Installation
\n```bash
git clone https://github.com/cjules0609/promptx.git
cd promptx
pip install -r requirements.txt
```
## Example Usage
\nTo run default examples:
\n ```bash
cd scripts/
python examples.py
```
Outputs are saved to ./scripts/out directory.
\n## Documentation
Full documentation is available locally by following these steps:
1. Install Sphinx and ReadTheDocs theme:
```bash
pip install sphinx sphinx-rtd-theme
```
2. Build the HTML
```bash
sphinx-build -b html docs/source docs/build
```
3. Open the HTML documentation
```bash
open docs/build/index.html
```
## License
MIT License
## Acknowledgements
[Chen, Wang, and Zhang (2025)](https://doi.org/10.48550/arXiv.2505.01606).
Community submissions [Zenodo help] and draft reviews [Zenodo help] welcome for the AAS Journals Zenodo community. Requirements:
\nMore details of the AAS Journals curation and review policy can be found at the following resources:
\nCollection of records (data, software, animations, figures, or other reproducibility material) for the articles in the Journals of the American Astronomical Society, including The Astrophysical Journal (ApJ), The Astrophysical Journal Letters (ApJL), The Astrophysical Journal Supplements (ApJS), The Astronomical Journal (AJ), the Bulletin of the AAS (BAAS), The Planetary Science Journal (PSJ), and the Research Notes of the AAS (RNAAS).
\nAll records are reviewed and/or edited by the Data Editors of the AAS Journals, who are listed by name as members of this Zenodo community.
\nPreprints (pre-submission manuscripts, white papers, opinion pieces, reviews) in any format (PDF or otherwise) will be declined immediately; preprints must be submitted to the AAS Journals. It is fine to include manscript files with your data or software submissions so long as your Zenodo record is clearly related to a manuscript under review at the AAS Journals.
\n", "title": "AAS Journals", "type": { "id": "organization" }, "website": "https://journals.aas.org" }, "revision_id": 19, "slug": "aas", "updated": "2025-05-22T16:45:08.115679+00:00" } ], "ids": [ "7a140649-c350-45e3-a41d-eb8f04abd3d6" ] }, "id": "16923796", "pids": { "doi": { "client": "datacite", "identifier": "10.5281/zenodo.16923796", "provider": "datacite" } } }, "pids": { "doi": { "client": "datacite", "identifier": "10.5281/zenodo.16923797", "provider": "datacite" }, "oai": { "identifier": "oai:zenodo.org:16923797", "provider": "oai" } }, "revision_id": 6, "stats": { "all_versions": { "data_volume": 260005.0, "downloads": 10, "unique_downloads": 10, "unique_views": 85, "views": 90 }, "this_version": { "data_volume": 120305.0, "downloads": 5, "unique_downloads": 5, "unique_views": 34, "views": 38 } }, "status": "published", "swh": {}, "updated": "2025-08-22T03:14:07.059999+00:00", "versions": { "index": 1, "is_latest": false } }