analysator documentation

Analysator is a set of Python tools and scripts used to read and analyze Vlasiator output files (VLSV). Vlasiator and its related tools are developed at University of Helsinki, and are open source.

This documentation is generated via Sphinx-autodoc from Analysator source. This page is a work in progress, with docstrings and the documentation layout in flux. Contributions via Analysator repo are welcome.

Add your content using reStructuredText syntax. See the reStructuredText documentation for details.

Contents:

• plot
  • plot_colormap()
  • plot_colormap3dslice()
  • plot_ionosphere()
  • plot_isosurface()
  • plot_multiple_variables()
  • plot_neutral_sheet()
  • plot_threeslice()
  • plot_variables()
  • plot_vdf()
  • plot_vdf_profiles()
  • plot_vdfdiff()
• calculations
  • AMRInterpolator
  • LMN_null_lines_FOTE()
  • VariableInfo
  • cell_time_evolution()
  • cut3d()
  • cut_through()
  • cut_through_curve()
  • cut_through_step()
  • dynamic_field_tracer()
  • epsilon_M()
  • fourier()
  • gyrophase_angles_from_file()
  • lineout()
  • pitch_angles()
  • point_time_evolution()
  • static_field_tracer()
  • static_field_tracer_3d()
  • themis_observation_from_file()
  • themis_plot_detector()
  • themis_plot_phasespace_contour()
  • themis_plot_phasespace_helistyle()
  • vlsv_intpol_file()
  • vlsv_intpol_points()
• vlsvfile
  • VlasiatorReader
  • VlsvParticles
  • VlsvReader
  • VlsvVtkReader
  • VlsvWriter
• miscellaneous
  • get_sorted_file_names()
  • oblique_shock()
  • plot_rankine()
  • write_vtk_file()
• scripts
  • biot_savart
  • gics
  • magnetopause2d
  • magnetopause3d
  • obliqueshock
  • obliqueshock_nif
  • shue
  • tsyganenko
• Credits