tardis package

Subpackages

• tardis.energy_input package
  • Submodules
    • tardis.energy_input.GXPacket module
      • GXPacket
      • GXPacketCollection
      • GXPacketStatus
      • initialize_packet_properties()
    • tardis.energy_input.energy_source module
      • get_all_isotopes()
      • get_isotope_string()
      • get_nuclear_lines_database()
      • get_tau()
      • intensity_ratio()
      • positronium_continuum()
      • read_artis_lines()
      • setup_input_energy()
    • tardis.energy_input.gamma_packet_loop module
      • gamma_packet_loop()
      • process_packet_path()
    • tardis.energy_input.gamma_ray_channel module
      • calculate_total_decays()
      • create_inventories_dict()
      • create_isotope_decay_df()
      • create_isotope_dicts()
      • time_evolve_cumulative_decay()
      • time_evolve_mass_fraction()
    • tardis.energy_input.gamma_ray_estimators module
      • compton_emissivity_estimator()
      • deposition_estimator_kasen()
      • get_average_compton_fraction()
      • pair_creation_estimator()
    • tardis.energy_input.gamma_ray_grid module
      • calculate_distance_radial()
      • distance_trace()
      • move_packet()
    • tardis.energy_input.gamma_ray_interactions module
      • compton_scatter()
      • get_compton_angle()
      • get_compton_fraction()
      • get_compton_fraction_artis()
      • get_compton_fraction_urilight()
      • pair_creation_packet()
      • scatter_type()
    • tardis.energy_input.gamma_ray_packet_source module
      • GammaRayPacketSource
      • RadioactivePacketSource
    • tardis.energy_input.gamma_ray_transport module
      • calculate_average_energies()
      • calculate_average_power_per_mass()
      • calculate_ejecta_velocity_volume()
      • calculate_energy_per_mass()
      • calculate_total_decays_old()
      • create_inventories_dict_old()
      • create_isotope_dicts_old()
      • decay_chain_energies()
      • distribute_packets()
      • fractional_decay_energy()
      • get_chain_decay_power_per_ejectamass()
      • get_nuclide_atomic_number()
      • get_taus()
      • iron_group_fraction_per_shell()
      • packets_per_isotope()
    • tardis.energy_input.main_gamma_ray_loop module
      • get_effective_time_array()
      • get_packet_properties()
      • run_gamma_ray_loop()
    • tardis.energy_input.nuclear_energy_source module
    • tardis.energy_input.samplers module
      • PositroniumSampler
      • create_energy_cdf()
      • sample_decay_time()
      • sample_energy()
      • sample_energy_distribution()
      • sample_mass()
    • tardis.energy_input.util module
      • angle_aberration_gamma()
      • compton_theta_distribution()
      • convert_half_life_to_astropy_units()
      • doppler_factor_3D_all_packets()
      • doppler_factor_3d()
      • euler_rodrigues()
      • get_index()
      • get_perpendicular_vector()
      • get_random_phi_photon()
      • get_random_theta_photon()
      • get_random_unit_vector()
      • klein_nishina()
      • make_isotope_string_tardis_like()
      • normalize_vector()
      • solve_quadratic_equation()
      • solve_quadratic_equation_expanding()
      • spherical_to_cartesian()
  • Module contents
• tardis.grid package
  • Submodules
    • tardis.grid.base module
      • TardisGrid
  • Module contents
• tardis.gui package
  • Submodules
    • tardis.gui.datahandler module
    • tardis.gui.interface module
    • tardis.gui.widgets module
  • Module contents
• tardis.io package
  • Subpackages
    • tardis.io.atom_data package
      • Submodules
      • Module contents
    • tardis.io.configuration package
      • Submodules
      • Module contents
    • tardis.io.logger package
      • Submodules
      • Module contents
    • tardis.io.model package
      • Subpackages
      • Submodules
      • Module contents
  • Submodules
    • tardis.io.hdf_writer_mixin module
      • HDFWriterMixin
      • PlasmaWriterMixin
    • tardis.io.util module
      • MockRegexPattern
      • YAMLLoader
      • assert_equality()
      • check_equality()
      • download_from_url()
      • get_internal_data_path()
      • quantity_from_str()
      • traverse_configs()
      • yaml_load_file()
  • Module contents
• tardis.model package
  • Subpackages
    • tardis.model.geometry package
      • Submodules
      • Module contents
    • tardis.model.matter package
      • Submodules
      • Module contents
  • Submodules
    • tardis.model.base module
      • SimulationState
  • Module contents
