Metadata-Version: 2.4
Name: jinwu-gw
Version: 0.2.1
Summary: Gravitational-wave sky localization and high-energy coverage plots for jinwu.
License: GPL-3.0-or-later
Keywords: astrophysics,gravitational waves,sky map,GBM,Einstein Probe
Classifier: License :: OSI Approved :: GNU General Public License v3 or later (GPLv3+)
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3 :: Only
Classifier: Programming Language :: Python :: 3.12
Classifier: Intended Audience :: Science/Research
Requires-Python: >=3.11
Description-Content-Type: text/markdown
Requires-Dist: jinwu<0.3,>=0.2
Requires-Dist: jinwu-fermi<0.3,>=0.2
Requires-Dist: numpy>=1.24
Requires-Dist: astropy>=7.1
Requires-Dist: matplotlib>=3.7
Requires-Dist: requests>=2.25
Requires-Dist: astropy-healpix>=1.1
Requires-Dist: mocpy>=0.20
Requires-Dist: healpy>=1.16
Requires-Dist: ligo-gracedb>=2.15
Requires-Dist: ligo.skymap>=2.5

# jinwu-gw

`jinwu-gw` turns a public LIGO/Virgo/KAGRA alert or a local HEALPix
localization into a reproducible sky-coverage report.  The first release is
deliberately focused on visualization: it combines the GW probability map
with Fermi/GBM geometry and optional EP/BAT footprints.  It does not claim
that a geometric coverage result is a valid GBM exposure or spectral product.

```bash
jinwu-gw plot --notice alert.json --output results/
jinwu-gw plot --event S240422ed --output results/
jinwu-gw plot --skymap sky.multiorder.fits --time 2024-04-22T00:00:00Z \
    --gbm-cache ~/.cache/jinwu-gw/gbm --output results/
```

`--skymap` may also be an HTTPS FITS URL.  The output directory always
contains the all-sky and GBM diagnostic PNG/PDF (the latter is labelled
`unknown` when no POSHIST is available), `coverage.json`, and `coverage.ecsv`.
The CLI uses `$GBM_POSHIST_DIR` or `~/.cache/jinwu-gw/gbm` for GBM
POSHIST products when `--gbm-cache` is omitted; use `--no-download` for a
strictly offline run.
The JSON records the alert/map checksum, credible-region areas, MOC-order
convergence, coverage status and the explicit `spectral_analysis: "not_run"`
state.  A geometric GBM result is not a validated exposure or spectrum.
