Source code for Directories

 1"""Directory path container for circuit file storage."""
 2
 3from pathlib import Path
 4

[docs]
 5class Directories:
 6    """Holds paths for ASC, BIN, and data directories used by FileBasedCircuit."""
 7

[docs]
 8    def __init__(self, asc_dir: Path, bin_dir: Path, data_dir: Path):
 9        """Store the three directory paths.
10
11        Parameters
12        ----------
13        asc_dir : Path
14            Directory for ASC bitstream text files.
15        bin_dir : Path
16            Directory for compiled binary bitstream files.
17        data_dir : Path
18            Directory for experiment output data.
19        """
20        self.asc_dir = asc_dir
21        self.bin_dir = bin_dir
22        self.data_dir = data_dir