lib.parameter.ParamName

class lib.parameter.ParamName(*names)

Bases: lib.utils.BaseClass

Class representing a parameter name.

tuple

Tuple of string, typically (section, name), e.g. ('galaxy_bias','b1').

Type

tuple

Initialize ParamName.

Parameters

names (tuple, list, string, Parameter, ParamName) –

Can be:

  • tuple or list of strings, e.g. ('galaxy_bias','b1')

  • string with sections separated by a dot, e.g. 'galaxy_bias.b1'

  • Parameter instance, in which case its name attribute is copied.

  • ParamName instance, which is copied.

Methods

add_suffix

Add suffix to parameter name, i.e. append ‘_suffix’.

copy

Return shallow copy of self.

deepcopy

from_state

Instantiate and initalize class with state dictionary.

is_mpi_broadcast

is_mpi_gathered

is_mpi_root

is_mpi_scattered

load

Load class in numpy binary format from disk.

load_auto

If different formats are possible, this method should between them based on file name extension.

log_critical

log_debug

log_error

log_info

log_warning

save

Save class to disk.

save_auto

If different formats are possible, this method should between them based on file name extension.

Attributes

logger

mpiattrs

MPI attributes

mpicomm

mpiroot

mpistate

sep

add_suffix(suffix)

Add suffix to parameter name, i.e. append ‘_suffix’.

copy()

Return shallow copy of self.

classmethod from_state(state, mpiroot=0, mpicomm=None)

Instantiate and initalize class with state dictionary.

classmethod load(filename, mpiroot=0, mpicomm=None)

Load class in numpy binary format from disk. If the loaded state contains __class__ and that exists in cls._registry, return instance of cls._registry[__class__] (instead of cls).

load_auto(*args, **kwargs)

If different formats are possible, this method should between them based on file name extension.

property mpiattrs

MPI attributes

save(filename)

Save class to disk.

save_auto(*args, **kwargs)

If different formats are possible, this method should between them based on file name extension.