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

{isgri-0.6.1.dist-info → isgri-0.7.0.dist-info}/METADATA

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: isgri
-Version: 0.6.1
+Version: 0.7.0
 Summary: Python package for INTEGRAL IBIS/ISGRI lightcurve analysis
 Author: Dominik Patryk Pacholski
 License: MIT
@@ -8,6 +8,7 @@ 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
@@ -22,19 +23,20 @@ Python toolkit for INTEGRAL/ISGRI data analysis.
 
 ### 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
-- List SWIDs for batch processing
+- Export results to FITS/CSV or SWID lists
 
 ### 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.
+- 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
+- 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)
@@ -53,18 +55,26 @@ pip install isgri
 
 ```bash
 # Configure default paths (once)
-isgri config-set --catalog ~/data/scw_catalog.fits
+isgri config-set --archive /path/to/archive --catalog ~/data/scw_catalog.fits --pif /path/to/pif
 
-# 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
+# View current config
+isgri config
 
-# Get list of SWIDs for processing
+# 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
@@ -87,8 +97,14 @@ results = (cat
     .get()
 )
 
-# Save selected columns to the file
-cat.write('example_file.any_extension',columns=['SWID','TSTART','TSTOP'])
+# 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")
 ```
@@ -98,20 +114,49 @@ print(f"Found {len(results)} observations")
 ```python
 from isgri.utils import LightCurve, QualityMetrics
 
-# Load events with PIF weighting
+# 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
 )
 
-# Create 1-second binned light curve
-time, counts = lc.rebin(binsize=1.0, emin=20, emax=100)
+# 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
+)
 
-# Compute quality metrics
-qm = QualityMetrics(lc, binsize=1.0, emin=20, emax=100)
-chi = qm.raw_chi_squared()
-print(f"Chisq/dof = {chi:.2f}")
+# 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
@@ -123,17 +168,30 @@ ISGRI stores configuration in default config folder for each system (see: platfo
 isgri config
 
 # Set paths
-isgri config-set --archive /path/to/archive --catalog /path/to/catalog.fits
+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 can also be used in Python:
+Config in Python:
 
 ```python
-from isgri.config import get_config
+from isgri.config import Config
 
-cfg = get_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.
@@ -144,4 +202,9 @@ Local config file `isgri_config.toml` in current directory overrides global conf
 - **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
+- **API Reference**: Use `help()` in Python or see docstrings
+
+
+## License
+
+MIT

isgri-0.7.0.dist-info/RECORD

@@ -0,0 +1,21 @@
+isgri/__init__.py,sha256=V2hnOxXKcjMiusdGP8sOAR4QsBlWHQ0pZZMN2Cean6o,38
+isgri/__version__.py,sha256=P1kRuZW02tF-ekLuBqSjV_tIKKqcbfRPDdpp9C8ftUY,21
+isgri/config.py,sha256=8hziHnQN_dnS3FkOtrPUUV1QLJ9HmGiPzDuAiq3GoXc,5044
+isgri/catalog/__init__.py,sha256=IGfzGcGx1F1zplj7YIUuzE5Cvvxg7XJi0zu0aBXI0-A,113
+isgri/catalog/builder.py,sha256=EDda0QIHBRwh1nPUndSYfw4nvJHxjXPmVgyPscksBrM,15490
+isgri/catalog/scwquery.py,sha256=v7nR6-6PmYaBunFeGtmDWPqDkUBUvwjv2jtM1RbGQx4,20397
+isgri/catalog/wcs.py,sha256=mD6bZxiBxKYpuYCl8f2tSCc8uuWFzMRL2jf5SuFAhfg,5562
+isgri/cli/__init__.py,sha256=SCIcTdOvfEkrZd1doOtOnvCj8PmdRuXu18YYJQxfFrs,24
+isgri/cli/main.py,sha256=EfBN4E9oUvhB0GfQldLU3eSvmRC4JjxM72qWFEc2_IA,6379
+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.0.dist-info/METADATA,sha256=7MSVI7E4DdtSpm7GZXdYJ-SD1mTTddf0sewrJNkgYcE,5115
+isgri-0.7.0.dist-info/WHEEL,sha256=qtCwoSJWgHk21S1Kb4ihdzI2rlJ1ZKaIurTj_ngOhyQ,87
+isgri-0.7.0.dist-info/entry_points.txt,sha256=aM2K4RGihbwsj9crjPG-BvWhErcdtZt3tJqT6AaOojU,46
+isgri-0.7.0.dist-info/licenses/LICENSE,sha256=Q8oxmHR1cSnEXSHCjY3qeXMtupZI_1ZQZ1MBt4oeANE,1102
+isgri-0.7.0.dist-info/RECORD,,

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,,