.. _getting_started:

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

In this section, we will guide you through the installation of **gempy-drivers** and it's dependencies inside a
conda environment.

.. contents::

.. toctree::
   :maxdepth: 2

Installation
------------

Install Conda
~~~~~~~~~~~~~

Install Conda for Python 3.10 or higher. Follow this link to download its Windows installer (~140 MB of disk space):

`Miniforge <https://github.com/conda-forge/miniforge/releases/latest/download/Miniforge3-Windows-x86_64.exe>`_

.. figure:: /images/getting_started/Miniforge3_Setup-1.png
    :align: center
    :width: 200

.. figure:: /images/getting_started/Miniforge3_Setup-3.png
    :align: center
    :width: 200

Registering the Conda distribution as the default Python 3.10 interpreter is optional.
Preferably uncheck that box if you already have Python 3 installed on your system.

.. note:: We recommend installing **Miniforge**: beyond being smaller,
    it also installs packages from the conda-forge repository by default,
    which has no restriction for commercial use, while both Miniconda and Anaconda distributions use
    the Anaconda repository by default: see `Anaconda Terms of Service <https://www.anaconda.com/terms-of-service>`_ for details.
    In any case, the installation of **gempy-driversa** forces the usage of the conda-forge repository,
    and is thus not affected by the Anaconda Terms of Service.

Install **gempy-drivers**
~~~~~~~~~~~~~~~~~~~~~~~~~

To install the **gempy-drivers** package and its dependencies, simply run the **install.bat**
script included in the package.

.. figure:: /images/getting_started/install.png
    :align: center
    :width: 300

To learn more about running from ui.json file, proceed to the :ref:`usage` section.