• tardis.opacities package
  • Subpackages
    • tardis.opacities.continuum package
      • Submodules
      • Module contents
    • tardis.opacities.macro_atom package
      • Subpackages
      • Submodules
      • Module contents
  • Submodules
    • tardis.opacities.opacities module
      • calculate_tau_electron()
      • chi_bf_interpolator()
      • chi_continuum_calculator()
      • chi_electron_calculator()
      • chi_ff_calculator()
      • compton_opacity_calculation()
      • compton_opacity_partial()
      • get_current_bound_free_continua()
      • kappa_calculation()
      • pair_creation_opacity_artis()
      • pair_creation_opacity_calculation()
      • photoabsorption_opacity_calculation()
      • photoabsorption_opacity_calculation_kasen()
    • tardis.opacities.opacity_solver module
      • OpacitySolver
    • tardis.opacities.opacity_state module
      • OpacityState
      • OpacityStateNumba
      • opacity_state_initialize()
    • tardis.opacities.tau_sobolev module
      • BetaSobolev
      • TauSobolev
      • calculate_beta_sobolev()
      • calculate_sobolev_line_opacity()
  • Module contents
• tardis.plasma package
  • Subpackages
    • tardis.plasma.assembly package
      • Submodules
      • Module contents
    • tardis.plasma.electron_energy_distribution package
      • Submodules
      • Module contents
    • tardis.plasma.equilibrium package
      • Subpackages
      • Submodules
      • Module contents
    • tardis.plasma.properties package
      • Subpackages
      • Submodules
      • Module contents
    • tardis.plasma.radiation_field package
      • Submodules
      • Module contents
  • Submodules
    • tardis.plasma.base module
      • BasePlasma
      • PlasmaSolverSettings
    • tardis.plasma.exceptions module
      • IncompleteAtomicData
      • NotInitializedModule
      • PlasmaConfigError
      • PlasmaException
      • PlasmaIonizationError
      • PlasmaIsolatedModule
      • PlasmaMissingModule
    • tardis.plasma.standard_plasmas module
      • assemble_plasma()
  • Module contents
• tardis.scripts package
  • Submodules
    • tardis.scripts.cmfgen2tardis module
      • convert_format()
      • extract_file_block()
      • get_atomic_number()
      • main()
      • parse_file()
  • Module contents
• tardis.simulation package
  • Submodules
    • tardis.simulation.base module
      • PlasmaStateStorerMixin
      • Simulation
    • tardis.simulation.convergence module
      • ConvergenceSolver
  • Module contents
• tardis.spectrum package
  • Subpackages
    • tardis.spectrum.formal_integral package
      • Submodules
      • Module contents
  • Submodules
    • tardis.spectrum.base module
      • SpectrumSolver
    • tardis.spectrum.luminosity module
      • calculate_filtered_luminosity()
    • tardis.spectrum.spectrum module
      • TARDISSpectrum
  • Module contents
• tardis.stats package
  • Submodules
    • tardis.stats.base module
      • get_trivial_poisson_uncertainty()
  • Module contents
• tardis.transport package
  • Subpackages
    • tardis.transport.geometry package
      • Submodules
      • Module contents
    • tardis.transport.montecarlo package
      • Subpackages
      • Submodules
      • Module contents
  • Submodules
    • tardis.transport.frame_transformations module
      • angle_aberration_CMF_to_LF()
      • angle_aberration_LF_to_CMF()
      • calc_packet_energy()
      • calc_packet_energy_full_relativity()
      • get_doppler_factor()
      • get_doppler_factor_full_relativity()
      • get_doppler_factor_partial_relativity()
      • get_inverse_doppler_factor()
      • get_inverse_doppler_factor_full_relativity()
      • get_inverse_doppler_factor_partial_relativity()
  • Module contents
• tardis.util package
  • Submodules
    • tardis.util.base module
      • MalformedElementSymbolError
      • MalformedError
      • MalformedQuantityError
      • MalformedSpeciesError
      • atomic_number2element_symbol()
      • calculate_luminosity()
      • convert_abundances_format()
      • create_synpp_yaml()
      • deprecated()
      • element_symbol2atomic_number()
      • fix_bar_layout()
      • int_to_roman()
      • intensity_black_body()
      • is_notebook()
      • is_valid_nuclide_or_elem()
      • parse_quantity()
      • quantity_linspace()
      • reformat_element_symbol()
      • refresh_packet_pbar()
      • roman_to_int()
      • species_string_to_tuple()
      • species_tuple_to_string()
      • update_iterations_pbar()
      • update_packet_pbar()
  • Module contents
