Add pulse timings dataclass by chris-ashe · Pull Request #4497 · ukaea/PROCESS

chris-ashe · 2026-08-03T14:37:46Z

This pull request refactors how pulse timing and cumulative time points are handled throughout the codebase by introducing and consistently applying the PulseTimings class. This change improves code clarity, reduces duplication, and centralizes pulse timing logic, making it easier to maintain and extend. The update affects plotting routines, model calculations, and output formatting for pulse-related data.

Pulse timing refactor and centralization:

Replaced manual cumulative time calculations in plotting functions (e.g., plot_current_profiles_over_time, plot_system_power_profiles_over_time, plot_cs_stress_time_profile) with usage of the new PulseTimings class, ensuring consistent time axis generation and annotation across all plots.
Updated model logic in physics.py and pfcoil.py to use PulseTimings for all derived pulse timing values, such as total pulse time, plasma-present time, and no-burn time, removing duplicated cumulative sum logic.
Modified power system models (power.py) to pass PulseTimings as an argument to the PF coil power calculation routines (pfpwr), ensuring all power calculations use unified pulse timing data.
Output and labeling improvements:
Standardized the use of pulse time labels and cumulative time points in output routines and plot annotations, using properties from PulseTimings for axis tick labels and time column headers.

Cleanup and removal of legacy code:

Removed legacy time label arrays and manual cumulative time calculations from times_variables.py and related model files, reducing code redundancy.

Checklist

I confirm that I have completed the following checks:

My changes follow the PROCESS style guide
I have justified any large differences in the regression tests caused by this pull request in the comments.
I have added new tests where appropriate for the changes I have made.
If I have had to change any existing unit or integration tests, I have justified this change in the pull request comments.
If I have made documentation changes, I have checked they render correctly.
I have added documentation for my change, if appropriate.

…or PFCoil to utilize it

codecov-commenter · 2026-08-03T14:48:50Z

Codecov Report

❌ Patch coverage is 65.71429% with 36 lines in your changes missing coverage. Please review.
✅ Project coverage is 49.23%. Comparing base (6dbb302) to head (438f7ee).
⚠️ Report is 9 commits behind head on main.

Files with missing lines	Patch %	Lines
process/core/io/plot/summary.py	13.04%	20 Missing ⚠️
process/models/pulse.py	89.65%	6 Missing ⚠️
process/models/pfcoil.py	16.66%	5 Missing ⚠️
process/models/physics/physics.py	25.00%	3 Missing ⚠️
process/models/power.py	85.71%	2 Missing ⚠️

Additional details and impacted files

@@            Coverage Diff             @@
##             main    #4497      +/-   ##
==========================================
- Coverage   49.30%   49.23%   -0.07%     
==========================================
  Files         151      152       +1     
  Lines       29611    29810     +199     
==========================================
+ Hits        14599    14677      +78     
- Misses      15012    15133     +121

☔ View full report in Codecov by Harness.
📢 Have feedback on the report? Share it here.

🚀 New features to boost your workflow:

❄️ Test Analytics: Detect flaky tests, report on failures, and find test suite problems.

…operties for PF coil active phases

…roved timing management

…d timing management

…mproved pulse timing management

…nd integrate point abbreviations for improved clarity in timing management

…iming management

…ings dataclass for improved clarity in timing representation

…leaner code

clmould · 2026-08-05T18:10:30Z

Atm power_profiles_over_time() is still calculating t_steps within:

but since pf_active_cumulative has replaced this, can pf_active_cumulative be an input to power_profiles_over_time()?

clmould · 2026-08-06T10:20:49Z

        return e_loss_pf_store_j + e_loss_pf_psu_j + e_loss_pf_bus_j

-    def pfpwr(self, output: bool):
+    def pfpwr(self, output: bool, PulseTimings: PulseTimings = PulseTimings):


Suggested change

def pfpwr(self, output: bool, PulseTimings: PulseTimings = PulseTimings):

def pfpwr(self, output: bool, pulse_timings: PulseTimings):

