f4enix.core.irradiation.IrradiationScenario#

class f4enix.core.irradiation.IrradiationScenario(pulses: list[Pulse], name: str | None = None, cooling_times: list[Pulse] | None = None)#

Bases: object

Object representing an irradiation scenario which is characterized by a sequence of pulses and cooling times.

Parameters:

  • pulses (list[Pulse]) – list of irradiation pulses

  • name (str | None, optional) – irradiation scenario name, by default None

  • cooling_times (list[Pulse] | None, optional) – list of cooling time pulses, by default None. If None, a default cooling time of 0s is set.

Variables:

  • pulses (list[Pulse]) – list of irradiation pulses

  • name (str | None, optional) – irradiation scenario name, by default None

  • cooling_times (list[Pulse]) – list of cooling time pulses

  • cooling_labels (list[str]) – list of cooling time labels

Methods

__init__(pulses[, name, cooling_times])

Object representing an irradiation scenario which is characterized by a sequence of pulses and cooling times.

from_fispact(path_to_file)

Create an irradiation scenario from a fispact II input file.

from_legacy_d1stime(path_to_file)

Create an Irradiation Scenario object from a legacy d1stime input format.

get_collapsed_table()

Compile a dataframe with the irradiation sceario data.

set_cooling_times(cooling_times[, absolute])

set a number of cooling times.

Attributes

cooling_labels

Get the cooling time labels as a list of strings.

cooling_times

Get the cooling times as a list of Pulse objects.
property cooling_labels: list[str]#

Get the cooling time labels as a list of strings.

property cooling_times: list[Pulse]#

Get the cooling times as a list of Pulse objects.

classmethod from_fispact(path_to_file: Path | str | PathLike) → IrradiationScenario#

Create an irradiation scenario from a fispact II input file.

Parameters:

path_to_file (PathLike) – path to the fispact II input file.

Returns:

The irradiation scenario object.

Return type:

IrradiationScenario

classmethod from_legacy_d1stime(path_to_file: Path | str | PathLike) → IrradiationScenario#

Create an Irradiation Scenario object from a legacy d1stime input format.

Parameters:

path_to_file (PathLike) – path to the input file (d1stime legacy format).

Returns:

The irradiation scenario object.

Return type:

IrradiationScenario

get_collapsed_table() → DataFrame#

Compile a dataframe with the irradiation sceario data. Pulses or sequences of pulses that are repeated are collapsed into single entries with a multiplier.

set_cooling_times(cooling_times: list[tuple[float, TIME_UNITS]], absolute: bool = True) → None#

set a number of cooling times. Time can be expressed relatively to the previous time or absolute after shutdown.

Parameters:

  • cooling_times (list[tuple[float, TIME_UNITS]]) – list of cooling time durations and their units.

  • absolute (bool, optional) – if True, cooling times are absolute after shutdown; if False, they are relative to the previous time, by default True