Add Tracker class for monitoring simulation metrics#41
Draft
Conversation
Related to #40 Add `Tracker` class and integrate it with `KrebsCycle` class to monitor simulation metrics. * **Add `Tracker` class**: Create `Tracker` class with methods `start_tracking()`, `log_change(metric: str, value: float)`, `report()`, and `reset()`. Add attributes `tracked_metrics` and `simulation_step`. Implement `EnergyTracker` and `CO2Tracker` classes inheriting from `Tracker`. * **Integrate `Tracker` with `KrebsCycle`**: Import `Tracker`, `EnergyTracker`, and `CO2Tracker` classes. Initialize instances of `EnergyTracker` and `CO2Tracker` in the `KrebsCycle` class constructor. Call `start_tracking()` method of `EnergyTracker` and `CO2Tracker` in the `run_cycle` method. Call `log_change()` method of `EnergyTracker` and `CO2Tracker` in each step method. Call `report()` method of `EnergyTracker` and `CO2Tracker` at the end of the `run_cycle` method. * **Add unit tests**: Add unit tests for the `Tracker` class methods `start_tracking()`, `log_change(metric: str, value: float)`, `report()`, and `reset()`. Add unit tests for the `EnergyTracker` and `CO2Tracker` classes. --- For more details, open the [Copilot Workspace session](https://copilot-workspace.githubnext.com/Dooders/Pyology/issues/40?shareId=XXXX-XXXX-XXXX-XXXX).
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Related to #40
Add
Trackerclass and integrate it withKrebsCycleclass to monitor simulation metrics.Trackerclass: CreateTrackerclass with methodsstart_tracking(),log_change(metric: str, value: float),report(), andreset(). Add attributestracked_metricsandsimulation_step. ImplementEnergyTrackerandCO2Trackerclasses inheriting fromTracker.TrackerwithKrebsCycle: ImportTracker,EnergyTracker, andCO2Trackerclasses. Initialize instances ofEnergyTrackerandCO2Trackerin theKrebsCycleclass constructor. Callstart_tracking()method ofEnergyTrackerandCO2Trackerin therun_cyclemethod. Calllog_change()method ofEnergyTrackerandCO2Trackerin each step method. Callreport()method ofEnergyTrackerandCO2Trackerat the end of therun_cyclemethod.Trackerclass methodsstart_tracking(),log_change(metric: str, value: float),report(), andreset(). Add unit tests for theEnergyTrackerandCO2Trackerclasses.For more details, open the Copilot Workspace session.