q-optimize/c3

View on GitHub
c3/model.py

Summary

Maintainability
D
2 days
Test Coverage

File model.py has 631 lines of code (exceeds 250 allowed). Consider refactoring.
Open

"""The model class, containing information on the system and its modelling."""
import warnings
import numpy as np
import hjson
import itertools
Severity: Major
Found in c3/model.py - About 1 day to fix

    Cyclomatic complexity is too high in method get_Hamiltonian. (10)
    Open

        def get_Hamiltonian(self, signal=None):
            """Get a hamiltonian with an optional signal. This will return an hamiltonian over time.
            Can be used e.g. for tuning the frequency of a transmon, where the control hamiltonian is not easily accessible.
            If max.excitation is non-zero the resulting Hamiltonian is cut accordingly"""
            if signal is None:
    Severity: Minor
    Found in c3/model.py by radon

    Cyclomatic Complexity

    Cyclomatic Complexity corresponds to the number of decisions a block of code contains plus 1. This number (also called McCabe number) is equal to the number of linearly independent paths through the code. This number can be used as a guide when testing conditional logic in blocks.

    Radon analyzes the AST tree of a Python program to compute Cyclomatic Complexity. Statements have the following effects on Cyclomatic Complexity:

    Construct Effect on CC Reasoning
    if +1 An if statement is a single decision.
    elif +1 The elif statement adds another decision.
    else +0 The else statement does not cause a new decision. The decision is at the if.
    for +1 There is a decision at the start of the loop.
    while +1 There is a decision at the while statement.
    except +1 Each except branch adds a new conditional path of execution.
    finally +0 The finally block is unconditionally executed.
    with +1 The with statement roughly corresponds to a try/except block (see PEP 343 for details).
    assert +1 The assert statement internally roughly equals a conditional statement.
    Comprehension +1 A list/set/dict comprehension of generator expression is equivalent to a for loop.
    Boolean Operator +1 Every boolean operator (and, or) adds a decision point.

    Source: http://radon.readthedocs.org/en/latest/intro.html

    Function get_Hamiltonian has a Cognitive Complexity of 18 (exceeds 5 allowed). Consider refactoring.
    Open

        def get_Hamiltonian(self, signal=None):
            """Get a hamiltonian with an optional signal. This will return an hamiltonian over time.
            Can be used e.g. for tuning the frequency of a transmon, where the control hamiltonian is not easily accessible.
            If max.excitation is non-zero the resulting Hamiltonian is cut accordingly"""
            if signal is None:
    Severity: Minor
    Found in c3/model.py - About 2 hrs to fix

    Cognitive Complexity

    Cognitive Complexity is a measure of how difficult a unit of code is to intuitively understand. Unlike Cyclomatic Complexity, which determines how difficult your code will be to test, Cognitive Complexity tells you how difficult your code will be to read and comprehend.

    A method's cognitive complexity is based on a few simple rules:

    • Code is not considered more complex when it uses shorthand that the language provides for collapsing multiple statements into one
    • Code is considered more complex for each "break in the linear flow of the code"
    • Code is considered more complex when "flow breaking structures are nested"

    Further reading

    Cyclomatic complexity is too high in method Hs_of_t. (7)
    Open

        def Hs_of_t(self, signal, interpolate_res=2):
            """
            Generate a list of Hamiltonians for each time step of interpolated signal for Runge-Kutta Methods.
    
            Args:
    Severity: Minor
    Found in c3/model.py by radon

    Cyclomatic Complexity

    Cyclomatic Complexity corresponds to the number of decisions a block of code contains plus 1. This number (also called McCabe number) is equal to the number of linearly independent paths through the code. This number can be used as a guide when testing conditional logic in blocks.

    Radon analyzes the AST tree of a Python program to compute Cyclomatic Complexity. Statements have the following effects on Cyclomatic Complexity:

    Construct Effect on CC Reasoning
    if +1 An if statement is a single decision.
    elif +1 The elif statement adds another decision.
    else +0 The else statement does not cause a new decision. The decision is at the if.
    for +1 There is a decision at the start of the loop.
    while +1 There is a decision at the while statement.
    except +1 Each except branch adds a new conditional path of execution.
    finally +0 The finally block is unconditionally executed.
    with +1 The with statement roughly corresponds to a try/except block (see PEP 343 for details).
    assert +1 The assert statement internally roughly equals a conditional statement.
    Comprehension +1 A list/set/dict comprehension of generator expression is equivalent to a for loop.
    Boolean Operator +1 Every boolean operator (and, or) adds a decision point.

    Source: http://radon.readthedocs.org/en/latest/intro.html

    Cyclomatic complexity is too high in method set_components. (6)
    Open

        def set_components(self, subsystems, couplings=None, max_excitations=0) -> None:
            for comp in subsystems:
                self.subsystems[comp.name] = comp
            for comp in couplings:
                self.couplings[comp.name] = comp
    Severity: Minor
    Found in c3/model.py by radon

    Cyclomatic Complexity

    Cyclomatic Complexity corresponds to the number of decisions a block of code contains plus 1. This number (also called McCabe number) is equal to the number of linearly independent paths through the code. This number can be used as a guide when testing conditional logic in blocks.

    Radon analyzes the AST tree of a Python program to compute Cyclomatic Complexity. Statements have the following effects on Cyclomatic Complexity:

    Construct Effect on CC Reasoning
    if +1 An if statement is a single decision.
    elif +1 The elif statement adds another decision.
    else +0 The else statement does not cause a new decision. The decision is at the if.
    for +1 There is a decision at the start of the loop.
    while +1 There is a decision at the while statement.
    except +1 Each except branch adds a new conditional path of execution.
    finally +0 The finally block is unconditionally executed.
    with +1 The with statement roughly corresponds to a try/except block (see PEP 343 for details).
    assert +1 The assert statement internally roughly equals a conditional statement.
    Comprehension +1 A list/set/dict comprehension of generator expression is equivalent to a for loop.
    Boolean Operator +1 Every boolean operator (and, or) adds a decision point.

    Source: http://radon.readthedocs.org/en/latest/intro.html

    Cyclomatic complexity is too high in method fromdict. (6)
    Open

        def fromdict(self, cfg: dict) -> None:
            """
            Load a file and parse it to create a Model object.
    
            Parameters
    Severity: Minor
    Found in c3/model.py by radon

    Cyclomatic Complexity

    Cyclomatic Complexity corresponds to the number of decisions a block of code contains plus 1. This number (also called McCabe number) is equal to the number of linearly independent paths through the code. This number can be used as a guide when testing conditional logic in blocks.

    Radon analyzes the AST tree of a Python program to compute Cyclomatic Complexity. Statements have the following effects on Cyclomatic Complexity:

    Construct Effect on CC Reasoning
    if +1 An if statement is a single decision.
    elif +1 The elif statement adds another decision.
    else +0 The else statement does not cause a new decision. The decision is at the if.
    for +1 There is a decision at the start of the loop.
    while +1 There is a decision at the while statement.
    except +1 Each except branch adds a new conditional path of execution.
    finally +0 The finally block is unconditionally executed.
    with +1 The with statement roughly corresponds to a try/except block (see PEP 343 for details).
    assert +1 The assert statement internally roughly equals a conditional statement.
    Comprehension +1 A list/set/dict comprehension of generator expression is equivalent to a for loop.
    Boolean Operator +1 Every boolean operator (and, or) adds a decision point.

    Source: http://radon.readthedocs.org/en/latest/intro.html

    Function __init__ has 6 arguments (exceeds 4 allowed). Consider refactoring.
    Open

        def __init__(
    Severity: Minor
    Found in c3/model.py - About 45 mins to fix

      Function get_init_state has a Cognitive Complexity of 8 (exceeds 5 allowed). Consider refactoring.
      Open

          def get_init_state(self) -> tf.Tensor:
              """Get an initial state. If a task to compute a thermal state is set, return that."""
              if self.init_state is None:
                  if "init_ground" in self.tasks:
                      print(
      Severity: Minor
      Found in c3/model.py - About 45 mins to fix

      Cognitive Complexity

      Cognitive Complexity is a measure of how difficult a unit of code is to intuitively understand. Unlike Cyclomatic Complexity, which determines how difficult your code will be to test, Cognitive Complexity tells you how difficult your code will be to read and comprehend.

      A method's cognitive complexity is based on a few simple rules:

      • Code is not considered more complex when it uses shorthand that the language provides for collapsing multiple statements into one
      • Code is considered more complex for each "break in the linear flow of the code"
      • Code is considered more complex when "flow breaking structures are nested"

      Further reading

      Function reorder_frame has a Cognitive Complexity of 8 (exceeds 5 allowed). Consider refactoring.
      Open

          def reorder_frame(
              self, e: tf.constant, v: tf.constant, ordered: bool
          ) -> Tuple[tf.constant, tf.constant, tf.constant]:
              """Reorders the new basis states according to their overlap with bare qubit states."""
              if ordered:
      Severity: Minor
      Found in c3/model.py - About 45 mins to fix

      Cognitive Complexity

      Cognitive Complexity is a measure of how difficult a unit of code is to intuitively understand. Unlike Cyclomatic Complexity, which determines how difficult your code will be to test, Cognitive Complexity tells you how difficult your code will be to read and comprehend.

      A method's cognitive complexity is based on a few simple rules:

      • Code is not considered more complex when it uses shorthand that the language provides for collapsing multiple statements into one
      • Code is considered more complex for each "break in the linear flow of the code"
      • Code is considered more complex when "flow breaking structures are nested"

      Further reading

      Function __create_matrix_representations has a Cognitive Complexity of 7 (exceeds 5 allowed). Consider refactoring.
      Open

          def __create_matrix_representations(self) -> None:
              """
              Using the annihilation operators as basis, compute the matrix represenations.
              """
              indx = 0
      Severity: Minor
      Found in c3/model.py - About 35 mins to fix

      Cognitive Complexity

      Cognitive Complexity is a measure of how difficult a unit of code is to intuitively understand. Unlike Cyclomatic Complexity, which determines how difficult your code will be to test, Cognitive Complexity tells you how difficult your code will be to read and comprehend.

      A method's cognitive complexity is based on a few simple rules:

      • Code is not considered more complex when it uses shorthand that the language provides for collapsing multiple statements into one
      • Code is considered more complex for each "break in the linear flow of the code"
      • Code is considered more complex when "flow breaking structures are nested"

      Further reading

      Function set_components has a Cognitive Complexity of 7 (exceeds 5 allowed). Consider refactoring.
      Open

          def set_components(self, subsystems, couplings=None, max_excitations=0) -> None:
              for comp in subsystems:
                  self.subsystems[comp.name] = comp
              for comp in couplings:
                  self.couplings[comp.name] = comp
      Severity: Minor
      Found in c3/model.py - About 35 mins to fix

      Cognitive Complexity

      Cognitive Complexity is a measure of how difficult a unit of code is to intuitively understand. Unlike Cyclomatic Complexity, which determines how difficult your code will be to test, Cognitive Complexity tells you how difficult your code will be to read and comprehend.

      A method's cognitive complexity is based on a few simple rules:

      • Code is not considered more complex when it uses shorthand that the language provides for collapsing multiple statements into one
      • Code is considered more complex for each "break in the linear flow of the code"
      • Code is considered more complex when "flow breaking structures are nested"

      Further reading

      Function set_max_excitations has a Cognitive Complexity of 6 (exceeds 5 allowed). Consider refactoring.
      Open

          def set_max_excitations(self, max_excitations) -> None:
              """
              Set the maximum number of excitations in the system used for propagation.
              """
              if max_excitations:
      Severity: Minor
      Found in c3/model.py - About 25 mins to fix

      Cognitive Complexity

      Cognitive Complexity is a measure of how difficult a unit of code is to intuitively understand. Unlike Cyclomatic Complexity, which determines how difficult your code will be to test, Cognitive Complexity tells you how difficult your code will be to read and comprehend.

      A method's cognitive complexity is based on a few simple rules:

      • Code is not considered more complex when it uses shorthand that the language provides for collapsing multiple statements into one
      • Code is considered more complex for each "break in the linear flow of the code"
      • Code is considered more complex when "flow breaking structures are nested"

      Further reading

      Function get_Frame_Rotation has a Cognitive Complexity of 6 (exceeds 5 allowed). Consider refactoring.
      Open

          def get_Frame_Rotation(self, t_final: np.float64, freqs: dict, framechanges: dict):
              """
              Compute the frame rotation needed to align Lab frame and rotating Eigenframes
              of the qubits.
      
      
      Severity: Minor
      Found in c3/model.py - About 25 mins to fix

      Cognitive Complexity

      Cognitive Complexity is a measure of how difficult a unit of code is to intuitively understand. Unlike Cyclomatic Complexity, which determines how difficult your code will be to test, Cognitive Complexity tells you how difficult your code will be to read and comprehend.

      A method's cognitive complexity is based on a few simple rules:

      • Code is not considered more complex when it uses shorthand that the language provides for collapsing multiple statements into one
      • Code is considered more complex for each "break in the linear flow of the code"
      • Code is considered more complex when "flow breaking structures are nested"

      Further reading

      Function set_init_state has a Cognitive Complexity of 6 (exceeds 5 allowed). Consider refactoring.
      Open

          def set_init_state(self, state):
              if self.lindbladian and state.shape[0] != state.shape[1]:
                  if state.shape[0] == self.tot_dim:
                      self.init_state = tf_utils.tf_state_to_dm(state)
                  elif state.shape[0] == self.tot_dim**2:
      Severity: Minor
      Found in c3/model.py - About 25 mins to fix

      Cognitive Complexity

      Cognitive Complexity is a measure of how difficult a unit of code is to intuitively understand. Unlike Cyclomatic Complexity, which determines how difficult your code will be to test, Cognitive Complexity tells you how difficult your code will be to read and comprehend.

      A method's cognitive complexity is based on a few simple rules:

      • Code is not considered more complex when it uses shorthand that the language provides for collapsing multiple statements into one
      • Code is considered more complex for each "break in the linear flow of the code"
      • Code is considered more complex when "flow breaking structures are nested"

      Further reading

      Function fromdict has a Cognitive Complexity of 6 (exceeds 5 allowed). Consider refactoring.
      Open

          def fromdict(self, cfg: dict) -> None:
              """
              Load a file and parse it to create a Model object.
      
              Parameters
      Severity: Minor
      Found in c3/model.py - About 25 mins to fix

      Cognitive Complexity

      Cognitive Complexity is a measure of how difficult a unit of code is to intuitively understand. Unlike Cyclomatic Complexity, which determines how difficult your code will be to test, Cognitive Complexity tells you how difficult your code will be to read and comprehend.

      A method's cognitive complexity is based on a few simple rules:

      • Code is not considered more complex when it uses shorthand that the language provides for collapsing multiple statements into one
      • Code is considered more complex for each "break in the linear flow of the code"
      • Code is considered more complex when "flow breaking structures are nested"

      Further reading

      Function update_Hamiltonians has a Cognitive Complexity of 6 (exceeds 5 allowed). Consider refactoring.
      Open

          def update_Hamiltonians(self):
              """Recompute the matrix representations of the Hamiltonians."""
              control_hams = dict()
              hamiltonians = dict()
              for key, sub in self.subsystems.items():
      Severity: Minor
      Found in c3/model.py - About 25 mins to fix

      Cognitive Complexity

      Cognitive Complexity is a measure of how difficult a unit of code is to intuitively understand. Unlike Cyclomatic Complexity, which determines how difficult your code will be to test, Cognitive Complexity tells you how difficult your code will be to read and comprehend.

      A method's cognitive complexity is based on a few simple rules:

      • Code is not considered more complex when it uses shorthand that the language provides for collapsing multiple statements into one
      • Code is considered more complex for each "break in the linear flow of the code"
      • Code is considered more complex when "flow breaking structures are nested"

      Further reading

      Function Hs_of_t has a Cognitive Complexity of 6 (exceeds 5 allowed). Consider refactoring.
      Open

          def Hs_of_t(self, signal, interpolate_res=2):
              """
              Generate a list of Hamiltonians for each time step of interpolated signal for Runge-Kutta Methods.
      
              Args:
      Severity: Minor
      Found in c3/model.py - About 25 mins to fix

      Cognitive Complexity

      Cognitive Complexity is a measure of how difficult a unit of code is to intuitively understand. Unlike Cyclomatic Complexity, which determines how difficult your code will be to test, Cognitive Complexity tells you how difficult your code will be to read and comprehend.

      A method's cognitive complexity is based on a few simple rules:

      • Code is not considered more complex when it uses shorthand that the language provides for collapsing multiple statements into one
      • Code is considered more complex for each "break in the linear flow of the code"
      • Code is considered more complex when "flow breaking structures are nested"

      Further reading

      There are no issues that match your filters.

      Category
      Status