• tardis.visualization package
  • Subpackages
    • tardis.visualization.sdec package
      • Submodules
      • Module contents
    • tardis.visualization.tools package
      • Submodules
      • Module contents
    • tardis.visualization.widgets package
      • Submodules
      • Module contents
  • Submodules
    • tardis.visualization.plot_util module
      • axis_label_in_latex()
      • create_wavelength_mask()
      • expand_species_list()
      • extract_and_process_packet_data()
      • extract_and_process_packet_data_hdf()
      • extract_spectrum_data_hdf()
      • get_hex_color_strings()
      • get_mid_point_idx()
      • get_spectrum_data()
      • parse_species_list_util()
      • process_line_interactions()
      • to_rgb255_string()
  • Module contents
• tardis.workflows package
  • Submodules
    • tardis.workflows.simple_tardis_workflow module
      • SimpleTARDISWorkflow
    • tardis.workflows.standard_tardis_workflow module
      • StandardTARDISWorkflow
    • tardis.workflows.tardis_he_workflow module
      • TARDISHEWorkflow
      • TARDISHEWorkflowResult
    • tardis.workflows.util module
      • get_tau_integ()
    • tardis.workflows.v_inner_solver module
      • InnerVelocitySolverWorkflow
    • tardis.workflows.workflow_logging module
      • WorkflowLogging
  • Module contents

Submodules

• tardis.analysis module
  • LastLineInteraction
    • LastLineInteraction.atomic_number
    • LastLineInteraction.from_simulation()
    • LastLineInteraction.ion_number
    • LastLineInteraction.plot_wave_in_out()
    • LastLineInteraction.set_ion()
    • LastLineInteraction.shell
    • LastLineInteraction.update_last_interaction_filter()
    • LastLineInteraction.wavelength_end
    • LastLineInteraction.wavelength_start
  • TARDISHistory
    • TARDISHistory.calculate_departure_coefficients()
    • TARDISHistory.calculate_relative_lte_level_populations()
    • TARDISHistory.get_last_line_interaction()
    • TARDISHistory.load_atom_data()
    • TARDISHistory.load_ion_populations()
    • TARDISHistory.load_jblues()
    • TARDISHistory.load_level_populations()
    • TARDISHistory.load_spectrum()
    • TARDISHistory.load_t_inner()
    • TARDISHistory.load_t_rads()
    • TARDISHistory.load_ws()
• tardis.base module
  • run_tardis()
• tardis.constants module

Module contents

tardis.run_tardis(config, atom_data=None, packet_source=None, simulation_callbacks=None, virtual_packet_logging=False, show_convergence_plots=False, log_level=None, specific_log_level=None, show_progress_bars=True, display_logging_widget=True, **kwargs)

Run TARDIS from a given config object.

It will return a model object containing the TARDIS Simulation.

Parameters:

configstr or dict or tardis.io.config_reader.Configuration

filename of configuration yaml file or dictionary or TARDIS Configuration object

atom_datastr or tardis.atomic.AtomData, optional

If atom_data is a string it is interpreted as a path to a file storing the atomic data. Atomic data to use for this TARDIS simulation. If set to None (i.e. default), the atomic data will be loaded according to keywords set in the configuration

packet_sourceclass, optional

A custom packet source class or a child class of tardis.transport.montecarlo.packet_source used to override the TARDIS BasePacketSource class.

simulation_callbackslist of lists, default: [], optional

Set of callbacks to call at the end of every iteration of the Simulation. The format of the lists should look like: [[callback1, callback_arg1], [callback2, callback_arg2], …], where the callback function signature should look like: callback_function(simulation, extra_arg1, …)

virtual_packet_loggingbool, default: False, optional

Option to enable virtual packet logging.

log_level{‘NOTSET’, ‘DEBUG’, ‘INFO’, ‘WARNING’, ‘ERROR’, ‘CRITICAL’}, default: None, optional

Set the level of the TARDIS logger (follows native python logging framework log levels). Use this parameter to override the log_level specified in the configuration file. The default value None means that the log_level specified in the configuration file will be used.

specific_log_levelbool, default: None, optional

Allows to set specific logging levels, overriding the value in the configuration file. If True, only show the log messages from a particular log level, set by log_level. If False, the logger shows log messages belonging to the level set and all levels above it in severity. The default value None means that the specific_log_level specified in the configuration file will be used.

show_convergence_plotsbool, default: False, optional

Option to enable tardis convergence plots.

show_progress_barsbool, default: True, optional

Option to enable the progress bar.

display_widgetbool, default: True, optional

Option to display the logging widget in Jupyter/VSCode environments. If False, logs will be printed normally instead.

**kwargsdict, optional

Optional keyword arguments including those supported by tardis.visualization.tools.convergence_plot.ConvergencePlots.

Returns:

tardis.simulation.Simulation

Notes

Please see the logging tutorial to know more about log_level and specific options.