simultipac package

This library holds several modules to treat data from Simulia softwares.

In particular: CST Particle Studio and SPARK3D. It was designed for multipactor studies.

Subpackages

• cst package
  • Submodules
    • helper module
      • get_id()
      • mmdd_xxxxxxx_folder_to_dict()
      • _parameters_file_to_dict()
      • no_extension()
    • simulation_results module
      • MissingFileError
      • CSTResults
        • CSTResults.__init__()
        • CSTResults.hist()
        • CSTResults.plot_3d()
        • CSTResults.plot_mesh()
        • CSTResults.plot_trajectories()
        • CSTResults._abc_impl
      • CSTResultsFactory
        • CSTResultsFactory._parameters_file
        • CSTResultsFactory._time_population_file
        • CSTResultsFactory.__init__()
        • CSTResultsFactory.mandatory_files
        • CSTResultsFactory.from_simulation_folder()
        • CSTResultsFactory._abc_impl
        • CSTResultsFactory._pop_e_acc()
        • CSTResultsFactory.from_simulation_folders()
• particle_monitor package
  • Subpackages
    • collisions package
      • Submodules
        • util module
        • vedo_mesh_collisions module
  • Submodules
    • converters module
      • adim_momentum_to_speed_m_per_s()
      • adim_momentum_to_speed_mm_per_ns()
      • adim_momentum_to_eV()
    • particle module
      • Particle
        • Particle.position
        • Particle.momentum
        • Particle._masses
        • Particle.mass
        • Particle.mass_eV
        • Particle._charges
        • Particle.charge
        • Particle.time
        • Particle.particle_id
        • Particle.source_id
        • Particle.extrapolated_times
        • Particle.__init__()
        • Particle.add_a_file()
        • Particle.finalize()
        • Particle._check_constanteness_of_some_attributes()
        • Particle.macro_charge
        • Particle._switch_to_mm_ns_units()
        • Particle._sort_by_increasing_time_values()
        • Particle.emission_energy
        • Particle.collision_energy
        • Particle.extrapolate_pos_and_mom_one_time_step_further()
        • Particle.determine_if_alive_at_end()
        • Particle.find_collision()
        • Particle.compute_emission_angle()
        • Particle.compute_collision_angle()
        • Particle.plot_trajectory()
      • _str_to_correct_types()
      • _get_constant()
      • _is_sorted()
    • particle_monitor module
      • _load_particle_monitor_file()
      • ParticleMonitor
        • ParticleMonitor.max_time
        • ParticleMonitor.FILTERS
        • ParticleMonitor.__init__()
        • ParticleMonitor.from_folder()
        • ParticleMonitor.seed_electrons
        • ParticleMonitor.emitted_electrons
        • ParticleMonitor.__str__()
        • ParticleMonitor.emission_energies()
        • ParticleMonitor.collision_energies()
        • ParticleMonitor.emission_angles()
        • ParticleMonitor.collision_angles()
        • ParticleMonitor.last_known_position()
        • ParticleMonitor.last_known_direction()
        • ParticleMonitor.compute_collision_angles()
        • ParticleMonitor.hist()
        • ParticleMonitor.plot_mesh()
        • ParticleMonitor.plot_trajectories()
        • ParticleMonitor.to_list
        • ParticleMonitor.to_pandas()
        • ParticleMonitor.filter_particles()
        • ParticleMonitor._load_mesh()
      • _absolute_file_paths()
      • _get_float_from_filename()
      • _sorted_particle_monitor_files()
      • _filter_source_id()
      • _filter_out_dead_at_end()
      • _filter_out_alive_at_end()
      • _filter_out_part_with_one_time_step()
    • vector module
      • Vector
        • Vector.__init__()
        • Vector.append()
        • Vector.reorder()
        • Vector.extrapolate()
        • Vector.normalize()
        • Vector.array
        • Vector.to_list
        • Vector.last
        • Vector.first
        • Vector.n_steps
        • Vector.extrapolated
      • Momentum
        • Momentum.__init__()
        • Momentum.extrapolate()
        • Momentum.emission_energy()
        • Momentum.collision_energy()
      • Position
        • Position.extrapolate()
        • Position.normalize()
