gstlal 1.13.0
Loading...
Searching...
No Matches
python.utilities.laltools Namespace Reference

Functions

pathlib.Path create_cache (Iterable[Union[str, pathlib.Path, CacheEntry]] entries, Optional[Union[str, pathlib.Path]] cache_path=None, bool use_os_tmpdir=True)

Detailed Description

This module contains miscellaneous utilities for working with LAL data structures and api

Function Documentation

◆ create_cache()

pathlib.Path create_cache ( Iterable[Union[str, pathlib.Path, CacheEntry]] entries,
Optional[Union[str, pathlib.Path]] cache_path = None,
bool use_os_tmpdir = True )
Create a LAL cache file from an iterable of entries

    Args:
        entries:
            Iterable of either str, Path, or CacheEntry. If str or Path, a CacheEntry will be created using CacheEntry.from_T050017
        cache_path:
        use_os_tmpdir:
            bool, if True use 'TMPDIR' env variable else create a tmp directory using tempfile.TemporaryDirectory. Only applies if
            cache_path argument is None.

    Returns:
        pathlib.Path, the path to the cache file

Definition at line 12 of file laltools.py.