Metadata-Version: 1.1
Name: fitsmap
Version: 0.1.2
Summary: Turn fits files/catalogs into a leafletjs map
Home-page: https://github.com/ryanhausen/fitsmap
Author: Ryan Hausen
Author-email: rhausen@ucsc.edu
License: MIT
Description: .. Variables to ensure the hyperlink gets used
        .. |mapmaker| replace:: `fitsmap.mapmaker <https://fitsmap.readthedocs.io/en/latest/source/fitsmap.html#module-fitsmap.mapmaker>`__
        .. |files_to_map| replace:: `fitsmap.mapmaker.files_to_map <https://fitsmap.readthedocs.io/en/latest/source/fitsmap.html#fitsmap.mapmaker.files_to_map>`__
        .. |dir_to_map| replace:: `fitsmap.mapmaker.dir_to_map <https://fitsmap.readthedocs.io/en/latest/source/fitsmap.html#fitsmap.mapmaker.dir_to_map>`__
        
        .. image:: docs/logo.svg.png
            :alt: FitsMap
            :align: center
        
        FitsMap
        =======
        
        FitsMap is a tool for displaying astronomical images and their associated
        catalogs, powered by `LeafletJS <https://leafletjs.com>`_.
        
        Survey images can have dimensions in the tens of thousands pixels in multiple
        bands. Examining images of this size can be difficult especially in multiple
        bands. Memory constraints and highly specialized tools like DS9 make analysis
        infeasible or cumbersome. FitsMap addresses these two issues by converting
        large fits files and images into tiles that can be presented using
        `LeafletJS <https://leafletjs.com>`_. Another issue in examining survey images
        is examining a catalog of sources in the context of the images. FitsMap
        addresses this by converting a catalog of sources into JSON map markers, which
        can be viewed in the webpage. Additionally these sources are searchable using
        by the web interface by the column ``id``.
        
        Installation
        ------------
        
        Requirements:
        
        - ``astropy``
        - ``imageio``
        - ``numpy``
        - ``matplotlib``
        - ``pillow``
        - ``scikit-image``
        - ``sharedmem``
        - ``tqdm``
        
        Use ``pip`` to install
        
        .. code-block:: bash
        
            pip install fitsmap
        
        Usuage
        ------
        
        Import the |mapmaker| module
        
        .. code-block:: python
        
            from fitsmap import mapmaker
        
        Pass a list of files to |files_to_map|:
        
        .. code-block:: python
        
            some_files = ...
        
            mapmaker.files_to_map(some_files)
        
        OR, pass a directory to |dir_to_map|:
        
        .. code-block:: python
        
            mapmaker.dir_to_map("path/to/files/")
        
        For more informatio see the `docs <https://fitsmap.readthedocs.io>`__
        or the `code <https://github.com/ryanhausen/fitsmap>`__.
        
        
Keywords: models tools
Platform: UNKNOWN
Classifier: Development Status :: 2 - Pre-Alpha
Classifier: License :: OSI Approved :: MIT License
