.. analysator documentation master file, created by
   sphinx-quickstart on Tue Oct 29 10:43:26 2024.
   You can adapt this file completely to your liking, but it should at least
   contain the root `toctree` directive.

analysator documentation
========================

.. .. image:: logo_color.png
..    :height: 37
..    :width: 300
..    :scale: 75
..    :align: right
..    :alt: Vlasiator Logo

`Analysator <https://github.com/fmihpc/analysator>`_ is a set of Python tools and scripts used to read and analyze `Vlasiator <https://github.com/fmihpc/vlasiator>`_ output files (`VLSV <https://github.com/fmihpc/vlsv>`_). Vlasiator and its related tools are developed at `University of Helsinki <https://www.helsinki.fi/en/researchgroups/vlasiator>`_, 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 <https://www.sphinx-doc.org/en/master/usage/restructuredtext/index.html>`_
documentation for details.

.. toctree::
   :maxdepth: 2
   :caption: Contents:

   plot
   calculations
   vlsvfile
   miscellaneous
   scripts
   about

.. automodule:: analysator 
   :members:
   :imported-members:
   :undoc-members: