:py:mod:`neurorosettes.config`
==============================

.. py:module:: neurorosettes.config


Module Contents
---------------

Classes
~~~~~~~

.. autoapisummary::

   neurorosettes.config.TimerValidator
   neurorosettes.config.DomainValidator
   neurorosettes.config.ObjectValidator
   neurorosettes.config.ClocksValidator
   neurorosettes.config.InteractionsValidator
   neurorosettes.config.ConfigParser




.. py:class:: TimerValidator

   Bases: :py:obj:`pydantic.BaseModel`

   Class to parse and validate data on simulation time.

   .. py:attribute:: total_time
      :annotation: :float

      

   .. py:attribute:: step
      :annotation: :float

      

   .. py:method:: not_negative(v)

      Validates that simulation time data is not negative.



.. py:class:: DomainValidator

   Bases: :py:obj:`pydantic.BaseModel`

   Class to parse and validate data on simulation space.

   .. py:attribute:: min
      :annotation: :float

      

   .. py:attribute:: max
      :annotation: :float

      

   .. py:attribute:: step
      :annotation: :float

      

   .. py:method:: not_negative(v)

      Validates that simulation space data is not negative.



.. py:class:: ObjectValidator

   Bases: :py:obj:`pydantic.BaseModel`

   Class to parse and validate data on physical objects.

   .. py:attribute:: cell_radius
      :annotation: :float

      

   .. py:attribute:: cell_interaction_factor
      :annotation: :float

      

   .. py:attribute:: neurite_radius
      :annotation: :float

      

   .. py:attribute:: neurite_interaction_factor
      :annotation: :float

      

   .. py:attribute:: neurite_spring_constant
      :annotation: :float

      

   .. py:attribute:: neurite_default_length
      :annotation: :float

      

   .. py:method:: not_negative(v)

      Validates that physical objects data is not negative.



.. py:class:: ClocksValidator

   Bases: :py:obj:`pydantic.BaseModel`

   Class to parse and validate data on biological clocks.

   .. py:attribute:: proliferation_rate
      :annotation: :float

      

   .. py:attribute:: death_rate
      :annotation: :float

      

   .. py:attribute:: differentiation_rate
      :annotation: :float

      

   .. py:method:: not_negative(v)

      Validates that clocks data is not negative.



.. py:class:: InteractionsValidator

   Bases: :py:obj:`pydantic.BaseModel`

   Class to parse and validate data on object interactions.

   .. py:attribute:: type
      :annotation: :str

      

   .. py:attribute:: sphere_sphere_adhesion
      :annotation: :float

      

   .. py:attribute:: sphere_sphere_repulsion
      :annotation: :float

      

   .. py:attribute:: sphere_cylinder_adhesion
      :annotation: :float

      

   .. py:attribute:: sphere_cylinder_repulsion
      :annotation: :float

      

   .. py:attribute:: cylinder_cylinder_adhesion
      :annotation: :float

      

   .. py:attribute:: cylinder_cylinder_repulsion
      :annotation: :float

      

   .. py:attribute:: sphere_sphere_smoothness
      :annotation: :Optional[int]

      

   .. py:attribute:: sphere_cylinder_smoothness
      :annotation: :Optional[int]

      

   .. py:attribute:: cylinder_cylinder_smoothness
      :annotation: :Optional[int]

      

   .. py:method:: not_negative(v)

      Validates that ineractions data is not negative.



.. py:class:: ConfigParser(config_path)

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

   :param config_path: The path to the YAML file to be parsed.

   .. py:method:: get_time_data()

      Returns the simulation time data.


   .. py:method:: get_domain_data()

      Returns the simulation spatial data.


   .. py:method:: get_2d_status()

      Returns the simulation 2D status.


   .. py:method:: get_drag_coefficient()

      Returns the simulation domain's drag coefficient.


   .. py:method:: get_max_number_of_neurites()

      Returns the maximum number of neurites to be set on each neuron.


   .. py:method:: get_objects_data()

      Returns the data to create a factory instance for cell components.


   .. py:method:: get_clocks_data()

      Returns the data to create the biological clocks for the neurons.


   .. py:method:: get_interactions_data()

      Returns the data to create object physical interactions.