=================
User Guides
=================

Installation and Starting
=========================
.. grid:: 2 2 3 3
    :gutter: 1
    :padding: 1

    .. grid-item-card:: Installation
        :link: installation
        :link-type: doc
        :shadow: md
        :text-align: center

        How to get ``weitsicht``

    .. grid-item-card:: Quickstart
        :link: quickstart
        :link-type: doc
        :shadow: md
        :text-align: center

        End-to-end in 2 minutes

Important Notes
================
These concepts help avoid common mistakes when working with geo-referenced imagery in ``weitsicht``.

.. grid:: 2 2 3 3
    :gutter: 1
    :padding: 1

    .. grid-item-card:: Top-Tips
        :link: top_tips
        :link-type: doc
        :shadow: md
        :text-align: center

        ``weitsicht`` best tips for everyone

    .. grid-item-card:: Coordinate Reference System
        :link: use_coordinate_systems
        :link-type: doc
        :shadow: md
        :text-align: center

        How to use coordinate systems

Data Concepts and Handling
==================================

.. grid:: 2 2 3 3
    :gutter: 1
    :padding: 1

    .. grid-item-card:: Images Guide
        :link: images_guide
        :link-type: doc
        :shadow: md
        :text-align: center

        How images are used in weitsicht

    .. grid-item-card:: Rotation / Pose
        :link: rotation
        :link-type: doc
        :shadow: md
        :text-align: center

        OPK and AZK/APK angles

    .. grid-item-card:: Projection & Mapping
        :link: images_projection_mapping
        :link-type: doc
        :shadow: md
        :text-align: center

        Standard functions in weitsicht

    .. grid-item-card:: Results & Issues
        :link: results_prj_mapping
        :link-type: doc
        :shadow: md
        :text-align: center

        Return types and warnings

    .. grid-item-card:: Error handling
        :link: error_handling
        :link-type: doc
        :shadow: md
        :text-align: center

        Exceptions vs. result failures

    .. grid-item-card:: Type Guards
        :link: type_guards
        :link-type: doc
        :shadow: md
        :text-align: center

        Helpers for type narrowing

    .. grid-item-card:: Metadata
        :link: metadata
        :link-type: doc
        :shadow: md
        :text-align: center

        IOR/EOR/image

    .. grid-item-card:: Camera and Distortion
        :link: cameras_distortion
        :link-type: doc
        :shadow: md
        :text-align: center

        Cameras class & distortion borders

    .. grid-item-card:: Mappers
        :link: mappers
        :link-type: doc
        :shadow: md
        :text-align: center

        ray intersections

    .. grid-item-card:: Batching images
        :link: batching_images
        :link-type: doc
        :shadow: md
        :text-align: center

        Multi image handling

    .. grid-item-card:: Troubleshooting
        :link: troubleshooting
        :link-type: doc
        :shadow: md
        :text-align: center

        Common issues and debugging tips


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

   installation
   quickstart
   top_tips
   use_coordinate_systems
   images_guide
   rotation
   images_projection_mapping
   results_prj_mapping
   error_handling
   type_guards
   metadata
   cameras_distortion
   mappers
   batching_images
   troubleshooting