Skip to content
GitLab

configure · Changes

Page history
Update configure authored by Francesco's avatar Francesco
Show whitespace changes
Inline Side-by-side
configure.md
View page @ be3f7fbf
......@@ -50,18 +50,18 @@ The value has been stored.
Three functions (methods) are available:
1. *loadConf*: loads options from existing configuration file. Input parameters are:
1. *pm.loadConf(...)*: loads options from existing configuration file. Input parameters are:
* section - the section of the configuration file (default=None)
* fpath - full path of the configuration file. If None reads *config_dir* and *config_file* variables (default=None)
* reset - if True, reset all options to default before load new values (default=False)
2. *writeConf*: writes current configuration to file. Input parameters are:
2. *pm.writeConf(...)*: writes current configuration to file. Input parameters are:
* section - the section of the configuration file
* fpath - full path of the conf file. If None reads *config_dir* and *config_file* variables (default=None)
3. *resetConf*: reset configuration to defaults. It doesn't require any option.
3. *pm.resetConf()*: reset configuration to defaults. It doesn't require any option.
**IMPORTANT**: In case of crash of *plot* or *aplot* function execution, *pm.resetConf()* is required, otherwise it will not work. As alternative option the *pm* object can be created again.
......