resistics.config.data module

class resistics.config.data.ConfigData(configFile: str = '')

Bases: resistics.common.base.ResisticsBase

Class for holding cofiguration options

Attributes

configFilestr

Path to the configuration file

configParamsConfigObj

ConfigObj object to parse configuration information

Methods

__init__(configFile)	Initialise configuration data
configure()	Configure all the options
printList()	Class information as a list of strings

configure(self) → None

Set the configuration parameters

This sets a couple of flags in the configuration to regarding whether a custom set of evaluation frequencies are being used or a custom window size definition

getConfigComment(self) → str

Returns a string to add as a comment to data

Returns

str

Comment string to add to data

getSolverCores(self) → int

Returns the number of cores to run solver calculations on

There is a global ncores parameter and one in the Solver section. The Solver one takes precedent when they are both set.

Returns

ncoresint

The number of cores to run solver calculations on

getSpectraCores(self) → int

Returns the number of cores to run specrta calculations on

There is a global ncores parameter and one in the Spectra section. The Spectra one takes precedent when they are both set.

Returns

ncoresint

The number of cores to run spectra calculations on

getStatisticCores(self) → int

Returns the number of cores to run statistic calculations on

There is a global ncores parameter and one in the Statistics section. The Statistics one takes precedent when they are both set.

Returns

ncoresint

The number of cores to run statistic calculations on

printList(self) → List[str]

Class information as a list of strings

Returns

outList[str]

List of strings with information

printListSection(self, section: str) → List[str]

Configuration section information as a list of strings

Returns

outList[str]

List of strings with information