isgri 0.6.1__py3-none-any.whl → 0.7.1__py3-none-any.whl

isgri-0.7.1.dist-info/METADATA

@@ -0,0 +1,266 @@
+Metadata-Version: 2.4
+Name: isgri
+Version: 0.7.1
+Summary: Python package for INTEGRAL IBIS/ISGRI lightcurve analysis
+Author: Dominik Patryk Pacholski
+License: MIT
+License-File: LICENSE
+Requires-Python: >=3.9
+Requires-Dist: astropy
+Requires-Dist: click
+Requires-Dist: joblib
+Requires-Dist: numpy
+Requires-Dist: platformdirs
+Requires-Dist: tomli-w
+Requires-Dist: tomli>=2.0.0; python_version < '3.11'
+Description-Content-Type: text/markdown
+
+# ISGRI
+
+Python toolkit for INTEGRAL/ISGRI data analysis.
+
+## Features
+
+### Command Line Interface
+Query catalogs directly from the terminal:
+- Interactive and direct query modes
+- Filter by time, position, quality, revolution
+- Export results to FITS/CSV or SWID lists
+- Update catalogs with new science windows from archive
+
+### SCW Catalog Query
+Query INTEGRAL Science Window catalogs with a fluent Python API:
+- Filter by time, position, quality, revolution
+- Calculate detector offsets
+- Export results to any auto detectable astropy table extension or in table aligned data for any other extension
+
+### Catalog Builder
+Build and update INTEGRAL/ISGRI science window catalogs:
+- Automatic discovery of new science windows in archive
+- Parallel processing of quality metrics
+- Optional light curve caching
+- Incremental catalog updates
+
+### Light Curve Analysis
+Extract and analyze ISGRI light curves:
+- Load from file paths or SWID/source lookup
+- PIF weighting with adjustable thresholds
+- Custom time binning
+- Module-by-module analysis
+- Quality metrics (chi-squared tests)
+- Time conversions (IJD to/from UTC)
+
+
+## Installation
+
+```bash
+pip install isgri
+```
+
+## Quick Start
+
+### CLI Usage
+
+```bash
+# Configure default paths (once)
+isgri config-set --archive /path/to/archive --catalog ~/data/scw_catalog.fits --pif /path/to/pif
+
+# View current config
+isgri config
+
+# Update catalog from archive
+isgri update
+
+# Interactive catalog query
+isgri query
+# query> time
+# Start: 2010-01-01
+# Stop: 2010-12-31
+# → 1234 SCWs
+# query> pos
+# RA: 83.63
+# Dec: 22.01
+# ...
+
+# Direct catalog query
+isgri query --tstart 2010-01-01 --tstop 2010-12-31 --ra 83.63 --dec 22.01 --max-chi 2.0
+
+# Get SWID list for batch processing
+isgri query --tstart 3000 --tstop 3100 --list-swids > swids.txt
+
+# Export results
+isgri query --tstart 3000 --tstop 3100 --output results.fits
+```
+
+### Query SCW Catalog
+
+```python
+from isgri.catalog import ScwQuery
+
+# Load catalog
+cat = ScwQuery("path_to_catalog.fits")
+
+# Find Crab observations in 2010 with good quality
+results = (cat
+    .time(tstart="2010-01-01", tstop="2010-12-31")
+    .quality(max_chi=2.0)
+    .position(ra=83.63, dec=22.01, fov_mode="full")
+    .get()
+)
+
+# Filter by revolution(s)
+results = cat.revolution([1000, 1001, 1002]).get()
+
+# Save selected columns
+cat.write('results.fits', columns=['SWID', 'TSTART', 'TSTOP'])
+
+# Get SWID list
+swids = cat.get_swids()
+
+print(f"Found {len(results)} observations")
+```
+
+### Build/Update SCW Catalog
+
+#### Command Line
+
+```bash
+# Update catalog using configured paths
+isgri update
+
+# Update with custom paths
+isgri update --archive /anita/archivio/ --catalog ~/data/catalog.fits 
+
+# Enable light curve caching (15-1000 keV, 1s bins)
+isgri update --cache ~/data/lightcurves/
+
+# Limit CPU cores for parallel processing
+isgri update --cores 4
+```
+
+#### Python API
+
+```python
+from isgri.catalog import CatalogBuilder
+
+# Create builder instance
+builder = CatalogBuilder(
+    archive_path="/path/to/archive",
+    catalog_path="scw_catalog.fits",
+    lightcurve_cache="/path/to/cache",  # optional
+    n_cores=8
+)
+
+# Update catalog with new science windows
+builder.update_catalog()
+
+# Find all science windows in archive
+swids, paths = builder.find_scws()
+print(f"Found {len(swids)} science windows")
+```
+
+The builder:
+- Scans archive for new ScWs not in catalog
+- Computes quality metrics (raw, sigma-clipped, GTI-filtered chi-squared)
+- Processes in parallel by revolution
+- Optionally caches 1s light curves (15-1000 keV)
+
+### Analyze Light Curves
+
+```python
+from isgri.utils import LightCurve, QualityMetrics
+
+# Method 1: Load from file paths
+lc = LightCurve.load_data(
+    events_path="isgri_events.fits",
+    pif_path="source_model.fits",
+    use_pif=True,
+    pif_threshold=0.5
+)
+
+# Method 2: Load by SWID (requires config)
+lc = LightCurve.load_data(swid="255900280010")
+
+# Method 3: Load by SWID + source (auto-finds PIF)
+lc = LightCurve.load_data(
+    swid="255900280010",
+    source="SGR1935",
+    use_pif=True,
+    pif_threshold=0.5
+)
+
+# Create binned lightcurve
+time, counts = lc.rebin(binsize=1.0, emin=30, emax=100)
+
+# Override PIF settings temporarily
+time, counts = lc.rebin(binsize=1.0, emin=30, emax=100, use_pif=True, pif_threshold=0.8)
+
+# Or change instance settings
+lc.pif_threshold = 0.7
+lc.use_pif = True
+time, counts = lc.rebin(binsize=1.0, emin=30, emax=100)
+
+# Module-by-module analysis
+times, module_counts = lc.rebin_by_modules(binsize=1.0, emin=30, emax=300)
+
+# Quality metrics
+qm = QualityMetrics(lc, binsize=1.0, emin=30, emax=100)
+chi_raw = qm.raw_chi_squared()
+chi_clipped = qm.sigma_clip_chi_squared(sigma=1)
+chi_gti = qm.gti_chi_squared()
+print(f"Chisq/dof = {chi_raw:.2f}")
+
+# Time conversions
+from isgri.utils.time_conversion import ijd2utc, utc2ijd
+print(f"Start time: {ijd2utc(lc.t0)}")
+```
+
+## Configuration
+
+ISGRI stores configuration in default config folder for each system (see: platformdirs package)
+
+```bash
+# View current config
+isgri config
+
+# Set paths
+isgri config-set --archive /path/to/archive
+isgri config-set --catalog /path/to/catalog.fits
+isgri config-set --pif /path/to/pif
+
+# Set all at once
+isgri config-set --archive /path/to/archive --catalog /path/to/catalog.fits --pif /path/to/pif
+```
+
+Config in Python:
+
+```python
+from isgri.config import Config
+
+cfg = Config()
+print(cfg.archive_path)
+print(cfg.catalog_path)
+print(cfg.pif_path)
+
+# Create new config programmatically
+cfg.create_new(
+    archive_path="/path/to/archive",
+    catalog_path="/path/to/catalog.fits",
+    pif_path="/path/to/pif"
+)
+```
+
+Local config file `isgri_config.toml` in current directory overrides global config.
+
+
+## Documentation
+
+- **CLI Reference**: Run `isgri --help` or `isgri <command> --help`
+- **Catalog Tutorial**: [scwquery_walkthrough.ipynb](https://github.com/dominp/isgri/blob/main/demo/scwquery_walkthrough.ipynb)
+- **Light Curve Tutorial**: [lightcurve_walkthrough.ipynb](https://github.com/dominp/isgri/blob/main/demo/lightcurve_walkthrough.ipynb)
+- **API Reference**: Use `help()` in Python or see docstrings
+
+
+## License
+
+MIT

isgri-0.7.1.dist-info/RECORD

@@ -0,0 +1,22 @@
+isgri/__init__.py,sha256=V2hnOxXKcjMiusdGP8sOAR4QsBlWHQ0pZZMN2Cean6o,38
+isgri/__version__.py,sha256=tUukPDbH9wVBvn9_DYqm0p_Q7TagQGM_2ZX042hSuUs,21
+isgri/config.py,sha256=8hziHnQN_dnS3FkOtrPUUV1QLJ9HmGiPzDuAiq3GoXc,5044
+isgri/catalog/__init__.py,sha256=IGfzGcGx1F1zplj7YIUuzE5Cvvxg7XJi0zu0aBXI0-A,113
+isgri/catalog/builder.py,sha256=J1Z_p699hoQtiQjYw5-jvf0aSIIOcpe8djbCjh-NOng,15779
+isgri/catalog/scwquery.py,sha256=v7nR6-6PmYaBunFeGtmDWPqDkUBUvwjv2jtM1RbGQx4,20397
+isgri/catalog/wcs.py,sha256=mD6bZxiBxKYpuYCl8f2tSCc8uuWFzMRL2jf5SuFAhfg,5562
+isgri/cli/__init__.py,sha256=SCIcTdOvfEkrZd1doOtOnvCj8PmdRuXu18YYJQxfFrs,24
+isgri/cli/builder.py,sha256=dCp9ECl9MoThTRXAkXXazafHYSMQF0FLHKDzlWwT7vE,3494
+isgri/cli/main.py,sha256=SQxx1NdYQ7WjLINgvtyO4-rPdcVLhXnixU00pDqgVg8,6436
+isgri/cli/query.py,sha256=jIAJ8Ghr73OivSIqTjqYE-y-gn9hw4-QpEeH-z6Bny0,8012
+isgri/utils/__init__.py,sha256=H83Al7urc6LNW5KUzUBRdtRBUTahiZmkehKFiK90RrU,183
+isgri/utils/file_loaders.py,sha256=E4-0QA6r1QAX1gV1Dd5qhKPDXZIdSEk7AWdOQrovHGo,17423
+isgri/utils/lightcurve.py,sha256=v_JNLzf1SBvFLzrU7ZXpSj44eRKaZChiO4gvS2_O35Y,17408
+isgri/utils/pif.py,sha256=sAtzQhe3spLS41UkP1yZsqGPxe3IHLmIGA_d3bVg2v4,9121
+isgri/utils/quality.py,sha256=7CbYaNstoX60AYz2_ym-xjMkiDLpkYgQfaTStYuQZtk,13409
+isgri/utils/time_conversion.py,sha256=MNPVjrsrmwRDbCWmqdWN0xRs8PtHkFGli-H2cYwF9Ns,5204
+isgri-0.7.1.dist-info/METADATA,sha256=1Wi7eyxKCtpzFek7iCRLI_JaQqsiPiEdxRWZiOQeF_o,6499
+isgri-0.7.1.dist-info/WHEEL,sha256=qtCwoSJWgHk21S1Kb4ihdzI2rlJ1ZKaIurTj_ngOhyQ,87
+isgri-0.7.1.dist-info/entry_points.txt,sha256=aM2K4RGihbwsj9crjPG-BvWhErcdtZt3tJqT6AaOojU,46
+isgri-0.7.1.dist-info/licenses/LICENSE,sha256=Q8oxmHR1cSnEXSHCjY3qeXMtupZI_1ZQZ1MBt4oeANE,1102
+isgri-0.7.1.dist-info/RECORD,,

isgri-0.6.1.dist-info/METADATA

@@ -1,147 +0,0 @@
-Metadata-Version: 2.4
-Name: isgri
-Version: 0.6.1
-Summary: Python package for INTEGRAL IBIS/ISGRI lightcurve analysis
-Author: Dominik Patryk Pacholski
-License: MIT
-License-File: LICENSE
-Requires-Python: >=3.9
-Requires-Dist: astropy
-Requires-Dist: click
-Requires-Dist: numpy
-Requires-Dist: platformdirs
-Requires-Dist: tomli-w
-Requires-Dist: tomli>=2.0.0; python_version < '3.11'
-Description-Content-Type: text/markdown
-
-# ISGRI
-
-Python toolkit for INTEGRAL/ISGRI data analysis.
-
-## Features
-
-### Command Line Interface
-Query catalogs directly from the terminal:
-- Filter by time, position, quality, revolution
-- Export results to FITS/CSV
-- List SWIDs for batch processing
-
-### SCW Catalog Query
-Query INTEGRAL Science Window catalogs with a fluent Python API:
-- Filter by time, position, quality, revolution
-- Calculate detector offsets
-- Export results to any auto detectable astropy table extension or in table aligned data for any other extension.
-
-### Light Curve Analysis
-Extract and analyze ISGRI light curves:
-- Event loading with PIF weighting
-- Custom time binning
-- Module-by-module analysis
-- Quality metrics (chi-squared tests)
-- Time conversions (IJD to/from UTC)
-
-
-## Installation
-
-```bash
-pip install isgri
-```
-
-## Quick Start
-
-### CLI Usage
-
-```bash
-# Configure default paths (once)
-isgri config-set --catalog ~/data/scw_catalog.fits
-
-# Interactive method
-isgri query
-
-# Query by time range
-isgri query --tstart 2010-01-01 --tstop 2010-12-31
-
-# Query Crab with quality cut
-isgri query --ra 83.63 --dec 22.01 --max-chi 2.0 --fov full
-
-# Get list of SWIDs for processing
-isgri query --tstart 3000 --tstop 3100 --list-swids > swids.txt
-
-# Export results
-isgri query --tstart 3000 --tstop 3100 --output results.fits
-```
-
-### Query SCW Catalog
-
-```python
-from isgri.catalog import ScwQuery
-
-# Load catalog
-cat = ScwQuery("path_to_catalog.fits")
-
-# Find Crab observations in 2010 with good quality
-results = (cat
-    .time(tstart="2010-01-01", tstop="2010-12-31")
-    .quality(max_chi=2.0)
-    .position(ra=83.63, dec=22.01, fov_mode="full")
-    .get()
-)
-
-# Save selected columns to the file
-cat.write('example_file.any_extension',columns=['SWID','TSTART','TSTOP'])
-
-print(f"Found {len(results)} observations")
-```
-
-### Analyze Light Curves
-
-```python
-from isgri.utils import LightCurve, QualityMetrics
-
-# Load events with PIF weighting
-lc = LightCurve.load_data(
-    events_path="isgri_events.fits",
-    pif_path="source_model.fits",
-    pif_threshold=0.5
-)
-
-# Create 1-second binned light curve
-time, counts = lc.rebin(binsize=1.0, emin=20, emax=100)
-
-# Compute quality metrics
-qm = QualityMetrics(lc, binsize=1.0, emin=20, emax=100)
-chi = qm.raw_chi_squared()
-print(f"Chisq/dof = {chi:.2f}")
-```
-
-## Configuration
-
-ISGRI stores configuration in default config folder for each system (see: platformdirs package)
-
-```bash
-# View current config
-isgri config
-
-# Set paths
-isgri config-set --archive /path/to/archive --catalog /path/to/catalog.fits
-```
-
-Config can also be used in Python:
-
-```python
-from isgri.config import get_config
-
-cfg = get_config()
-print(cfg.archive_path)
-print(cfg.catalog_path)
-```
-
-Local config file `isgri_config.toml` in current directory overrides global config.
-
-
-## Documentation
-
-- **CLI Reference**: Run `isgri --help` or `isgri <command> --help`
-- **Catalog Tutorial**: [scwquery_walkthrough.ipynb](https://github.com/dominp/isgri/blob/main/demo/scwquery_walkthrough.ipynb)
-- **Light Curve Tutorial**: [lightcurve_walkthrough.ipynb](https://github.com/dominp/isgri/blob/main/demo/lightcurve_walkthrough.ipynb)
-- **API Reference**: Use `help()` in Python or see docstrings

isgri-0.6.1.dist-info/RECORD

@@ -1,21 +0,0 @@
-isgri/__init__.py,sha256=V2hnOxXKcjMiusdGP8sOAR4QsBlWHQ0pZZMN2Cean6o,38
-isgri/__version__.py,sha256=XvHFZM0padtrqitt9-p2enlBUGqc6vGvWNLx2iJv09g,21
-isgri/config.py,sha256=i1ibczZsmgqELv4ik2h2nWLnHyl68_5KGsz5Ec8Uf4E,4365
-isgri/catalog/__init__.py,sha256=CT9Zd1WISpv7kowf3bqagKewZ8SjLr1rZzVSFkwEj3o,58
-isgri/catalog/builder.py,sha256=Ure_erpyApjSiAmIvhJahuf6c11VNXBn5R6-nQzsDw4,3488
-isgri/catalog/scwquery.py,sha256=3X9Es79UNGedhsS7EvArNGo8KMAMuUU9hMQIsrfRuBs,20259
-isgri/catalog/wcs.py,sha256=mD6bZxiBxKYpuYCl8f2tSCc8uuWFzMRL2jf5SuFAhfg,5562
-isgri/cli/__init__.py,sha256=-bBNFYOq80A2Egtpo5V5zWJtYOxQfRZFQ_feve5lkFU,23
-isgri/cli/main.py,sha256=pOwTbJ7nuOC48cdVm-e84GGjlOFic1ZMEvU2e3yKP4k,5613
-isgri/cli/query.py,sha256=dUzLsEjjyzCQ1lbG3pVe0pvIWcDcNs-6T57ugUFUTdk,5542
-isgri/utils/__init__.py,sha256=H83Al7urc6LNW5KUzUBRdtRBUTahiZmkehKFiK90RrU,183
-isgri/utils/file_loaders.py,sha256=g-LUfYw35hPePlFeicymaL-NbZXzZWfNmM127XJjCKY,12497
-isgri/utils/lightcurve.py,sha256=Pjys-eIyKShDKHqFpGa9SZ0Dzz7LiLIwBpUkp_6s41g,14133
-isgri/utils/pif.py,sha256=LixlkShy1j_ymfdJLyCV8zl0EeHgfVDVjddSex18GLQ,8648
-isgri/utils/quality.py,sha256=Na-sNEX1E4xWQJx0FYe9vbOAgPrTcLohHeUAnmlKYSw,13348
-isgri/utils/time_conversion.py,sha256=MNPVjrsrmwRDbCWmqdWN0xRs8PtHkFGli-H2cYwF9Ns,5204
-isgri-0.6.1.dist-info/METADATA,sha256=89GNYk4YvwD6xxSHjFyZJbF9ZquuuSFND7jWj-DKu_k,3613
-isgri-0.6.1.dist-info/WHEEL,sha256=qtCwoSJWgHk21S1Kb4ihdzI2rlJ1ZKaIurTj_ngOhyQ,87
-isgri-0.6.1.dist-info/entry_points.txt,sha256=aM2K4RGihbwsj9crjPG-BvWhErcdtZt3tJqT6AaOojU,46
-isgri-0.6.1.dist-info/licenses/LICENSE,sha256=Q8oxmHR1cSnEXSHCjY3qeXMtupZI_1ZQZ1MBt4oeANE,1102
-isgri-0.6.1.dist-info/RECORD,,