hats.io.summary_file
====================

.. py:module:: hats.io.summary_file


Functions
---------

.. autoapisummary::

   hats.io.summary_file.write_skymap_png
   hats.io.summary_file.write_partition_info_png
   hats.io.summary_file.generate_summary
   hats.io.summary_file.write_catalog_summary_file


Module Contents
---------------

.. py:function:: write_skymap_png(catalog_path: str | pathlib.Path | upath.UPath) -> None

   
   Write a ``skymap.png`` pixel coverage map to the catalog directory.
   Parameters
   ----------
   catalog_path : str | Path | UPath
       Path to the catalog directory. The PNG will be written alongside
       the catalog's other files.
















   ..
       !! processed by numpydoc !!

.. py:function:: write_partition_info_png(catalog_path: str | pathlib.Path | upath.UPath) -> None

   
   Write a ``partition_info.png`` angular density map to the catalog directory.


   :Parameters:

       **catalog_path** : str | Path | UPath
           Path to the catalog directory. The PNG will be written alongside
           the catalog's other files.














   ..
       !! processed by numpydoc !!

.. py:function:: generate_summary(catalog, *, fmt: Literal['markdown', 'html'], name: str, description: str, uri: str | None, huggingface_metadata: bool, jinja2_template: str | None = None) -> str

   
   Generate summary content for any HATS catalog or collection.
















   ..
       !! processed by numpydoc !!

.. py:function:: write_catalog_summary_file(catalog_path: str | pathlib.Path | upath.UPath, *, fmt: Literal['markdown', 'html'], filename: str | None = None, output_dir: str | pathlib.Path | upath.UPath | None = None, name: str | None = None, description: str | None = None, uri: str | None = None, huggingface_metadata: bool = False, jinja2_template: str | None = None) -> upath.UPath

   
   Write a summary readme file for any HATS catalog or collection
















   ..
       !! processed by numpydoc !!