rminstr_specs
=============

.. py:module:: rminstr_specs


Submodules
----------

.. toctree::
   :maxdepth: 1

   /autoapi/rminstr_specs/Fluke_1620A/index
   /autoapi/rminstr_specs/HP34420A/index
   /autoapi/rminstr_specs/HP3458A/index
   /autoapi/rminstr_specs/K2450/index
   /autoapi/rminstr_specs/utilities/index


Exceptions
----------

.. autoapisummary::

   rminstr_specs.CalibrationWarning
   rminstr_specs.SpecsSettingWarning


Classes
-------

.. autoapisummary::

   rminstr_specs.Specification


Package Contents
----------------

.. py:class:: Specification(name: str, serial: str, n_mechanisms: int, mechanism_functions: list[Callable])

   Bases: :py:obj:`abc.ABC`


   
   Specification datasheet parent class.

   All specification sheets will inherit from this class.


   :Attributes:

       **n_mechanisms** : int
           Number of uncertanity mechanisms.

       **mechanism_functions** : list
           List of callable functions wite the mechanism functions.

       **name** : str
           Name of the instrument.

       **serial** : str
           Serial number of the instrument.

       **time_zero** : int
           Reference time. Set by the spec manager.













   ..
       !! processed by numpydoc !!

   .. py:attribute:: inst_list
      :value: []



   .. py:attribute:: n_mechanisms


   .. py:attribute:: mechanism_functions


   .. py:attribute:: name


   .. py:attribute:: serial


   .. py:attribute:: time_zero
      :value: None



   .. py:method:: all_manufacturer_errors(readings: numpy.ndarray, addition_method: str = 'spec') -> numpy.ndarray
      :abstractmethod:


      
      Return the sum of all manufacturer errors for readings.

      Ensure that errors are added in the way specified by the data sheet,
      if provided. The default is spec unless overridden by a child class.

      if spec, it will use the spec sheet addition method, if provided
      if linear, it will add linearly
      if quadrature, it will add in quadrature

      :Parameters:

          **readings** : _np.ndarray
              Array of measurements to get uncertainties for.

          **addition_method** : str, optional
              Specifies how the errors are added together. Linear will all the standard deviations linears,
              whereas quad will do a quadrature sum. Linear will give a worst case. The default is 'linear'.



      :Returns:

          np.ndarray
              Array of manufacturer errors of same shape as readings.











      ..
          !! processed by numpydoc !!


.. py:exception:: CalibrationWarning

   Bases: :py:obj:`UserWarning`


   Base class for warnings generated by user code.


   Initialize self.  See help(type(self)) for accurate signature.
















   ..
       !! processed by numpydoc !!


.. py:exception:: SpecsSettingWarning

   Bases: :py:obj:`UserWarning`


   Base class for warnings generated by user code.


   Initialize self.  See help(type(self)) for accurate signature.
















   ..
       !! processed by numpydoc !!