spinqick.settings
=================

.. py:module:: spinqick.settings

.. autoapi-nested-parse::

   User specific settings.



Attributes
----------

.. autoapisummary::

   spinqick.settings.logger
   spinqick.settings.file_settings
   spinqick.settings.json_string


Classes
-------

.. autoapisummary::

   spinqick.settings.FileSettings
   spinqick.settings.FilterSettings


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

.. py:data:: logger

.. py:class:: FileSettings

   Bases: :py:obj:`pydantic_settings.BaseSettings`


   Specify the locations of each config file on your machine, and the directory to save data to.

   By default, the files are located in the spinqick repo, but its a good idea to save them
   elsewhere on your machine.


   .. py:attribute:: model_config


   .. py:attribute:: data_directory
      :type:  str
      :value: ''



   .. py:attribute:: hardware_config
      :type:  str
      :value: ''



   .. py:attribute:: dot_experiment_config
      :type:  str
      :value: ''



   .. py:attribute:: filter_config
      :type:  Optional[str]
      :value: None



.. py:class:: FilterSettings

   Bases: :py:obj:`pydantic_settings.BaseSettings`


   .. py:attribute:: iir_taps
      :type:  Tuple[List[float], List[float]] | None
      :value: None



   .. py:attribute:: iir_2_taps
      :type:  Tuple[List[float], List[float]] | None
      :value: None



   .. py:attribute:: fir_taps
      :type:  numpy.ndarray | None
      :value: None



   .. py:attribute:: apply_filter
      :type:  Literal['both', 'iir_1', 'iir_2', 'fir'] | None
      :value: None



.. py:data:: file_settings

.. py:data:: json_string