isgri 0.4.0__py3-none-any.whl → 0.5.1__py3-none-any.whl

isgri/utils/time_conversion.py

@@ -1,210 +1,210 @@
-"""
-Time Conversion Utilities for INTEGRAL
-=======================================
-
-Convert between INTEGRAL Julian Date (IJD) and other time formats.
-
-INTEGRAL uses IJD as its standard time format:
-- IJD 0.0 = 2000-01-01 00:00:00 TT (Terrestrial Time)
-- IJD = MJD - 51544.0
-- IJD uses TT time scale (atomic time)
-
-Functions
----------
-ijd2utc : Convert IJD to UTC ISO format
-utc2ijd : Convert UTC ISO format to IJD
-ijd2mjd : Convert IJD to Modified Julian Date
-mjd2ijd : Convert Modified Julian Date to IJD
-
-Examples
---------
->>> from isgri.utils import ijd2utc, utc2ijd
->>>
->>> # Convert IJD to readable format
->>> utc_str = ijd2utc(3000.5)
->>> print(utc_str)
-2008-03-17 11:58:55.816
->>>
->>> # Round trip conversion
->>> ijd = utc2ijd("2010-01-01 12:00:00")
->>> print(f"IJD: {ijd:.3f}")
-IJD: 3653.500
-
-Notes
------
-- IJD uses TT (Terrestrial Time) scale for consistency with spacecraft clock
-- UTC conversions account for leap seconds automatically
-- Precision: ~1 microsecond for typical astronomical observations
-"""
-
-from astropy.time import Time
-from typing import Union
-import numpy as np
-from numpy.typing import NDArray
-
-# INTEGRAL epoch: MJD 51544.0 = 2000-01-01 00:00:00 TT
-INTEGRAL_EPOCH_MJD = 51544.0
-
-
-def ijd2utc(ijd_time: Union[float, NDArray[np.float64]]) -> Union[str, NDArray[np.str_]]:
-    """
-    Convert IJD (INTEGRAL Julian Date) to UTC ISO format.
-
-    Parameters
-    ----------
-    ijd_time : float or ndarray
-        IJD time value(s). Can be scalar or array.
-
-    Returns
-    -------
-    utc_str : str or ndarray of str
-        UTC time in ISO format 'YYYY-MM-DD HH:MM:SS.sss'
-        Scalar if input is scalar, array if input is array.
-
-    Examples
-    --------
-    >>> ijd2utc(0.0)
-    '1999-12-31 23:58:55.816'
-
-    >>> ijd2utc(1000.5)
-    '2002-09-27 11:58:55.816'
-
-    >>> # Array conversion
-    >>> ijds = np.array([0.0, 1000.0, 2000.0])
-    >>> utcs = ijd2utc(ijds)
-    >>> print(utcs[0])
-    1999-12-31 23:58:55.816
-
-    See Also
-    --------
-    utc2ijd : Inverse conversion (UTC to IJD)
-    ijd2mjd : Convert IJD to MJD
-
-    Notes
-    -----
-    - IJD 0.0 corresponds to 2000-01-01 00:00:00 TT
-    - Accounts for leap seconds via UTC scale
-    - Output precision is milliseconds (3 decimal places)
-    """
-    mjd = ijd_time + INTEGRAL_EPOCH_MJD
-    t = Time(mjd, format="mjd", scale="tt")
-    return t.utc.iso
-
-
-def utc2ijd(utc_time: Union[str, NDArray[np.str_]]) -> Union[float, NDArray[np.float64]]:
-    """
-    Convert UTC ISO format to IJD (INTEGRAL Julian Date).
-
-    Parameters
-    ----------
-    utc_time : str or ndarray of str
-        UTC time in ISO format. Accepts:
-        - 'YYYY-MM-DD HH:MM:SS' (space separator)
-        - 'YYYY-MM-DDTHH:MM:SS' (T separator)
-        - Can include fractional seconds
-
-    Returns
-    -------
-    ijd_time : float or ndarray
-        IJD time value(s)
-
-    Examples
-    --------
-    >>> utc2ijd('1999-12-31 23:58:55.816')
-    0.0
-
-    >>> utc2ijd('2002-09-27 00:00:00')
-    1000.0
-
-    >>> # ISO 8601 format (with T separator)
-    >>> utc2ijd('2010-01-01T12:00:00')
-    3653.5
-
-    >>> # Array conversion
-    >>> utcs = ['2000-01-01 00:00:00', '2000-01-02 00:00:00']
-    >>> ijds = utc2ijd(utcs)
-    >>> print(ijds)
-    [0.00074287 1.00074287]
-
-    See Also
-    --------
-    ijd2utc : Inverse conversion (IJD to UTC)
-    mjd2ijd : Convert MJD to IJD
-
-    Notes
-    -----
-    - Automatically handles both space and T separators
-    - Accounts for leap seconds
-    - Returns TT (Terrestrial Time) scale
-    """
-    # Handle T separator in ISO 8601 format
-    if isinstance(utc_time, str):
-        utc_time = utc_time.replace("T", " ")
-    elif isinstance(utc_time, np.ndarray):
-        # Vectorized string replacement for arrays
-        utc_time = np.char.replace(utc_time, "T", " ")
-
-    t = Time(utc_time, format="iso", scale="utc")
-    return t.tt.mjd - INTEGRAL_EPOCH_MJD
-
-
-def ijd2mjd(ijd_time: Union[float, NDArray[np.float64]]) -> Union[float, NDArray[np.float64]]:
-    """
-    Convert IJD to Modified Julian Date (MJD).
-
-    Simple offset: MJD = IJD + 51544.0
-
-    Parameters
-    ----------
-    ijd_time : float or ndarray
-        IJD time value(s)
-
-    Returns
-    -------
-    mjd_time : float or ndarray
-        MJD time value(s)
-
-    Examples
-    --------
-    >>> ijd2mjd(0.0)
-    51544.0
-
-    >>> ijd2mjd(3653.5)
-    55197.5
-
-    See Also
-    --------
-    mjd2ijd : Inverse conversion
-    """
-    return ijd_time + INTEGRAL_EPOCH_MJD
-
-
-def mjd2ijd(mjd_time: Union[float, NDArray[np.float64]]) -> Union[float, NDArray[np.float64]]:
-    """
-    Convert Modified Julian Date (MJD) to IJD.
-
-    Simple offset: IJD = MJD - 51544.0
-
-    Parameters
-    ----------
-    mjd_time : float or ndarray
-        MJD time value(s)
-
-    Returns
-    -------
-    ijd_time : float or ndarray
-        IJD time value(s)
-
-    Examples
-    --------
-    >>> mjd2ijd(51544.0)
-    0.0
-
-    >>> mjd2ijd(55197.5)
-    3653.5
-
-    See Also
-    --------
-    ijd2mjd : Inverse conversion
-    """
-    return mjd_time - INTEGRAL_EPOCH_MJD
+"""
+Time Conversion Utilities for INTEGRAL
+=======================================
+
+Convert between INTEGRAL Julian Date (IJD) and other time formats.
+
+INTEGRAL uses IJD as its standard time format:
+- IJD 0.0 = 2000-01-01 00:00:00 TT (Terrestrial Time)
+- IJD = MJD - 51544.0
+- IJD uses TT time scale (atomic time)
+
+Functions
+---------
+ijd2utc : Convert IJD to UTC ISO format
+utc2ijd : Convert UTC ISO format to IJD
+ijd2mjd : Convert IJD to Modified Julian Date
+mjd2ijd : Convert Modified Julian Date to IJD
+
+Examples
+--------
+>>> from isgri.utils import ijd2utc, utc2ijd
+>>>
+>>> # Convert IJD to readable format
+>>> utc_str = ijd2utc(3000.5)
+>>> print(utc_str)
+2008-03-17 11:58:55.816
+>>>
+>>> # Round trip conversion
+>>> ijd = utc2ijd("2010-01-01 12:00:00")
+>>> print(f"IJD: {ijd:.3f}")
+IJD: 3653.500
+
+Notes
+-----
+- IJD uses TT (Terrestrial Time) scale for consistency with spacecraft clock
+- UTC conversions account for leap seconds automatically
+- Precision: ~1 microsecond for typical astronomical observations
+"""
+
+from astropy.time import Time
+from typing import Union
+import numpy as np
+from numpy.typing import NDArray
+
+# INTEGRAL epoch: MJD 51544.0 = 2000-01-01 00:00:00 TT
+INTEGRAL_EPOCH_MJD = 51544.0
+
+
+def ijd2utc(ijd_time: Union[float, NDArray[np.float64]]) -> Union[str, NDArray[np.str_]]:
+    """
+    Convert IJD (INTEGRAL Julian Date) to UTC ISO format.
+
+    Parameters
+    ----------
+    ijd_time : float or ndarray
+        IJD time value(s). Can be scalar or array.
+
+    Returns
+    -------
+    utc_str : str or ndarray of str
+        UTC time in ISO format 'YYYY-MM-DD HH:MM:SS.sss'
+        Scalar if input is scalar, array if input is array.
+
+    Examples
+    --------
+    >>> ijd2utc(0.0)
+    '1999-12-31 23:58:55.816'
+
+    >>> ijd2utc(1000.5)
+    '2002-09-27 11:58:55.816'
+
+    >>> # Array conversion
+    >>> ijds = np.array([0.0, 1000.0, 2000.0])
+    >>> utcs = ijd2utc(ijds)
+    >>> print(utcs[0])
+    1999-12-31 23:58:55.816
+
+    See Also
+    --------
+    utc2ijd : Inverse conversion (UTC to IJD)
+    ijd2mjd : Convert IJD to MJD
+
+    Notes
+    -----
+    - IJD 0.0 corresponds to 2000-01-01 00:00:00 TT
+    - Accounts for leap seconds via UTC scale
+    - Output precision is milliseconds (3 decimal places)
+    """
+    mjd = ijd_time + INTEGRAL_EPOCH_MJD
+    t = Time(mjd, format="mjd", scale="tt")
+    return t.utc.iso
+
+
+def utc2ijd(utc_time: Union[str, NDArray[np.str_]]) -> Union[float, NDArray[np.float64]]:
+    """
+    Convert UTC ISO format to IJD (INTEGRAL Julian Date).
+
+    Parameters
+    ----------
+    utc_time : str or ndarray of str
+        UTC time in ISO format. Accepts:
+        - 'YYYY-MM-DD HH:MM:SS' (space separator)
+        - 'YYYY-MM-DDTHH:MM:SS' (T separator)
+        - Can include fractional seconds
+
+    Returns
+    -------
+    ijd_time : float or ndarray
+        IJD time value(s)
+
+    Examples
+    --------
+    >>> utc2ijd('1999-12-31 23:58:55.816')
+    0.0
+
+    >>> utc2ijd('2002-09-27 00:00:00')
+    1000.0
+
+    >>> # ISO 8601 format (with T separator)
+    >>> utc2ijd('2010-01-01T12:00:00')
+    3653.5
+
+    >>> # Array conversion
+    >>> utcs = ['2000-01-01 00:00:00', '2000-01-02 00:00:00']
+    >>> ijds = utc2ijd(utcs)
+    >>> print(ijds)
+    [0.00074287 1.00074287]
+
+    See Also
+    --------
+    ijd2utc : Inverse conversion (IJD to UTC)
+    mjd2ijd : Convert MJD to IJD
+
+    Notes
+    -----
+    - Automatically handles both space and T separators
+    - Accounts for leap seconds
+    - Returns TT (Terrestrial Time) scale
+    """
+    # Handle T separator in ISO 8601 format
+    if isinstance(utc_time, str):
+        utc_time = utc_time.replace("T", " ")
+    elif isinstance(utc_time, np.ndarray):
+        # Vectorized string replacement for arrays
+        utc_time = np.char.replace(utc_time, "T", " ")
+
+    t = Time(utc_time, format="iso", scale="utc")
+    return t.tt.mjd - INTEGRAL_EPOCH_MJD
+
+
+def ijd2mjd(ijd_time: Union[float, NDArray[np.float64]]) -> Union[float, NDArray[np.float64]]:
+    """
+    Convert IJD to Modified Julian Date (MJD).
+
+    Simple offset: MJD = IJD + 51544.0
+
+    Parameters
+    ----------
+    ijd_time : float or ndarray
+        IJD time value(s)
+
+    Returns
+    -------
+    mjd_time : float or ndarray
+        MJD time value(s)
+
+    Examples
+    --------
+    >>> ijd2mjd(0.0)
+    51544.0
+
+    >>> ijd2mjd(3653.5)
+    55197.5
+
+    See Also
+    --------
+    mjd2ijd : Inverse conversion
+    """
+    return ijd_time + INTEGRAL_EPOCH_MJD
+
+
+def mjd2ijd(mjd_time: Union[float, NDArray[np.float64]]) -> Union[float, NDArray[np.float64]]:
+    """
+    Convert Modified Julian Date (MJD) to IJD.
+
+    Simple offset: IJD = MJD - 51544.0
+
+    Parameters
+    ----------
+    mjd_time : float or ndarray
+        MJD time value(s)
+
+    Returns
+    -------
+    ijd_time : float or ndarray
+        IJD time value(s)
+
+    Examples
+    --------
+    >>> mjd2ijd(51544.0)
+    0.0
+
+    >>> mjd2ijd(55197.5)
+    3653.5
+
+    See Also
+    --------
+    ijd2mjd : Inverse conversion
+    """
+    return mjd_time - INTEGRAL_EPOCH_MJD

