coord2region.utils.paths#

Working directory helpers for Coord2Region projects.

Attributes#

Functions#

`resolve_working_directory`(→ pathlib.Path)	Return the root working directory for coord2region assets.
`ensure_mne_data_directory`(→ pathlib.Path)	Ensure the MNE data directory exists and is registered with MNE.

Module Contents#

coord2region.utils.paths.PathLike[source]#

coord2region.utils.paths.resolve_working_directory(base: PathLike = None) → Path[source]#

Return the root working directory for coord2region assets.

Parameters:: base (str or None, optional) – User supplied base directory. If None (default) the path ~/coord2region is returned. Relative paths are interpreted relative to the user’s home directory.
Returns:: Absolute path to the working directory.
Return type:: Path

coord2region.utils.paths.ensure_mne_data_directory(base: PathLike = None) → Path[source]#: Ensure the MNE data directory exists and is registered with MNE.