Welcome to the TorX Wiki
========================

TorX is a Python post-processing framework for codes built on
`PARALLAX <https://gitlab.mpcdf.mpg.de/phoenix-public/parallax>`_.
It contains tools including field-line tracing, Fourier analysis, radial
profiles, determining quantities on arbitrary lineouts, and much more.

This wiki has pages to help you get started using TorX. This includes a
description of the components of TorX, how to install TorX and looking at
the example Jupyter notebooks as a starting point.

.. toctree::
   :maxdepth: 1
   :hidden:

   User guide <pages/users/index>
   Developer guide <pages/developers/index>
   API reference <api>

.. grid:: 3
   :gutter: 1

   .. grid-item-card::
      :text-align: center

      .. raw:: html

         <i class="fas fa-user fa-4x"></i>

      User guide
      ^^^^^^^^^^

      Getting started as a user.

      +++

      .. button-ref:: pages/users/index
         :expand:
         :color: primary
         :click-parent:

         Go to user guide

   .. grid-item-card::
      :text-align: center

      .. raw:: html

         <i class="fas fa-code fa-4x"></i>

      Developer guide
      ^^^^^^^^^^^^^^^

      Getting started as a developer.

      +++

      .. button-ref:: pages/developers/index
         :expand:
         :color: secondary
         :click-parent:

         Go to developer guide

   .. grid-item-card::
      :text-align: center

      .. raw:: html

         <i class="fas fa-cogs fa-4x"></i>

      API Reference
      ^^^^^^^^^^^^^

      Reference of all packages, modules, classes and functions.

      +++

      .. button-ref:: api
         :expand:
         :color: info
         :click-parent:

         Go to API reference