Merge pull request #333 from qutech/issues/332_repair_docs

Issues/332 repair docs

doc/source/qctoolkit.pulses.rst

@@ -28,14 +28,6 @@ qctoolkit\.pulses\.function\_pulse\_template module
     :undoc-members:
     :show-inheritance:
 
-qctoolkit\.pulses\.instructions module
---------------------------------------
-
-.. automodule:: qctoolkit.pulses.instructions
-    :members:
-    :undoc-members:
-    :show-inheritance:
-
 qctoolkit\.pulses\.interpolation module
 ---------------------------------------
 
@@ -100,10 +92,10 @@ qctoolkit\.pulses\.pulse\_template module
     :undoc-members:
     :show-inheritance:
 
-qctoolkit\.pulses\.pulse\_template\_parameter\_mapping module
--------------------------------------------------------------
+qctoolkit\.pulses\.mapping\_pulse\_template module
+--------------------------------------------------
 
-.. automodule:: qctoolkit.pulses.pulse_template_parameter_mapping
+.. automodule:: qctoolkit.pulses.mapping_pulse_template
     :members:
     :undoc-members:
     :show-inheritance:

qctoolkit/pulses/function_pulse_template.py

@@ -16,6 +16,7 @@
 from qctoolkit.expressions import ExpressionScalar
 from qctoolkit.serialization import Serializer, PulseRegistryType
 
+from qctoolkit.pulses.conditions import Condition
 from qctoolkit.utils.types import ChannelID, TimeType, time_from_float
 from qctoolkit.pulses.parameters import Parameter, ParameterConstrainer, ParameterConstraint
 from qctoolkit.pulses.pulse_template import AtomicPulseTemplate, MeasurementDeclaration

qctoolkit/pulses/loop_pulse_template.py

@@ -256,7 +256,7 @@ def get_serialization_data(self, serializer: Optional[Serializer]=None) -> Dict[
         return data
 
     @classmethod
-    def deserialize(cls, serializer: Optional[Serializer]=None, **kwargs) -> 'ForLoopTemplate':
+    def deserialize(cls, serializer: Optional[Serializer]=None, **kwargs) -> 'ForLoopPulseTemplate':
         if serializer: # compatibility to old serialization routines, deprecated
             kwargs['body'] = cast(PulseTemplate, serializer.deserialize(kwargs['body']))
         return super().deserialize(None, **kwargs)

qctoolkit/pulses/multi_channel_pulse_template.py

@@ -16,6 +16,7 @@
 
 from qctoolkit.serialization import Serializer, PulseRegistryType
 
+from qctoolkit.pulses.conditions import Condition
 from qctoolkit.utils.types import ChannelID, TimeType
 from qctoolkit._program.waveforms import MultiChannelWaveform
 from qctoolkit.pulses.pulse_template import PulseTemplate, AtomicPulseTemplate

qctoolkit/pulses/sequencing.py

@@ -10,8 +10,10 @@
 from abc import ABCMeta, abstractmethod
 from typing import Tuple, Dict, Union, Optional
 
-from qctoolkit.utils.types import ChannelID
+# solve circular dependence of type hints
+from . import conditions
 
+from qctoolkit.utils.types import ChannelID
 from qctoolkit._program.instructions import InstructionBlock, ImmutableInstructionBlock
 from qctoolkit._program.waveforms import Waveform
 from qctoolkit.pulses.parameters import Parameter, ConstantParameter
@@ -38,7 +40,7 @@ def atomicity(self) -> bool:
     def build_sequence(self,
                        sequencer: 'Sequencer',
                        parameters: Dict[str, Parameter],
-                       conditions: Dict[str, 'Condition'],
+                       conditions: Dict[str, 'conditions.Condition'],
                        measurement_mapping: Dict[str, Optional[str]],
                        channel_mapping: Dict[ChannelID, Optional[ChannelID]],
                        instruction_block: InstructionBlock) -> None:
@@ -61,7 +63,7 @@ def build_sequence(self,
     @abstractmethod
     def requires_stop(self,
                       parameters: Dict[str, Parameter],
-                      conditions: Dict[str, 'Condition']) -> bool:
+                      conditions: Dict[str, 'conditions.Condition']) -> bool:
         """Return True if this SequencingElement cannot be translated yet.
 
         Sequencer will check requires_stop() before calling build_sequence(). If requires_stop()
@@ -103,7 +105,7 @@ class Sequencer:
         SequencingElement
     """
 
-    StackElement = Tuple[SequencingElement, Dict[str, Parameter], Dict[str, 'Condition'], Dict[str,str]]
+    StackElement = Tuple[SequencingElement, Dict[str, Parameter], Dict[str, 'conditions.Condition'], Dict[str,str]]
 
     def __init__(self) -> None:
         """Create a Sequencer."""
@@ -116,7 +118,7 @@ def __init__(self) -> None:
     def push(self,
              sequencing_element: SequencingElement,
              parameters: Optional[Dict[str, Union[Parameter, float]]]=None,
-             conditions: Optional[Dict[str, 'Condition']]=None,
+             conditions: Optional[Dict[str, 'conditions.Condition']]=None,
              *,
              window_mapping: Optional[Dict[str, Optional[str]]]=None,
              channel_mapping: Optional[Dict[ChannelID, Optional[ChannelID]]]=None,

qctoolkit/pulses/table_pulse_template.py

@@ -25,6 +25,7 @@
 from qctoolkit._program.waveforms import TableWaveform, TableWaveformEntry
 from qctoolkit.expressions import ExpressionScalar, Expression
 from qctoolkit.pulses.multi_channel_pulse_template import MultiChannelWaveform
+from qctoolkit.pulses.conditions import Condition
 
 __all__ = ["TablePulseTemplate", "concatenate"]
 
@@ -248,7 +249,8 @@ def get_serialization_data(self, serializer: Optional[Serializer]=None) -> Dict[
 
     def build_waveform(self,
                        parameters: Dict[str, numbers.Real],
-                       channel_mapping: Dict[ChannelID, Optional[ChannelID]]) -> Optional['Waveform']:
+                       channel_mapping: Dict[ChannelID, Optional[ChannelID]]) -> Optional[Union[TableWaveform,
+                                                                                                MultiChannelWaveform]]:
         self.validate_parameter_constraints(parameters)
 
         if all(channel_mapping[channel] is None