dcnum.meta.paths
================

.. py:module:: dcnum.meta.paths


Attributes
----------

.. autoapisummary::

   dcnum.meta.paths.search_path_registry


Functions
---------

.. autoapisummary::

   dcnum.meta.paths.register_search_path
   dcnum.meta.paths.find_file


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

.. py:data:: search_path_registry

   Dictionary keeping track of user-defined search paths

.. py:function:: register_search_path(topic: str, search_path: str | pathlib.Path)

   Register a search path for a given topic

   Search paths are a global solution for organizing the locations
   of resources that are part of an analysis pipeline. For instance,
   if the location of such a file that depends on where your pipeline is
   running, you can register multiple search paths and the file will
   be found using :func:`find_file`.


.. py:function:: find_file(topic: str, file_name: str)

   Find a file in the search path for the given topic