Getting Started
===============

Use this section to install Hyrax, run a first end-to-end example, and then
explore astronomy-focused example notebooks. If you are new to Hyrax, read the
following pages in order.

.. grid:: 1 1 2 2

   .. grid-item-card:: Installation
      :link: getting_started_installation
      :link-type: doc

      Download and set up Hyrax

   .. grid-item-card:: Hyrax Hello World
      :link: getting_started_hello_world
      :link-type: doc

      Train a first model and walk through the core Hyrax workflow.


.. grid:: 1 1 2 2

   .. grid-item-card:: Astronomy Unsupervised
      :link: pre_executed/unsupervised_image_extragalactic
      :link-type: doc

      Apply the workflow to an unsupervised ML example using HSC images.

   .. grid-item-card:: Astronomy Supervised
      :link: pre_executed/supervised_lightcurve_transients_gs
      :link-type: doc

      Follow along a supervised ML light-curve classification example.

.. tip::

   Installation and Hyrax Hello World are the core onboarding path.
   The astronomy pages are follow-on examples that apply the same workflow in
   domain-specific settings. If you prefer learning through end-to-end examples,
   continue with :doc:`Science Examples <science_examples>` after these pages.

.. toctree::
   :hidden:

   Installation <getting_started_installation>
   Hyrax Hello World <getting_started_hello_world>
   Astronomy Unsupervised <pre_executed/unsupervised_image_extragalactic>
   Astronomy Supervised <pre_executed/supervised_lightcurve_transients_gs>