{isgri-0.4.0.dist-info → isgri-0.5.1.dist-info}/METADATA

@@ -1,13 +1,17 @@
 Metadata-Version: 2.4
 Name: isgri
-Version: 0.4.0
+Version: 0.5.1
 Summary: Python package for INTEGRAL IBIS/ISGRI lightcurve analysis
 Author: Dominik Patryk Pacholski
 License: MIT
 License-File: LICENSE
-Requires-Python: >=3.10
+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
@@ -16,19 +20,25 @@ Python toolkit for INTEGRAL/ISGRI data analysis.
 
 ## Features
 
-### 📊 SCW Catalog Query
+### 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 FITS/CSV
 
-### 💡 Light Curve Analysis
+### 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 ↔ UTC)
+- Time conversions (IJD to/from UTC)
 
 
 ## Installation
@@ -39,6 +49,25 @@ pip install isgri
 
 ## Quick Start
 
+### CLI Usage
+
+```bash
+# Configure default paths (once)
+isgri config-set --catalog ~/data/scw_catalog.fits
+
+# 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
@@ -79,8 +108,34 @@ 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
@@ -92,12 +147,14 @@ isgri/
 ├── catalog/          # SCW catalog query tools
 │   ├── scwquery.py   # Main query interface
 │   └── wcs.py        # Coordinate transformations
-└── utils/            # Light curve analysis utilities
-    ├── lightcurve.py # Light curve class
-    ├── quality.py    # Quality metrics
-    ├── pif.py        # PIF tools
-    ├── file_loaders.py
-    └── time_conversion.py
+├── utils/            # Light curve analysis utilities
+│   ├── lightcurve.py # Light curve class
+│   ├── quality.py    # Quality metrics
+│   ├── pif.py        # PIF tools
+│   ├── file_loaders.py
+│   └── time_conversion.py
+├── config.py         # Configuration management
+└── cli.py            # Command line interface
 ```
 
 ## Requirements

