tardis.workflows.tardis_he_workflow module¶
- class tardis.workflows.tardis_he_workflow.TARDISHEWorkflow(atom_data, configuration, config_type='yaml')[source]¶
 Bases:
object- calculate_total_decays(time_start, time_end)[source]¶
 Calculate the total number of decays for each isotope in the simulation state between t_start and t_end for each shell.
- Parameters:
 - time_startfloat
 The start time in days.
- time_endfloat
 The end time in days.
- Returns:
 - total_decaysdataframe
 A dataframe containing the total number of decays for each isotope in the simulation state between t_start and t_end for each shell.
- decay_isotopes_expanded(total_decays)[source]¶
 Expand the total decays dataframe to include the decay energy for each gamma-X ray transition in each shell between t_start and t_end.
- Parameters:
 - total_decaysdataframe
 A dataframe containing the total number of decays for each isotope in the simulation state between t_start and t_end for each shell.
- Returns:
 - decay_isotopesdataframe
 A dataframe containing the total number of decays for each isotope in the simulation state between t_start and t_end for each shell expanded to include the decay energy for each gamma-X ray transition.
- get_times(time_start, time_end, time_space, time_steps)[source]¶
 Create an array of times between t_start and t_end.
- Parameters:
 - time_startfloat
 The start time in days.
- time_endfloat
 The end time in days.
- time_spacestring
 The time spacing between time steps (‘linear’ or ‘log’).
- time_stepsint
 The number of time steps to take between t_start and t_end.
- Returns:
 - timesarray
 An array of times in days.
- run(time_start, time_end, number_of_packets, time_steps, time_space, seed, fp, spectrum_bins, grey_opacity=-1)[source]¶
 Run the gamma-ray transport simulation.
- Parameters:
 - time_startfloat
 The start time in days.
- time_endfloat
 The end time in days.
- timesarray
 An array of times in days.
- number_of_packetsint
 The number of packets to simulate.
- time_stepsint
 The number of time steps to take between t_start and t_end.
- time_spacestring
 The time spacing between time steps.
- seedint
 The random seed for the simulation.
- fpfloat
 Positronium fraction
- spectrum_binsint
 The number of bins in the spectrum.
- grey_opacityfloat
 The grey opacity of the simulation.
- time_evolve_cumulative_decay_expanded(times)[source]¶
 Time evolve the cumulative decay for each isotope in the simulation state between t_start and t_end for each shell.
- Parameters:
 - timesarray
 An array of times in days.
- Returns:
 - cumulative_decaydataframe
 A dataframe containing the cumulative decay for each isotope, each transition each shell for all time steps between t_start and t_end.
- class tardis.workflows.tardis_he_workflow.TARDISHEWorkflowResult(escape_energy: pandas.core.frame.DataFrame, escape_energy_cosi: pandas.core.frame.DataFrame, packets_escaped: pandas.core.frame.DataFrame, gamma_ray_deposited_energy: pandas.core.frame.DataFrame, total_deposited_energy: pandas.core.frame.DataFrame, positron_energy: pandas.core.frame.DataFrame)[source]¶
 Bases:
object- escape_energy: DataFrame¶
 
- escape_energy_cosi: DataFrame¶
 
- gamma_ray_deposited_energy: DataFrame¶
 
- packets_escaped: DataFrame¶
 
- positron_energy: DataFrame¶
 
- total_deposited_energy: DataFrame¶