neurocarto.files

neurocarto.files.user_config_dir(config)
Parameters:

config (CartoConfig)

Returns:

directory

Return type:

Path

neurocarto.files.user_cache_dir(config)
Parameters:

config (CartoConfig)

Returns:

directory

Return type:

Path

neurocarto.files.user_cache_file(config, filename)
Parameters:
Return type:

Path

neurocarto.files.user_data_dir(config)
Parameters:

config (CartoConfig)

Returns:

directory

Return type:

Path

neurocarto.files.user_config_file(config)

Get user config filepath.

  • When --config-file is given, use it.

  • When --debug, use .neurocarto.config.json at current working directory.

Returns:

filepath.

See:

user_config_dir()

Parameters:

config (CartoConfig)

Return type:

Path

neurocarto.files.load_user_config(config)
Parameters:

config (CartoConfig)

Returns:

user config dictionary

Raises:

  • FileNotFoundError – config file does not exist.

  • IOError – wrap json.JSONDecodeError

See:

user_config_file()

Return type:

dict[str, Any]

neurocarto.files.save_user_config(config, user)
Parameters:

  • config (CartoConfig)

  • user (dict[str, Any]) – user config

Returns:

saved user confile path

See:

user_config_file()

Return type:

Path

neurocarto.files.channelmap_root(config)

channelmap resource root.

Parameters:

config (CartoConfig)

Returns:

directory path

Return type:

Path

neurocarto.files.list_channelmap_files(config, probe, recursive=False)

List channelmap files.

Parameters:

  • config (CartoConfig)

  • probe (ProbeDesp) – search for which channelmap files.

  • recursive (bool) – recursive search the files in folders.

Returns:

list of files.

See:

channelmap_root()

Return type:

list[Path]

neurocarto.files.get_channelmap_file(config, probe, filename)

Get channelmap file path.

Parameters:
Returns:

a channelmap file path under resource root

See:

channelmap_root()

Return type:

Path

neurocarto.files.get_blueprint_file(config, probe, chmap)

Get corresponded blueprint file from channelmap path.

Parameters:

  • config (CartoConfig)

  • probe (ProbeDesp)

  • chmap (str | Path) – a filename, or a channelmap file path.

Returns:

a blueprint file path

See:

get_channelmap_file()

Return type:

Path

neurocarto.files.get_view_config_file(config, probe, chmap)

Get view components’ configurations saving path.

Parameters:
Returns:

a view config path.

See:

get_channelmap_file()

Return type:

Path