brainglobe
Search…
config

Contents

write_default_config [#19]

Check the source code online
1
def write_default_config(path=CONFIG_PATH,
2
template=TEMPLATE_CONF_DICT):
Copied!
  docstring:
1
Write configuration file at first repo usage. In this way,
2
3
we don't need to keep a confusing template config file in the repo.
4
5
Parameters
6
7
----------
8
9
path : Path object
10
11
Path of the config file (optional).
12
13
template : dict
14
15
Template of the config file to be written (optional).
Copied!

read_config [#40]

Check the source code online
1
def read_config(path=CONFIG_PATH):
Copied!
  docstring:
1
Read BrainGlobe config.
2
3
Parameters
4
5
----------
6
7
path : Path object
8
9
Path of the config file (optional).
10
11
Returns
12
13
-------
14
15
ConfigParser object
16
17
brainglobe configuration
Copied!

write_config_value [#64]

Check the source code online
1
def write_config_value(key, val, path=CONFIG_PATH):
Copied!
  docstring:
1
Write a new value in the config file. To make things simple, ignore
2
3
sections and look directly for matching parameters names.
4
5
Parameters
6
7
----------
8
9
key : str
10
11
Name of the parameter to configure.
12
13
val :
14
15
New value.
16
17
path : Path object
18
19
Path of the config file (optional).
Copied!

get_brainglobe_dir [#88]

Check the source code online
1
def get_brainglobe_dir():
Copied!
  docstring:
1
Return brainglobe default directory.
2
3
Returns
4
5
-------
6
7
Path object
8
9
default BrainGlobe directory with atlases
Copied!

cli_modify_config [#100]

Check the source code online
1
def cli_modify_config(key=0, value=0, show=False):
Copied!
  docstring:
no docstring

_print_config [#117]

Check the source code online
1
def _print_config():
Copied!
  docstring:
1
Print configuration.
Copied!
Last modified 1yr ago