ksuit.schedules.base.schedule_base
==================================

.. py:module:: ksuit.schedules.base.schedule_base


Classes
-------

.. autoapisummary::

   ksuit.schedules.base.schedule_base.ScheduleBase


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

.. py:class:: ScheduleBase(overhang_percent = None, overhang_steps = None)

   Base class for schedulers in ksuit

   Initialize the scheduler.

   :param overhang_percent: The percentage by which the schedule is artificially prolonged.
   :param overhang_steps: The number of steps by which the schedule is artificially prolonged.


   .. py:attribute:: overhang_percent
      :value: None



   .. py:attribute:: overhang_steps
      :value: None



   .. py:method:: get_value(step, total_steps)

      Get the value of the schedule at a given step.

      This function includes the correction for overhangs in percent or steps and then calls the _get_value method.
      Therefore, it should not be overwritten by subclasses. Instead, the _get_value method should be implemented.

      :param step: The step for which to get the scheduler value.
      :param total_steps: The total number of steps.