coord2region.paths#

High-level path helpers for coord2region.

Functions#

get_working_directory(→ str)

Return absolute path to the coord2region working directory.

Module Contents#

coord2region.paths.get_working_directory(base: str | None = None) → str[source]#

Return absolute path to the coord2region working directory.

Parameters:

base (str, optional) – Base directory supplied by the user. If None (default) the path ~/coord2region is used. Relative paths are interpreted relative to the user’s home directory.

Returns:

Absolute path to the working directory. The directory is created if it does not already exist.

Return type:

str