macro_eeg_model.utils#

This package contains the utility functions (for plotting and path handling).

Submodules#

A class responsible for managing directory paths used in the project.

notation(region_name)

Create an abbreation for a region name.

class macro_eeg_model.utils.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.

configs_path#

The path to the ‘configs’ directory, used for storing configuration files.

connectivity_data_path#

The path to the ‘connectivity_data’ directory, used for storing connectivity-related data.

julich_data_path#

The path to the ‘julich_brain_data’ directory, used for storing Julich brain data.

plots_path#

The path to the ‘plots’ directory, used for storing generated plots.

output_path#

The path to the ‘output’ directory, used for storing output files and results.

__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.COLORS = ['#E64B35', '#00A087', '#3C5488', '#FFA70F', '#208BB5', '#ED7287', '#6AC882', '#FF7C2B',...#

macro_eeg_model.utils.notation(region_name)[source]#

Create an abbreation for a region name.