dcnum.meta.paths

Attributes

search_path_registry

Dictionary keeping track of user-defined search paths

Functions

`register_search_path`(topic, search_path)	Register a search path for a given topic
`find_file`(topic, file_name)	Find a file in the search path for the given topic

Module Contents

dcnum.meta.paths.search_path_registry: Dictionary keeping track of user-defined search paths

dcnum.meta.paths.register_search_path(topic: str, search_path: str | pathlib.Path)[source]

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 find_file().

dcnum.meta.paths.find_file(topic: str, file_name: str)[source]: Find a file in the search path for the given topic