.. _getting-started-index:

Getting started
###############

.. grid:: 2
  :gutter: 4

  .. grid-item-card:: :material-outlined:`build;2em`
    :link-type: doc
    :link: /getting_started/prerequisites

    .. raw:: html

      <span style="font-size: 1.5em; color:#5a2a82;">Prerequisites</span>

    Check that you have the knowledge, software, and design prerequisites that
    you need for running VISOR.

  .. grid-item-card:: :material-outlined:`file_download;2em`
    :link-type: doc
    :link: /getting_started/installation

    .. raw:: html

      <span style="font-size: 1.5em; color:#5a2a82;">Installation</span>

    Install the VISOR package.

  .. grid-item-card:: :material-outlined:`rocket_launch;2em`
    :link-type: doc
    :link: /getting_started/quick_start

    .. raw:: html

      <span style="font-size: 1.5em; color:#5a2a82;">Quick start</span>

    Use the Python API to quickly launch VISOR and load a VTM or VTK input file.

  .. grid-item-card:: :material-outlined:`warning;2em`
    :link-type: doc
    :link: /getting_started/known_limitations

    .. raw:: html

      <span style="font-size: 1.5em; color:#5a2a82;">Known limitations</span>

    See known limitations of the VISOR release.


  .. grid-item-card:: :material-outlined:`settings;2em`
    :link-type: doc
    :link: /getting_started/configure_visor

    .. raw:: html

      <span style="font-size: 1.5em; color:#5a2a82;">VISOR configuration</span>

    Override default VISOR settings using a project-level YAML file.


.. toctree::
   :hidden:
   :maxdepth: 2

   prerequisites
   installation
   quick_start
   known_limitations
   configure_visor