API Reference

Submodules

• utils module
  • get_results_folder()
  • prm_to_dict()
  • match_index()
  • find_closest_index()
  • sapphirepp_colors()
  • colorblind_colors()
  • set_matplotlib_style()
• PlotProperties
  • PlotProperties
• pvload module
  • read_parameter_file()
  • load_csv()
  • load_solution_vtk()
  • load_solution_vtu()
  • load_solution_pvtu()
  • load_solution_pvtp()
  • load_solution_hdf5_with_xdmf()
  • scale_time_steps()
  • load_solution()
  • load_extract()
• pvplot module
  • plot_line_chart_view()
  • plot_render_view_2d()
  • plot_render_view_3d()
  • show_overlay_2d()
  • show_outline()
  • display_text()
  • display_time()
  • show_spread_sheet()
  • save_screenshot()
  • save_animation()
  • save_view()
• transform module
  • create_extractor()
  • save_extracts()
  • calculator()
  • point_data_to_cell_data()
  • plot_over_line()
  • slice_plane()
  • probe_location()
  • integrate_variables()
  • plot_over_time()
  • clip_area()
  • contour_lines()
  • stream_tracer()
• numpyify module
  • to_numpy_1d()
  • to_numpy_point_list()
  • to_numpy_2d()
  • to_numpy_3d()
  • to_numpy_time_steps()
  • to_numpy_time_steps_2d()
  • to_numpy_time_steps_3d()
  • to_numpy_integrate_variables()
  • to_numpy_over_time()
• PlotPropertiesVFP
  • PlotPropertiesVFP
• vfp module
  • load_solution()
  • load_probe_location_surface()
  • load_probe_location_spherical_density()
  • scale_distribution_function()
  • merge_input_function_vectors()
  • plot_f_lms_1d()
  • plot_f_lms_2d()
  • plot_f_lms_3d()
  • plot_f_lms_over_x()
  • plot_f_lms_over_p()
  • plot_phase_space_surface()
  • plot_elevated_phase_space_surface()
  • plot_phase_space_spherical_density_map()
• PlotPropertiesMHD
  • PlotPropertiesMHD
• mhd module
  • load_solution()
  • save_to_dat()
  • compute_kinetic_energy()
  • compute_sound_speed()
  • compute_alfven_speed()
  • compute_mach_number()
  • compute_alfven_mach_number()
  • compute_magnetic_pressure()
  • compute_normalized_magnetic_divergence()
  • plot_quantities_1d()
  • plot_split_view_1d()
  • plot_quantity_2d()
  • plot_quantity_3d()
  • plot_quantities_over_x()
  • plot_integrated_quantities_over_time()
  • extract_slices_from_3d()
• PlotPropertiesAthena
  • PlotPropertiesAthena
• athena module
  • load_solution()
  • compute_magnetic_divergence()
• PlotPropertiesSatanic
  • PlotPropertiesSatanic
• satanic module
  • load_solution()
  • to_numpy()
  • convert_mu_to_theta()
  • plot_f_2d()
  • plot_f_3d()
  • plot_f_over_r()
  • plot_f_over_p()
  • plot_f_over_mu()
  • slice_plane_r_p()
  • slice_plane_r_mu()
  • matplot_f_over_r()
  • matplot_f_over_p()
  • matplot_f_over_mu()
  • matplot_f_r_p()
  • matplot_f_r_mu()