Metadata-Version: 2.4
Name: parallax-jwst
Version: 1.4.0
Summary: A Python library for exploring publicly available JWST data from the MAST archive.
Author-email: Jeff Teague <teaguejg@yahoo.com>
License: MIT License
        
        Copyright (c) 2026 teaguejg
        
        Permission is hereby granted, free of charge, to any person obtaining a copy
        of this software and associated documentation files (the "Software"), to deal
        in the Software without restriction, including without limitation the rights
        to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
        copies of the Software, and to permit persons to whom the Software is
        furnished to do so, subject to the following conditions:
        
        The above copyright notice and this permission notice shall be included in all
        copies or substantial portions of the Software.
        
        THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
        IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
        FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
        AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
        LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
        OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
        SOFTWARE.
Project-URL: Repository, https://github.com/teaguejg/parallax-jwst
Project-URL: Issues, https://github.com/teaguejg/parallax-jwst/issues
Keywords: astronomy,JWST,MAST,NIRCam,astrophysics,source detection
Classifier: Development Status :: 5 - Production/Stable
Classifier: Intended Audience :: Science/Research
Classifier: License :: OSI Approved :: MIT License
Classifier: Operating System :: OS Independent
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3.12
Classifier: Topic :: Scientific/Engineering :: Astronomy
Requires-Python: >=3.12
Description-Content-Type: text/markdown
License-File: LICENSE
Requires-Dist: astropy>=5.3
Requires-Dist: astroquery>=0.4.8
Requires-Dist: photutils>=1.9
Requires-Dist: matplotlib>=3.7
Requires-Dist: numpy>=1.24
Requires-Dist: PyYAML>=6.0
Requires-Dist: scipy>=1.11
Requires-Dist: PyQt6>=6.4
Requires-Dist: reproject>=0.13
Dynamic: license-file

# Parallax

Parallax is a Python library for exploring publicly available JWST data from
the MAST archive. It finds astronomical sources that existing catalogs have
not yet characterized, cross-references them against SIMBAD, NED, and Gaia,
and presents the results in terms an educated non-specialist can act on.

## Installation

Requires Python 3.12 or later.

```
git clone https://github.com/teaguejg/parallax-jwst
cd parallax-jwst
pip install -e .
```

This installs all dependencies. PyQt6 is included for the desktop GUI.

## Quick start

```python
import parallax as par

# run the full pipeline on M92
report = par.survey.reduce("M92", instrument="NIRCAM")

print(f"Detected: {report.n_sources_detected}")
print(f"Unverified: {report.n_unverified}")

# launch the GUI
from parallax.gui import launch
launch()
```

`reduce()` downloads JWST images from MAST, runs source detection, queries
three catalogs, and writes JSON and markdown reports to `data/reports/`.

## Validated targets

These targets have been tested end-to-end:

- **M92 (NGC 6341)** - globular cluster. ~23,800 sources detected, ~18,700
  unverified candidates. Runs in under two minutes.
- **NGC 3132** - Southern Ring Nebula. Use "NGC 3132" as the target string;
  "Southern Ring Nebula" does not resolve on MAST.
- **Orion Bar** - star-forming region. MAST has no Level 3 mosaic products
  for this target, only detector-level i2d files.

## Configuration

All settings live in `config.yaml` in the project root. Key knobs:

- `detection.snr_threshold` (default 3.0) - minimum signal-to-noise for a
  detection. Lower finds fainter sources but more noise.
- `detection.min_pixels` (default 25) - minimum connected pixels per source.
  Filters hot pixels and cosmic rays.
- `detection.background_box_size` (default 50) - background estimation tile
  size. Smaller values (20-25) work better near bright extended emission.
- `resolver.search_radius_arcsec` (default 2.0) - catalog cross-match radius.
  Increase if WCS alignment is imprecise.
- `resolver.catalogs` (default [SIMBAD, NED, GAIA]) - which catalogs to query.

Environment variables override config values using the prefix `PARALLAX_` with
underscores between segments (e.g. `PARALLAX_DETECTION_SNR_THRESHOLD=5.0`).

## Requirements

- astropy >= 5.3
- astroquery >= 0.4.8
- photutils >= 1.9
- matplotlib >= 3.7
- numpy >= 1.24
- PyYAML >= 6.0
- scipy >= 1.11
- PyQt6 >= 6.4
