Naming module

naming.specifiers: _specifiers

naming.sub_specifiers: _sub_specifiers

naming.specifiers_ss_para: _specifiers_ss_para

class DMT.core.naming.SpecifierStr(specifier: str | SpecifierStr, *nodes: str, sub_specifiers: FrozenSet[str | SpecifierStr] | Set[str | SpecifierStr] | List[str | SpecifierStr] | str | SpecifierStr | None = None)

Bases: str

Acts like a string, but at the same time has the attribute “nodes”

https://stackoverflow.com/a/2673863

Yeah it is already implemented :P

Parameters:

specifierstr

nodes[str], optional

sub_specifiers[str], str, {‘’, sub_specifier}, optional

Attributes:

specifierstr

nodes[str]

sub_specifiers[str]

get_descriptor()

Can be generalized using the _specifiers class.

get_pint_unit() → Unit

Return the DMT base unit of this specifier as a pint unit

get_tex_unit(scale=1, add='') → str

Get the unit of a given specifier in base units.

If scale is different from one, a suitable unit prefix is chosen. E.g. scale=1e3 and specifier=CURRENT -> si{milliampere}

Parameters:

scalefloat, integer

Unit prefix determination scale.

addstr

Additional string that is added to the unit

Returns:

unitstr

TeX representation of the specifer’s unit

nodes: List[str] = []

specifier: str = ''

classmethod string_from_load(string) → str

Generates a SpecifierStr from a string if the string was generated using string_to_save().

string_to_save() → str

Generates a single string which allows to identify the specifers, nodes and subspecifiers. Used to save into HDF5 as there the columns have to be valid strings.

sub_specifiers: FrozenSet[str] = []

to_label(scale=1, negative=False, divide_by_unit=False, **kwargs) → str

Generates a label for plots for this specifier, where scale determines the unit prefix.

Parameters:

scalefloat, integer, optional

Unit prefix determination scale.

negativebool, optional

If True, a minus sign is added before the label

divide_by_unitbool, optional

If True, the unit is given as division, if False in brackets.

kwargsoptional

Keyword arguments passed on to self.to_tex(). Currently this allows subscript and superscript strings.

Returns:

unitstr

TeX representation of the specifer’s unit

to_legend_with_value(value, scale=1, decimals=2, **kwargs) → str

Creates a SI legend entry in the form : specifier_tex = SI{value}{scale, spec_unit}

Parameters:

valuefloat

Value to print into the legend

scaleint, optional

Scaling of unit and value using SI prefixes, by default 1.

**kwargs

Are passed to specifier.to_tex

Returns:

str

math tex legend entry

to_raw_string() → str

get a raw string from the specifier -> can be used for string operations and variable naming…

Returns:

strstr

string conversion of self…

to_tex(subscript='', superscript='')

Return a Tex representation of this specifier. If subscript is not None the string in subscript will be appended. If superscript is not None, a superscript will be added.

Parameters:

subscriptstr

Subscript to add to the specifier’s Tex representation

superscriptstr

Superscript to add to the specifier’s Tex representation

Returns:

texstr

A Tex representation fo the specifier.

class DMT.core.naming._specifiers(*args, **kwargs)

ACCEPTORS = 'ACC'

CAPACITANCE = 'C'

CHARGE = 'Q'

CHARGE_DENSITY = "Q''"

CONDUCTANCE = 'G'

CONDUCTION_BAND_EDGE = 'EC'

CURRENT = 'I'

CURRENT_DENSITY = 'J'

DC_CURRENT_AMPLIFICATION = 'BETA'

DONNORS = 'DON'

ELECTRICAL_POTENTIAL = 'PSI'

ELECTRONS = 'N_ELE'

ENERGY = 'E'

FIELD = 'F'

FREQUENCY = 'FREQ'

GRADING = 'GRADING'

HOLES = 'P_HOL'

INDUCTANCE = 'L'

MAXIMUM_AVAILABLE_GAIN = 'MAG'

MAXIMUM_OSCILLATION_FREQUENCY = 'F_MAX'

MAXIMUM_STABLE_GAIN = 'MSG'

MOBILITY = 'MU'

NET_DOPING = 'NNET'

NOISE = 'N'

OUTPUT_CONDUCTANCE = 'GO'

POWER = 'P'

QUASI_FERMI_POTENTIAL = 'PHI'

RESISTANCE = 'R'

SPACE_CHARGE = 'RHO'

SS_PARA_A = 'A'

SS_PARA_H = 'H'

SS_PARA_S = 'S'

SS_PARA_T = 'T'

SS_PARA_Y = 'Y'

SS_PARA_Z = 'Z'

TEMPERATURE = 'TEMP'

TIME = 'TIME'

TRANSCONDUCTANCE = 'GM'

TRANSIT_FREQUENCY = 'F_T'

TRANSIT_TIME = 'TAU_F'

UNILATERAL_GAIN = 'GU'

VALENCE_BAND_EDGE = 'EV'

VELOCITY = 'VELO'

VOLTAGE = 'V'

X = 'x'

Y = 'y'

Z = 'z'

add_members(members)

class DMT.core.naming._sub_specifiers(*args, **kwargs)

AC = '|AC'

AC_1 = '|AC_1'

AC_2 = '|AC_2'

AC_BASE = '|AC_BASE'

AC_COLLECTOR = '|AC_COLLECTOR'

AC_DRAIN = '|AC_DRAIN'

AC_GATE = '|AC_GATE'

AREA = '|AREA'

CHANNEL = '|CHANNEL'

CORNER = '|CORNER'

DELTA = '|DELTA'

ELECTRONS = '|ELECTRONS'

FORCED = '|FORCED'

HOLES = '|HOLES'

IMAG = '|IMAG'

JUNCTION = '|JUNCTION'

LENGTH = '|LENGTH'

MAG = '|MAG'

MAJORITY = '|MAJORITY'

MAX = '|MAX'

MEAN = '|MEAN'

MID = '|MID'

MIN = '|MIN'

MINORITY = '|MINORITY'

NOISE = '|NOISE'

PERIMETER = '|PERI'

PHASE = '|PHASE'

QUASISTATIC = '|QUASISTATIC'

REAL = '|REAL'

TRAPS = '|TRAPS'

WIDTH = '|WIDTH'

XDIR = '|XDIR'

YDIR = '|YDIR'

ZDIR = '|ZDIR'

add_members(members)

class DMT.core.naming._specifiers_ss_para(*args, **kwargs)

SS_PARA_A = 'A'

SS_PARA_H = 'H'

SS_PARA_S = 'S'

SS_PARA_T = 'T'

SS_PARA_Y = 'Y'

SS_PARA_Z = 'Z'