• plotter package
  • Submodules
    • default module
      • DefaultPlotter
        • DefaultPlotter.__init__()
        • DefaultPlotter.vedo_backend
        • DefaultPlotter.plot()
        • DefaultPlotter._get_color_from_last_plot()
        • DefaultPlotter.hist()
        • DefaultPlotter.plot_3d()
        • DefaultPlotter.plot_mesh()
        • DefaultPlotter.plot_trajectory()
        • DefaultPlotter.load_mesh()
        • DefaultPlotter.show()
        • DefaultPlotter._k3d_patch()
    • plotter module
      • Plotter
        • Plotter.__init__()
        • Plotter.plot()
        • Plotter.hist()
        • Plotter.plot_3d()
        • Plotter.load_mesh()
        • Plotter.plot_mesh()
        • Plotter.plot_trajectory()
        • Plotter.show()
• simulation_results package
  • Submodules
    • simulation_results module
      • ShapeMismatchError
      • MissingDataError
      • SimulationResults
        • SimulationResults.__init__()
        • SimulationResults.__str__()
        • SimulationResults._check_consistent_shapes()
        • SimulationResults._trim_trailing()
        • SimulationResults.alpha
        • SimulationResults.fit_alpha()
        • SimulationResults.modelled_population
        • SimulationResults.plot()
        • SimulationResults.hist()
        • SimulationResults.to_pandas()
        • SimulationResults.show()
        • SimulationResults._abc_impl
      • SimulationResultsFactory
        • SimulationResultsFactory.__init__()
        • SimulationResultsFactory._abc_impl
    • simulations_results module
      • UnsupportedToolError
      • DuplicateIndexError
      • NonExistingIDError
      • SimulationsResults
        • SimulationsResults.__init__()
        • SimulationsResults._results
        • SimulationsResults._add()
        • SimulationsResults.get_by_id()
        • SimulationsResults.to_list
        • SimulationsResults.plot()
        • SimulationsResults._to_plot()
        • SimulationsResults._plot_0d()
        • SimulationsResults._to_pandas()
        • SimulationsResults.fit_alpha()
        • SimulationsResults.save()
        • SimulationsResults._format_for_save()
        • SimulationsResults.parameter_values()
        • SimulationsResults.with_parameter_value()
        • SimulationsResults.show()
      • SimulationsResultsFactory
        • SimulationsResultsFactory.__init__()
        • SimulationsResultsFactory.create()
        • SimulationsResultsFactory._create_individual()
• spark3d package
  • Submodules
    • simulation_results module
      • Spark3DResults
        • Spark3DResults._abc_impl
      • Spark3DResultsFactory
        • Spark3DResultsFactory.__init__()
        • Spark3DResultsFactory.from_file()
        • Spark3DResultsFactory._from_txt()
        • Spark3DResultsFactory._from_csv()
        • Spark3DResultsFactory._abc_impl
• util package
  • Submodules
    • exponential_growth module
      • ExpGrowthParameters
        • ExpGrowthParameters.n_0
        • ExpGrowthParameters.alpha
        • ExpGrowthParameters.t_0
        • ExpGrowthParameters.model
      • exp_growth()
      • exp_growth_log()
      • fit_alpha()
      • _to_fit()
      • _indexes_for_fit()
      • _n_points_in_a_period()
      • _design_space()
      • _smoothen()
    • log_manager module
      • _get_package_version()
      • _get_last_commit_hash()
      • _log_header()
      • _console_handler()
      • _file_handler()
      • LogFormatter
        • LogFormatter.COLOR_CODES
        • LogFormatter.RESET_CODE
        • LogFormatter.__init__()
        • LogFormatter.format()
      • main()
    • singleton module
      • SingletonMeta
        • SingletonMeta._instances
        • SingletonMeta._abc_impl

Submodules

• constants module
  • markdown
• types module
  • DATA_0D
  • DATA_0D_t
  • DATA_1D
  • DATA_1D_t