Metadata-Version: 2.4
Name: fitstoolz
Version: 0.1.0b3
Summary: Python libraries for interfacing with FITS data in an intuitive way
Project-URL: Documentation, https://fitstoolz.readthedocs.org
Project-URL: Repository, https://github.com/SpheMakh/fitstoolz.git
Project-URL: Issue Tracker, https://github.com/SpheMakh/fitstoolz/issues
Author-email: Sphesihle Makhathini <sphemakh@gmail.com>
Maintainer-email: Mika Naidoo <mika.naidoo25@gmail.com>, Athanaseus Ramaila <armaila@sarao.ac.za>
License-Expression: MIT
License-File: LICENSE
Requires-Python: <3.14,>=3.11
Requires-Dist: astropy<8.0,>=7.0
Requires-Dist: dask[array]>=2023.1.1
Requires-Dist: numpy>=2.0
Requires-Dist: scabha>=2.2.0rc2
Requires-Dist: xarray>=2023.01.0
Description-Content-Type: text/x-rst

==========
fitstoolz
==========

Python libraries for interfacing with FITS images in an intuitive way

Features
--------

* Image and coordinate data indexing is consistent
* Simple API for adding, transposing and expanding axes (or dimensions)
* `Xarray support <https://docs.xarray.dev/en/stable/index.html>`_
* `Zarr support <https://zarr.readthedocs.io/en/stable/index.html>`_ 

Example Usage
-------------

.. code-block:: ipython

    In[1]: from fitstoolz.reader import FitsData

    In[2]: myfits = FitsData("example-image.fits")
           myfits.coord_names

    Out[2]: ['STOKES', 'FREQ', 'DEC', 'RA']

    In[3]: myfits.dshape
    Out[3]: (1, 504, 100, 100) # these dimensions match the labels above

    In[4]: myfits.coords

    Out[4]: 
    Coordinates:
    STOKES   (stokes) int32 4B dask.array<chunksize=(1,), meta=np.ndarray>
    FREQ     (spectral) float64 4kB 8.803e+08 8.804e+08 ... 9.328e+08 9.329e+08
    RA       (celestial.ra) float64 800B 53.16 53.16 53.16 ... 53.1 53.1 53.1
    DEC      (celesstial.dec) float64 800B -28.16 -28.16 ... -28.11 -28.11
