This pull request enhances the simulation process by refining the SimulationController and Reporter classes, adding type annotations, and introducing new unit tests. Key changes include improved logging, type annotations for better code clarity, and comprehensive docstrings for methods.
Enhancements to SimulationController and Reporter:
Added detailed docstrings to SimulationController and Reporter methods to describe their functionality and parameters. (pyology/simulation.py) [1][2][3][4][5][6][7][8][9][10][11][12]
Introduced type annotations for methods in SimulationController and Reporter to improve code readability and maintainability. (pyology/simulation.py) [1][2][3][4][5][6][7][8][9][10][11][12]
Logging Improvements:
Enhanced logging in fun.py to include initial metabolite levels for better traceability of simulation states. (fun.py)
Unit Tests:
Added comprehensive unit tests for SimulationController to ensure correct behavior of ATP levels, glucose consumption, and adenine nucleotide balance. (tests/test_simulation_controller.py)
csmangum
commented
1 month ago
This pull request enhances the simulation process by refining the
SimulationControllerandReporterclasses, adding type annotations, and introducing new unit tests. Key changes include improved logging, type annotations for better code clarity, and comprehensive docstrings for methods.Enhancements to
SimulationControllerandReporter:Added detailed docstrings to
SimulationControllerandReportermethods to describe their functionality and parameters. (pyology/simulation.py) [1] [2] [3] [4] [5] [6] [7] [8] [9] [10] [11] [12]Introduced type annotations for methods in
SimulationControllerandReporterto improve code readability and maintainability. (pyology/simulation.py) [1] [2] [3] [4] [5] [6] [7] [8] [9] [10] [11] [12]Logging Improvements:
fun.pyto include initial metabolite levels for better traceability of simulation states. (fun.py)Unit Tests:
SimulationControllerto ensure correct behavior of ATP levels, glucose consumption, and adenine nucleotide balance. (tests/test_simulation_controller.py)