cassis_lte_python.sim.parameters
================================

.. py:module:: cassis_lte_python.sim.parameters


Attributes
----------

.. autoapisummary::

   cassis_lte_python.sim.parameters.LOGGER


Classes
-------

.. autoapisummary::

   cassis_lte_python.sim.parameters.Parameter
   cassis_lte_python.sim.parameters.Parameters


Functions
---------

.. autoapisummary::

   cassis_lte_python.sim.parameters.parameter_infos
   cassis_lte_python.sim.parameters.create_parameter


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

.. py:data:: LOGGER

.. py:class:: Parameter(name: str, value: float | int, vary=True, min=-np.inf, max=np.inf, expr=None, factor=False, difference=False, user_data=None)

   .. py:attribute:: factors
      :value: None



   .. py:attribute:: diffs
      :value: None



   .. py:attribute:: user_data
      :value: None



   .. py:method:: to_dict(user_value=False)


   .. py:method:: set(value=None, min=None, max=None, expr=None, vary=None, stderr=None, abs_min=None, abs_max=None, use_int_fit=None, init=False, param=None)


   .. py:method:: at_boundary(rel_tol=0.05)


   .. py:property:: name


   .. py:property:: value


   .. py:property:: user_value


   .. py:property:: stderr


   .. py:property:: expr


   .. py:property:: vary


   .. py:property:: use_in_fit


   .. py:property:: min


   .. py:property:: max


   .. py:property:: abs_min


   .. py:property:: abs_max


.. py:class:: Parameters(mapping=None, /, **kwargs)

   Bases: :py:obj:`dict`


   Parameters dictionary for simulation configuration.

   Extends the built-in dict class with additional functionality
   for handling simulation parameters.


   .. py:method:: update_parameters(new_parameters)


   .. py:method:: copy_parameters(new_parameters)


   .. py:method:: set_attribute(attribute, value)

      For all parameters, set the given attribute to the given value.

      :param attribute: The attribute to set.
      :param value: The value to set.
      :return:



.. py:function:: parameter_infos(value=None, min=None, max=None, expr=None, vary=True, factor=False, difference=False, user_data=None)

.. py:function:: create_parameter(name, param)