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.

Introduction

• Introduction to Analysator
• Analysator exercises
• Analysator supported data reducers and vlasiator variables

Analysator reference

• plot
  • plot_colormap()
  • plot_colormap3dslice()
  • plot_ionosphere()
  • plot_isosurface()
  • plot_neutral_sheet()
  • plot_threeslice()
  • plot_variables()
  • plot_vdf()
  • plot_vdf_profiles()
  • plot_vdfdiff()
• calculations
  • cut3d()
  • fourier()
  • lineout()
• vlsvfile
• miscellaneous
• scripts
  • biot_savart
  • cutthrough_timeseries
  • gics
  • magnetopause2d
  • magnetopause3d
  • obliqueshock
  • obliqueshock_nif
  • shue
  • tsyganenko

analysator.lazyimport(module_name)

analysator.register_colormaps()

Register included colormaps to matplotlib. Required if you are relying on colormaps included in analysator and you are not using analysator.plot functions.

About

• Credits