clmould · 2026-08-06T10:22:12Z

        output:

        """
+        pulse_timings = PulseTimings


Suggested change

pulse_timings = PulseTimings

clmould · 2026-08-06T10:24:46Z

    )

-    power.pfpwr(output=False)
+    power.pfpwr(output=False, PulseTimings=pfpwrparam.pulse_timings)


Suggested change

power.pfpwr(output=False, PulseTimings=pfpwrparam.pulse_timings)

power.pfpwr(output=False, pulse_timings=pfpwrparam.pulse_timings)

clmould · 2026-08-06T10:25:13Z

-        self.pfpwr(output=True)
+        self.pfpwr(
+            output=True,
+            PulseTimings=PulseTimings(


Suggested change

PulseTimings=PulseTimings(

pulse_timings=PulseTimings(

clmould · 2026-08-06T14:19:29Z

-            "Between Pulse",
-            "Restart Pulse",
-        ],
+        pulse_timings.point_labels,


Some overlap again in the labels

This has always been the case and is not caused by this PR

clmould · 2026-08-06T15:33:12Z

+        return len(self.total_pulse_cumulative)
+
+    @property
+    def n_pulse_points_intervals_total(self) -> int:


This doesn't seem to be getting used anywhere ?

clmould · 2026-08-06T15:42:22Z


+@dataclass(frozen=True, slots=True)
+class PulseTimings:
+    """Class to hold the timing parameters for a pulsed reactor."""


Suggested change

"""Class to hold the timing parameters for a pulsed reactor."""

"""Dataclass to hold the timing parameters for a pulsed reactor."""

clmould · 2026-08-06T16:04:28Z

        return e_loss_pf_store_j + e_loss_pf_psu_j + e_loss_pf_bus_j

-    def pfpwr(self, output: bool):
+    def pfpwr(self, output: bool, PulseTimings: PulseTimings = PulseTimings):


Can pulse_timings be added to the docstring please

clmould · 2026-08-06T16:25:33Z

+    point_abbreviations: ClassVar[tuple[str, ...]] = (
+        "BOP",
+        "EOR",
+        "BOF",
+        "EOF",
+        "EOP",
+        "Dwell",
+    )
+
+    point_labels: ClassVar[tuple[str, ...]] = (
+        "Coil precharge",
+        "$I_{\\text{p}}$ Ramp-Up",
+        "Fusion ramp",
+        "Burn",
+        "$I_{\\text{p}}$ ramp-down",
+        "Dwell",
+        "Restart pulse",
+    )


Since these are constants, can they be moved to the top of this file instead please?

I believe it is best to keep them as class variables contained withing the dataclass. Meaning everything is kept in one place. I have added a __post_init__ that checks that the number of labels always matches the number of points in the dataclass

…naming and enhance validation in PulseTimings dataclass

chris-ashe added 2 commits August 3, 2026 15:00

Add PulseTimings dataclass for managing pulse timing parameters

5650f87

Enhance PulseTimings class with timing interval properties and refact…

8f51b8b

…or PFCoil to utilize it

chris-ashe added PF Coils Refactor labels Aug 3, 2026

chris-ashe added 7 commits August 3, 2026 16:59

Refactor PulseTimings class to enhance timing calculations and add pr…

56966c9

…operties for PF coil active phases

Refactor PFCoil power model to utilize PulseTimings dataclass for imp…

aaec5d8

…roved timing management

Refactor plot functions to utilize PulseTimings dataclass for improve…

1bbe31f

…d timing management

Refactor Power model and test to utilize PulseTimings dataclass for i…

2b286cc

…mproved pulse timing management

Refactor TimesData and PulseTimings classes to remove unused labels a…

b767622

…nd integrate point abbreviations for improved clarity in timing management

Refactor Power model and test to utilize PulseTimings dataclass for t…

c3125cd

…iming management

Refactor plot functions to utilize updated point labels from PulseTim…

72047b0

…ings dataclass for improved clarity in timing representation

chris-ashe marked this pull request as ready for review August 4, 2026 12:31

chris-ashe requested a review from a team as a code owner August 4, 2026 12:31

Remove unused t_pulse_cumulative field from TimesData dataclass for c…

02e6759

…leaner code

clmould self-assigned this Aug 5, 2026

clmould reviewed Aug 6, 2026

View reviewed changes

Refactor Power model and tests to standardize PulseTimings parameter …

438f7ee

…naming and enhance validation in PulseTimings dataclass

Navigation Menu

Uh oh!

Add pulse timings dataclass - #4497

Add pulse timings dataclass#4497
chris-ashe wants to merge 11 commits into
mainfrom
add_pulse_timings_dataclass

chris-ashe commented Aug 3, 2026 •

edited

Loading

Uh oh!

codecov-commenter commented Aug 3, 2026 •

edited

Loading

Uh oh!

clmould Aug 5, 2026

Uh oh!

clmould Aug 6, 2026

Uh oh!

clmould Aug 6, 2026

Uh oh!

clmould Aug 6, 2026

Uh oh!

clmould Aug 6, 2026

Uh oh!

clmould Aug 6, 2026

Uh oh!

chris-ashe Aug 7, 2026

Uh oh!

clmould Aug 6, 2026

Uh oh!

clmould Aug 6, 2026

Uh oh!

clmould Aug 6, 2026

Uh oh!

clmould Aug 6, 2026

Uh oh!

chris-ashe Aug 7, 2026

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

3 participants

	def pfpwr(self, output: bool, PulseTimings: PulseTimings = PulseTimings):
	def pfpwr(self, output: bool, pulse_timings: PulseTimings):

	power.pfpwr(output=False, PulseTimings=pfpwrparam.pulse_timings)
	power.pfpwr(output=False, pulse_timings=pfpwrparam.pulse_timings)

	"""Class to hold the timing parameters for a pulsed reactor."""
	"""Dataclass to hold the timing parameters for a pulsed reactor."""

Uh oh!

Conversation

chris-ashe commented Aug 3, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Checklist

Uh oh!

codecov-commenter commented Aug 3, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Codecov Report

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

3 participants

chris-ashe commented Aug 3, 2026 •

edited

Loading

codecov-commenter commented Aug 3, 2026 •

edited

Loading