larvaworld.lib.reg.parDB

Larvaworld parameter database

Attributes

output_dict
output_keys

Classes

ParamClass	Parameter database for storing and managing Larvaworld parameters.
ParamRegistry	Extended parameter registry with computation and display functionality.

Module Contents

larvaworld.lib.reg.parDB.output_dict: larvaworld.lib.util.AttrDict

larvaworld.lib.reg.parDB.output_keys: list[str]

class larvaworld.lib.reg.parDB.ParamClass

Parameter database for storing and managing Larvaworld parameters.

Provides a comprehensive database of all parameters used in larvaworld simulations, including physical parameters, behavioral parameters, and configuration options. Supports parameter lookup, unit management, and symbolic notation.

Attributes:

dict: Dictionary of parameter definitions ks: List of parameter keys kdict: Flattened parameter dictionary for quick lookup

Example:

>>> pclass = ParamClass()
>>> pclass.dict['length']
{'p': 'body_length', 'k': 'l', 'd': 'Body length', ...}

func_dict

k_ops

update_kdict(ks: list[str]) → None

Update the kdict with the parameters in the ks list

finalize() → None

Finalize the parameter database

property dkeys: larvaworld.lib.util.SuperList

property pkeys: larvaworld.lib.util.SuperList

property ks: larvaworld.lib.util.SuperList

build() → None

add(**kwargs: Any) → None

build_initial() → None

add_rate(k0: str | None = None, k_time: str = 't', p: str | None = None, k: str | None = None, d: str | None = None, sym: str | None = None, k_num: str | None = None, k_den: str | None = None, **kwargs: Any) → None

add_operators(k0: str) → None

add_chunk(pc: str, kc: str, func: Any = None, required_ks: list[str] = []) → None

add_chunk_track(kc: str, k: str, pc: str | None = None) → None

add_velNacc(k0: str, p_v: str | None = None, k_v: str | None = None, d_v: str | None = None, sym_v: str | None = None, disp_v: str | None = None, p_a: str | None = None, k_a: str | None = None, d_a: str | None = None, sym_a: str | None = None, disp_a: str | None = None, func_v: Any = None) → None

add_scaled(k0: str, **kwargs: Any) → None

add_unwrap(k0: str, **kwargs: Any) → None

add_dst(point: str = '', **kwargs: Any) → None

add_freq(k0: str, **kwargs: Any) → None

add_phi(k0: str, **kwargs: Any) → None

add_dsp(range: tuple[int, int] = (0, 40)) → None

add_tor(dur: int) → None

build_angular() → None

build_spatial() → None

build_chunks() → None

build_sim_pars() → None

build_deb_pars() → None

class larvaworld.lib.reg.parDB.ParamRegistry

Bases: ParamClass

Extended parameter registry with computation and display functionality.

Extends ParamClass with methods for parameter computation from datasets, performance index (PI) tracking, and parameter display utilities. Used as the central registry for all larvaworld parameter operations.

Attributes:

PI: AttrDict for storing Performance Index calculations

Example:

>>> preg = ParamRegistry()
>>> preg.get('l', dataset)  # Get body length parameter
>>> preg.compute(ks=['vel', 'acc'], d=dataset)

PI

get(k: str, d: Any, compute: bool = True)

compute(k: str, d: Any) → None

getPar(k: str | None = None, p: str | list[str] | None = None, d: str | list[str] | None = None, to_return: str | list[str] = 'd')

Retrieve the values of specific keys from a given parameter entry. Takes as argument the key by which to look up the parameter entry in the parameter database.

Args:

k (optional): Look up by short-key. p (optional): Look up by natural-language name. d (optional): Look up by dataset-based name. to_return (str, optional): Specifies the keys for which to return the values. Defaults to ‘d’.

Returns:

The values associated with the selected keys from the parameter entry.

runtime_pars() → list[str]

auto_load(ks: list[str], datasets: list[Any]) → larvaworld.lib.util.AttrDict

df_to_pint(df)

Method to convert a pandas dataframe to a pint-pandas dataframe by assigning a pint unit to every column (parameter). The pint-pandas readable pint unit is a string formatted by the unit registered in the parameter class (check “upint” property of the LarvaworldParam class in lib.util.data_aux)

output_reporters(ks: list[str], agents: list[Any]) → larvaworld.lib.util.AttrDict

get_reporters(agents: list[Any], cs: list[str] | None = None) → larvaworld.lib.util.AttrDict

select_output(pref: str) → larvaworld.lib.util.AttrDict

property brain_output: larvaworld.lib.util.AttrDict