.. _ref_getting_started:

===============
Getting started
===============

This section describes PyDPF-Post and how to install it in user mode so that you can
quickly begin using it. For information on installing PyDPF-Post in development mode,
see :ref:`contributing`.

.. grid:: 1 2 2 2

   .. grid-item-card:: PyDPF-Post Key features :material-regular:`description`
      :padding: 2 2 2 2
      :link: key_features
      :link-type: doc

      Understand the key features of PyDPF-Post.

   .. grid-item-card:: PyDPF library compatibilities :material-regular:`apps`
      :padding: 2 2 2 2
      :link: compatibility
      :link-type: doc

      View version compatibilities of PyDPF-Core and PyPDF-Post for each
      DPF server version.

   .. grid-item-card:: Software requirements :material-regular:`dvr`
      :padding: 2 2 2 2
      :link: software_requirements
      :link-type: doc

      View PyDPF-Post software requirements.

   .. grid-item-card:: Installation :material-regular:`build`
      :padding: 2 2 2 2
      :link: install
      :link-type: doc

      Install PyDPF-Post.

   .. grid-item-card:: Brief demo :material-regular:`code`
      :padding: 2 2 2 2
      :link: demo
      :link-type: doc

      See a brief demo of how to load a result file to extract and postprocess results.


.. toctree::
   :maxdepth: 3
   :hidden:

   key_features
   compatibility
   software_requirements
   install
   demo