isgri 0.1.0__tar.gz → 0.3.0__tar.gz

isgri-0.3.0/.python-version

@@ -0,0 +1 @@
+3.10

{isgri-0.1.0 → isgri-0.3.0}/PKG-INFO

@@ -1,13 +1,13 @@
 Metadata-Version: 2.4
 Name: isgri
-Version: 0.1.0
+Version: 0.3.0
 Summary: Python package for INTEGRAL IBIS/ISGRI lightcurve analysis
 Author: Dominik Patryk Pacholski
 License: MIT
 License-File: LICENSE
 Requires-Python: >=3.10
-Requires-Dist: astropy>=7.2.0
-Requires-Dist: numpy>=2.3.5
+Requires-Dist: astropy
+Requires-Dist: numpy
 Description-Content-Type: text/markdown
 
 # isgri
@@ -22,7 +22,7 @@ pip install isgri
 
 Or from source:
 ```bash
-git clone https://github.com/yourusername/isgri.git
+git clone https://github.com/dominp/isgri.git
 cd isgri
 pip install -e .
 ```
@@ -49,6 +49,8 @@ qm = QualityMetrics(lc, binsize=1.0, emin=30, emax=300)
 chi = qm.raw_chi_squared()
 ```
 
+**About PIF files:** PIF (Pixel Illumination Fraction) files contain per-pixel sensitivity maps generated by OSA task `ii_pif`. They weight events based on source position to improve signal-to-noise ratio. Using PIF files is recommended but optional.
+
 ## Features
 
 - Load ISGRI events and PIF files
@@ -60,5 +62,5 @@ chi = qm.raw_chi_squared()
 
 ## Documentation
 
-- **Tutorial**: See [demo/lightcurve_walkthrough.ipynb](demo/lightcurve_walkthrough.ipynb)
+- **Tutorial**: - **Tutorial**: See [demo notebook](https://github.com/dominp/isgri/blob/main/demo/lightcurve_walkthrough.ipynb) on GitHub
 - **API docs**: All functions have docstrings - use `help(LightCurve)`

{isgri-0.1.0 → isgri-0.3.0}/README.md

@@ -10,7 +10,7 @@ pip install isgri
 
 Or from source:
 ```bash
-git clone https://github.com/yourusername/isgri.git
+git clone https://github.com/dominp/isgri.git
 cd isgri
 pip install -e .
 ```
@@ -37,6 +37,8 @@ qm = QualityMetrics(lc, binsize=1.0, emin=30, emax=300)
 chi = qm.raw_chi_squared()
 ```
 
+**About PIF files:** PIF (Pixel Illumination Fraction) files contain per-pixel sensitivity maps generated by OSA task `ii_pif`. They weight events based on source position to improve signal-to-noise ratio. Using PIF files is recommended but optional.
+
 ## Features
 
 - Load ISGRI events and PIF files
@@ -48,5 +50,5 @@ chi = qm.raw_chi_squared()
 
 ## Documentation
 
-- **Tutorial**: See [demo/lightcurve_walkthrough.ipynb](demo/lightcurve_walkthrough.ipynb)
+- **Tutorial**: - **Tutorial**: See [demo notebook](https://github.com/dominp/isgri/blob/main/demo/lightcurve_walkthrough.ipynb) on GitHub
 - **API docs**: All functions have docstrings - use `help(LightCurve)`