hepi.data
=========

.. py:module:: hepi.data


Submodules
----------

.. toctree::
   :maxdepth: 1

   /autoapi/hepi/data/data/index


Functions
---------

.. autoapisummary::

   hepi.data.get_json_dir
   hepi.data.list_json_files
   hepi.data.list_files
   hepi.data.get_json_file
   hepi.data.get_file


Package Contents
----------------

.. py:function:: get_json_dir()

   Get the path to the data directory

   :returns: Path-like handle to the packaged JSON data directory.
   :rtype: importlib.resources.abc.Traversable


.. py:function:: list_json_files()

   List all files in the data directory

   :returns: List of files in the data directory
   :rtype: list


.. py:function:: list_files()

.. py:function:: get_json_file(filename)

   Get the content of a file in the data directory

   :param filename: Name of the file
   :type filename: str

   :returns: Path-like handle to the file
   :rtype: importlib.resources.abc.Traversable


.. py:function:: get_file(filename)