isgri-0.5.1.dist-info/RECORD

@@ -0,0 +1,19 @@
+isgri/__init__.py,sha256=V2hnOxXKcjMiusdGP8sOAR4QsBlWHQ0pZZMN2Cean6o,38
+isgri/__version__.py,sha256=PQu9BZ4UZrI--6Rc-s0RhFPPEWVTqddrgsWkwYl87dI,21
+isgri/cli.py,sha256=ESrhtFCo-VEYuC3y4CL9Hv2Mdr6MVESCkRZ0N6kLgKs,7211
+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=KKsiAXkJHsm2WlQjYRN-knzHBhIJVCaM4jUAh_FaBYs,17603
+isgri/catalog/wcs.py,sha256=mD6bZxiBxKYpuYCl8f2tSCc8uuWFzMRL2jf5SuFAhfg,5562
+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.5.1.dist-info/METADATA,sha256=rivOcRKZxtAkigNBaAYFIon0bUwVgUan1FQJAnjxH-A,4018
+isgri-0.5.1.dist-info/WHEEL,sha256=qtCwoSJWgHk21S1Kb4ihdzI2rlJ1ZKaIurTj_ngOhyQ,87
+isgri-0.5.1.dist-info/entry_points.txt,sha256=ZziremOhrp8Lrk9Znu5L1lo7FmkrtMf6FDo8r1900Zc,41
+isgri-0.5.1.dist-info/licenses/LICENSE,sha256=Q8oxmHR1cSnEXSHCjY3qeXMtupZI_1ZQZ1MBt4oeANE,1102
+isgri-0.5.1.dist-info/RECORD,,

