macro_eeg_model.utils.paths#
Attributes#
Classes#
A class responsible for managing directory paths used in the project. |
Module Contents#
- class macro_eeg_model.utils.paths.Paths(base_dir=None)[source]#
A class responsible for managing directory paths used in the project. It ensures that the necessary directories exist, creating them if they do not.
- base_dir#
The base directory for all project-related paths. Defaults to the current working directory.
- Type:
pathlib.Path
- configs_path#
The path to the ‘configs’ directory, used for storing configuration files.
- Type:
pathlib.Path
- connectivity_data_path#
The path to the ‘connectivity_data’ directory, used for storing connectivity-related data.
- Type:
pathlib.Path
- julich_data_path#
The path to the ‘julich_brain_data’ directory, used for storing Julich brain data.
- Type:
pathlib.Path
- plots_path#
The path to the ‘plots’ directory, used for storing generated plots.
- Type:
pathlib.Path
- output_path#
The path to the ‘output’ directory, used for storing output files and results.
- Type:
pathlib.Path
- __init__(base_dir=None)[source]#
Initializes the Paths object, setting up the base directory and subdirectories.
- Parameters:
base_dir (str or pathlib.Path, optional) – The base directory for the project. If not provided, the current working directory is used.
- Raises:
AssertionError – If the ‘configs’ or ‘julich_brain_data’ directories do not exist within the base directory.
- macro_eeg_model.utils.paths.paths#