`neurorosettes.config`#

Module Contents#

Classes#

`TimerValidator`	Class to parse and validate data on simulation time.
`DomainValidator`	Class to parse and validate data on simulation space.
`ObjectValidator`	Class to parse and validate data on physical objects.
`ClocksValidator`	Class to parse and validate data on biological clocks.
`InteractionsValidator`	Class to parse and validate data on object interactions.
`ConfigParser`	Class to read the inputs from the YAML file and validate them.

class neurorosettes.config.TimerValidator[source]#

Bases: pydantic.BaseModel

Class to parse and validate data on simulation time.

total_time :float#

step :float#

not_negative(v)[source]#: Validates that simulation time data is not negative.

class neurorosettes.config.DomainValidator[source]#

Bases: pydantic.BaseModel

Class to parse and validate data on simulation space.

min :float#

max :float#

step :float#

not_negative(v)[source]#: Validates that simulation space data is not negative.

class neurorosettes.config.ObjectValidator[source]#

Bases: pydantic.BaseModel

Class to parse and validate data on physical objects.

cell_radius :float#

cell_interaction_factor :float#

neurite_radius :float#

neurite_interaction_factor :float#

neurite_spring_constant :float#

neurite_default_length :float#

not_negative(v)[source]#: Validates that physical objects data is not negative.

class neurorosettes.config.ClocksValidator[source]#

Bases: pydantic.BaseModel

Class to parse and validate data on biological clocks.

proliferation_rate :float#

death_rate :float#

differentiation_rate :float#

not_negative(v)[source]#: Validates that clocks data is not negative.

class neurorosettes.config.InteractionsValidator[source]#

Bases: pydantic.BaseModel

Class to parse and validate data on object interactions.

type :str#

sphere_sphere_adhesion :float#

sphere_sphere_repulsion :float#

sphere_cylinder_adhesion :float#

sphere_cylinder_repulsion :float#

cylinder_cylinder_adhesion :float#

cylinder_cylinder_repulsion :float#

sphere_sphere_smoothness :Optional[int]#

sphere_cylinder_smoothness :Optional[int]#

cylinder_cylinder_smoothness :Optional[int]#

not_negative(v)[source]#: Validates that ineractions data is not negative.

class neurorosettes.config.ConfigParser(config_path)[source]#

Class to read the inputs from the YAML file and validate them.

Parameters: config_path (pathlib.Path) – The path to the YAML file to be parsed.

get_time_data()[source]#: Returns the simulation time data.

get_domain_data()[source]#: Returns the simulation spatial data.

get_2d_status()[source]#: Returns the simulation 2D status.

get_drag_coefficient()[source]#: Returns the simulation domain’s drag coefficient.

get_max_number_of_neurites()[source]#: Returns the maximum number of neurites to be set on each neuron.

get_objects_data()[source]#: Returns the data to create a factory instance for cell components.

get_clocks_data()[source]#: Returns the data to create the biological clocks for the neurons.

get_interactions_data()[source]#: Returns the data to create object physical interactions.

neurorosettes.config#

Module Contents#

Classes#

`neurorosettes.config`#