{isgri-0.4.0.dist-info → isgri-0.5.1.dist-info}/WHEEL

@@ -1,4 +1,4 @@
 Wheel-Version: 1.0
-Generator: hatchling 1.28.0
+Generator: hatchling 1.27.0
 Root-Is-Purelib: true
 Tag: py3-none-any

isgri-0.5.1.dist-info/entry_points.txt

@@ -0,0 +1,2 @@
+[console_scripts]
+isgri = isgri.cli:main

isgri-0.4.0.dist-info/RECORD

@@ -1,14 +0,0 @@
-isgri/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
-isgri/catalog/__init__.py,sha256=5GTSWfc32HA8z9Q-6taYxPpQi8vTlFfqXUbdJVPITvE,55
-isgri/catalog/scwquery.py,sha256=QAZhbbrXOoTghYXotQxZODGNFFIp9XLv_lZ1nwyYBY8,16821
-isgri/catalog/wcs.py,sha256=KJfIpo-sMVLUBfkv6CGUyTfaBXWpfDQPJEvVhXne-48,5372
-isgri/utils/__init__.py,sha256=H83Al7urc6LNW5KUzUBRdtRBUTahiZmkehKFiK90RrU,183
-isgri/utils/file_loaders.py,sha256=_1KBqxUnQUXs1fD4GSP7-nDsYi9HblpNFkKyG2037To,12000
-isgri/utils/lightcurve.py,sha256=yQMk4H9k7zZ8JvrtPQF6_mZVbk5_MIq_zMOT3lyKZgw,13724
-isgri/utils/pif.py,sha256=UsLKNaso4h-ztkaUotm-XSePx7ZJDQlz3vRKDOaoxfA,8362
-isgri/utils/quality.py,sha256=FKCvvDQ_Ys6zm-nKvwHt8_Mz58XFEWvj7keCHf_4sc0,12959
-isgri/utils/time_conversion.py,sha256=RU9NQtPAWZI-HQf5SS1fMCvsozrgBAApIGp8xIxBc2I,4994
-isgri-0.4.0.dist-info/METADATA,sha256=A2d8vquGiiGsfEkUXjfcbgz5O2v7cJsiHkgV9x-jS5k,2583
-isgri-0.4.0.dist-info/WHEEL,sha256=WLgqFyCfm_KASv4WHyYy0P3pM_m7J5L9k2skdKLirC8,87
-isgri-0.4.0.dist-info/licenses/LICENSE,sha256=Q8oxmHR1cSnEXSHCjY3qeXMtupZI_1ZQZ1MBt4oeANE,1102
-isgri-0.4.0.dist-info/RECORD,,