.. _getting_started:

Getting started
=================

A guide to enable you to start productively using ValEnsPy as efficiently as possible.

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

.. warning::
    ValEnsPy has ESMF as a non-python dependency. 
    
    To install ValEnsPy on Windows see the :ref:`advanced installation page <advanced_install>`.

    When installing ValEnsPy with pip, ensure that ESMF (esmpy) is already installed.

.. grid:: 1 2 2 2
    :gutter: 4

    .. grid-item-card:: Working with conda?
        :class-card: install-card
        :columns: 12 12 6 6
        :padding: 3

        Using Conda

        ++++++++++++++++++++++

        .. code-block:: bash

            #conda install command for non developers
            #WIP

    .. grid-item-card:: Prefer pip?
        :class-card: install-card
        :columns: 12 12 6 6
        :padding: 3

        Using pip

        ++++

        .. code-block:: bash

            #conda install -c conda-forge esmpy
            pip install valenspy

    .. grid-item-card:: In-depth instructions?
        :class-card: install-card
        :columns: 12
        :padding: 3

        Installing on Windows? Installing from source or with pip? Check the advanced
        installation page.

        +++

        .. button-ref:: advanced_install
            :ref-type: ref
            :click-parent:
            :color: secondary
            :expand:

            Advanced installation


Why ValEnsPy?
-------------

WIP - 2 sentence description of the package and its purpose.

Still not convinced? Check out the :ref:`Why ValEnsPy <why_ValEnsPy>` page.

What do I need to get started?
------------------------------

WIP - 3 sentences about knowledge needed to get started with ValEnsPy (xarray!)

Got what it takes? Check out the :ref:`quick overview <quick-overview>` page to learn the key concepts of ValEnsPy or check out the :ref:`examples <examples_index>`.

.. Add a list of examples here similar to pandas.


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

   Getting started <self>
   why_ValEnsPy
   advanced_install
   quick-overview
   faq