KarrLab/intro_to_wc_modeling

View on GitHub
intro_to_wc_modeling/cell_modeling/simulation/multi_algorithm/submodel_simulation.py

Summary

Maintainability
D
2 days
Test Coverage
A
100%

Function simulate has a Cognitive Complexity of 30 (exceeds 5 allowed). Consider refactoring.
Open

def simulate(mdl):
    # simulates model

    # Get metabolism submodel
    submdl = mdl.getComponentById('Metabolism')

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 simulate has 27 lines of code (exceeds 25 allowed). Consider refactoring.
Open

def simulate(mdl):
    # simulates model

    # Get metabolism submodel
    submdl = mdl.getComponentById('Metabolism')

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

    def analyzeResults(mdl, time, volume, growth, speciesCounts, output_directory):

      Similar blocks of code found in 2 locations. Consider refactoring.
      Open

      def main(output_directory=DEFAULT_OUTPUT_DIRECTORY):
          """ Run simulation, plot results, and save plots
      
          Args:
              output_directory (:obj:`str`, optional): directory to save plots        
      intro_to_wc_modeling/cell_modeling/simulation/multi_algorithm/simulation.py on lines 211..228

      Duplicated Code

      Duplicated code can lead to software that is hard to understand and difficult to change. The Don't Repeat Yourself (DRY) principle states:

      Every piece of knowledge must have a single, unambiguous, authoritative representation within a system.

      When you violate DRY, bugs and maintenance problems are sure to follow. Duplicated code has a tendency to both continue to replicate and also to diverge (leaving bugs as two similar implementations differ in subtle ways).

      Tuning

      This issue has a mass of 57.

      We set useful threshold defaults for the languages we support but you may want to adjust these settings based on your project guidelines.

      The threshold configuration represents the minimum mass a code block must have to be analyzed for duplication. The lower the threshold, the more fine-grained the comparison.

      If the engine is too easily reporting duplication, try raising the threshold. If you suspect that the engine isn't catching enough duplication, try lowering the threshold. The best setting tends to differ from language to language.

      See codeclimate-duplication's documentation for more information about tuning the mass threshold in your .codeclimate.yml.

      Refactorings

      Further Reading

      Similar blocks of code found in 3 locations. Consider refactoring.
      Open

              for part in rxn.participants:
                  if part.species.type == 'Protein':
                      initCopyNumber = mdl.speciesCounts[part.species.index, part.compartment.index]
      intro_to_wc_modeling/cell_modeling/simulation/multi_algorithm/submodel_simulation.py on lines 44..46
      intro_to_wc_modeling/cell_modeling/simulation/multi_algorithm/submodel_simulation.py on lines 64..66

      Duplicated Code

      Duplicated code can lead to software that is hard to understand and difficult to change. The Don't Repeat Yourself (DRY) principle states:

      Every piece of knowledge must have a single, unambiguous, authoritative representation within a system.

      When you violate DRY, bugs and maintenance problems are sure to follow. Duplicated code has a tendency to both continue to replicate and also to diverge (leaving bugs as two similar implementations differ in subtle ways).

      Tuning

      This issue has a mass of 46.

      We set useful threshold defaults for the languages we support but you may want to adjust these settings based on your project guidelines.

      The threshold configuration represents the minimum mass a code block must have to be analyzed for duplication. The lower the threshold, the more fine-grained the comparison.

      If the engine is too easily reporting duplication, try raising the threshold. If you suspect that the engine isn't catching enough duplication, try lowering the threshold. The best setting tends to differ from language to language.

      See codeclimate-duplication's documentation for more information about tuning the mass threshold in your .codeclimate.yml.

      Refactorings

      Further Reading

      Similar blocks of code found in 3 locations. Consider refactoring.
      Open

              for part in rxn.participants:
                  if part.species.type == 'RNA':
                      initCopyNumber = mdl.speciesCounts[part.species.index, part.compartment.index]
      intro_to_wc_modeling/cell_modeling/simulation/multi_algorithm/submodel_simulation.py on lines 44..46
      intro_to_wc_modeling/cell_modeling/simulation/multi_algorithm/submodel_simulation.py on lines 54..56

      Duplicated Code

      Duplicated code can lead to software that is hard to understand and difficult to change. The Don't Repeat Yourself (DRY) principle states:

      Every piece of knowledge must have a single, unambiguous, authoritative representation within a system.

      When you violate DRY, bugs and maintenance problems are sure to follow. Duplicated code has a tendency to both continue to replicate and also to diverge (leaving bugs as two similar implementations differ in subtle ways).

      Tuning

      This issue has a mass of 46.

      We set useful threshold defaults for the languages we support but you may want to adjust these settings based on your project guidelines.

      The threshold configuration represents the minimum mass a code block must have to be analyzed for duplication. The lower the threshold, the more fine-grained the comparison.

      If the engine is too easily reporting duplication, try raising the threshold. If you suspect that the engine isn't catching enough duplication, try lowering the threshold. The best setting tends to differ from language to language.

      See codeclimate-duplication's documentation for more information about tuning the mass threshold in your .codeclimate.yml.

      Refactorings

      Further Reading

      Similar blocks of code found in 3 locations. Consider refactoring.
      Open

              for part in rxn.participants:
                  if part.species.type == 'RNA':
                      initCopyNumber = mdl.speciesCounts[part.species.index, part.compartment.index]
      intro_to_wc_modeling/cell_modeling/simulation/multi_algorithm/submodel_simulation.py on lines 54..56
      intro_to_wc_modeling/cell_modeling/simulation/multi_algorithm/submodel_simulation.py on lines 64..66

      Duplicated Code

      Duplicated code can lead to software that is hard to understand and difficult to change. The Don't Repeat Yourself (DRY) principle states:

      Every piece of knowledge must have a single, unambiguous, authoritative representation within a system.

      When you violate DRY, bugs and maintenance problems are sure to follow. Duplicated code has a tendency to both continue to replicate and also to diverge (leaving bugs as two similar implementations differ in subtle ways).

      Tuning

      This issue has a mass of 46.

      We set useful threshold defaults for the languages we support but you may want to adjust these settings based on your project guidelines.

      The threshold configuration represents the minimum mass a code block must have to be analyzed for duplication. The lower the threshold, the more fine-grained the comparison.

      If the engine is too easily reporting duplication, try raising the threshold. If you suspect that the engine isn't catching enough duplication, try lowering the threshold. The best setting tends to differ from language to language.

      See codeclimate-duplication's documentation for more information about tuning the mass threshold in your .codeclimate.yml.

      Refactorings

      Further Reading

      Similar blocks of code found in 3 locations. Consider refactoring.
      Open

          analysis.plot(
              model=submdl,
              time=time,
              volume=volume,
              speciesCounts=speciesCounts,
      intro_to_wc_modeling/cell_modeling/simulation/multi_algorithm/simulation.py on lines 181..188
      intro_to_wc_modeling/cell_modeling/simulation/multi_algorithm/simulation.py on lines 191..198

      Duplicated Code

      Duplicated code can lead to software that is hard to understand and difficult to change. The Don't Repeat Yourself (DRY) principle states:

      Every piece of knowledge must have a single, unambiguous, authoritative representation within a system.

      When you violate DRY, bugs and maintenance problems are sure to follow. Duplicated code has a tendency to both continue to replicate and also to diverge (leaving bugs as two similar implementations differ in subtle ways).

      Tuning

      This issue has a mass of 43.

      We set useful threshold defaults for the languages we support but you may want to adjust these settings based on your project guidelines.

      The threshold configuration represents the minimum mass a code block must have to be analyzed for duplication. The lower the threshold, the more fine-grained the comparison.

      If the engine is too easily reporting duplication, try raising the threshold. If you suspect that the engine isn't catching enough duplication, try lowering the threshold. The best setting tends to differ from language to language.

      See codeclimate-duplication's documentation for more information about tuning the mass threshold in your .codeclimate.yml.

      Refactorings

      Further Reading

      Similar blocks of code found in 2 locations. Consider refactoring.
      Open

          analysis.plot(
              model=submdl,
              time=time,
              volume=volume,
              speciesCounts=speciesCounts,
      intro_to_wc_modeling/cell_modeling/simulation/multi_algorithm/simulation.py on lines 171..178

      Duplicated Code

      Duplicated code can lead to software that is hard to understand and difficult to change. The Don't Repeat Yourself (DRY) principle states:

      Every piece of knowledge must have a single, unambiguous, authoritative representation within a system.

      When you violate DRY, bugs and maintenance problems are sure to follow. Duplicated code has a tendency to both continue to replicate and also to diverge (leaving bugs as two similar implementations differ in subtle ways).

      Tuning

      This issue has a mass of 43.

      We set useful threshold defaults for the languages we support but you may want to adjust these settings based on your project guidelines.

      The threshold configuration represents the minimum mass a code block must have to be analyzed for duplication. The lower the threshold, the more fine-grained the comparison.

      If the engine is too easily reporting duplication, try raising the threshold. If you suspect that the engine isn't catching enough duplication, try lowering the threshold. The best setting tends to differ from language to language.

      See codeclimate-duplication's documentation for more information about tuning the mass threshold in your .codeclimate.yml.

      Refactorings

      Further Reading

      Similar blocks of code found in 6 locations. Consider refactoring.
      Open

          analysis.plot(
              model=submdl,
              time=time,
              yDatas={'Volume': volume},
              fileName=os.path.join(output_directory, 'Volume.png')
      intro_to_wc_modeling/cell_modeling/simulation/multi_algorithm/simulation.py on lines 143..147
      intro_to_wc_modeling/cell_modeling/simulation/multi_algorithm/simulation.py on lines 150..154
      intro_to_wc_modeling/cell_modeling/simulation/multi_algorithm/simulation.py on lines 157..161
      intro_to_wc_modeling/cell_modeling/simulation/multi_algorithm/simulation.py on lines 164..168
      intro_to_wc_modeling/cell_modeling/simulation/multi_algorithm/submodel_simulation.py on lines 137..141

      Duplicated Code

      Duplicated code can lead to software that is hard to understand and difficult to change. The Don't Repeat Yourself (DRY) principle states:

      Every piece of knowledge must have a single, unambiguous, authoritative representation within a system.

      When you violate DRY, bugs and maintenance problems are sure to follow. Duplicated code has a tendency to both continue to replicate and also to diverge (leaving bugs as two similar implementations differ in subtle ways).

      Tuning

      This issue has a mass of 33.

      We set useful threshold defaults for the languages we support but you may want to adjust these settings based on your project guidelines.

      The threshold configuration represents the minimum mass a code block must have to be analyzed for duplication. The lower the threshold, the more fine-grained the comparison.

      If the engine is too easily reporting duplication, try raising the threshold. If you suspect that the engine isn't catching enough duplication, try lowering the threshold. The best setting tends to differ from language to language.

      See codeclimate-duplication's documentation for more information about tuning the mass threshold in your .codeclimate.yml.

      Refactorings

      Further Reading

      Similar blocks of code found in 6 locations. Consider refactoring.
      Open

          analysis.plot(
              model=submdl,
              time=time,
              yDatas={'Growth': growth},
              fileName=os.path.join(output_directory, 'Growth.png')
      intro_to_wc_modeling/cell_modeling/simulation/multi_algorithm/simulation.py on lines 143..147
      intro_to_wc_modeling/cell_modeling/simulation/multi_algorithm/simulation.py on lines 150..154
      intro_to_wc_modeling/cell_modeling/simulation/multi_algorithm/simulation.py on lines 157..161
      intro_to_wc_modeling/cell_modeling/simulation/multi_algorithm/simulation.py on lines 164..168
      intro_to_wc_modeling/cell_modeling/simulation/multi_algorithm/submodel_simulation.py on lines 130..134

      Duplicated Code

      Duplicated code can lead to software that is hard to understand and difficult to change. The Don't Repeat Yourself (DRY) principle states:

      Every piece of knowledge must have a single, unambiguous, authoritative representation within a system.

      When you violate DRY, bugs and maintenance problems are sure to follow. Duplicated code has a tendency to both continue to replicate and also to diverge (leaving bugs as two similar implementations differ in subtle ways).

      Tuning

      This issue has a mass of 33.

      We set useful threshold defaults for the languages we support but you may want to adjust these settings based on your project guidelines.

      The threshold configuration represents the minimum mass a code block must have to be analyzed for duplication. The lower the threshold, the more fine-grained the comparison.

      If the engine is too easily reporting duplication, try raising the threshold. If you suspect that the engine isn't catching enough duplication, try lowering the threshold. The best setting tends to differ from language to language.

      See codeclimate-duplication's documentation for more information about tuning the mass threshold in your .codeclimate.yml.

      Refactorings

      Further Reading

      There are no issues that match your filters.

      Category
      Status