.. title:: User Guide

.. image:: _static/banners/ug_light.jpg
   :align: center

--------------------

.. toctree::
   :maxdepth: 0
   :hidden:
   :caption: User Guide

   user_guide/installation
   user_guide/tutorials

.. toctree::
   :maxdepth: 0
   :hidden:
   :caption: Contributions

   user_guide/contributions/contribute
   user_guide/contributions/report_a_bug

.. toctree::
   :maxdepth: 0
   :hidden:
   :caption: Get help!

   user_guide/faq

User Guide
==========

Find everything you need to get started with SeismoViz!


Getting started
---------------

Begin your journey with SeismoViz. This section outlines the initial steps to set up the library, familiarize yourself with its core features, and start working with seismic catalogs. Designed for users of all experience levels, it provides a clear and concise roadmap to quickly unlock the capabilities of SeismoViz.

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

   .. grid-item-card:: :octicon:`download;2.5em;sd-mr-1` Installation
      :link: user_guide/installation
      :link-type: doc
      :link-alt: Installation

      Detailed instructions to set up SeismoViz and integrate it into your Python environment.

   .. grid-item-card:: :octicon:`pencil;2.5em;sd-mr-1` Tutorials
      :link: user_guide/tutorials
      :link-type: doc
      :link-alt: Tutorials

      Step-by-step guides to help you master the library’s features.


Contributions
-------------

SeismoViz is an open-source project that thrives on community contributions. Whether you’re reporting issues, suggesting new features, or contributing code, your involvement is invaluable. 

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

   .. grid-item-card:: :octicon:`terminal;2.5em;sd-mr-1` Contribute
      :link: user_guide/contributions/contribute
      :link-type: doc
      :link-alt: Contribute

      Learn how to contribute to SeismoViz by submitting code, improving documentation, or suggesting new features.

   .. grid-item-card:: :octicon:`bug;2.5em;sd-mr-1` Report a bug or issue
      :link: user_guide/contributions/report_a_bug
      :link-type: doc
      :link-alt: Report a bug/issue

      Encountered a problem? Report bugs or issues to help us improve SeismoViz and ensure a seamless experience for all users.


Get help!
---------

Can’t find what you’re looking for? Check out our FAQ section for more answers and insights to common questions.

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

   .. grid-item-card:: :octicon:`question;2.5em;sd-mr-1` FAQ
      :link: user_guide/faq
      :link-type: doc
      :link-alt: FAQ

      Answers to common questions and solutions to common challenges, ensuring a smooth experience.