Installation
============

Download
--------

Download ``omdpb`` `here <https://gitlab.inf.unibz.it/earth_observation_public/OpenData>`_
or alternatively use ``git`` from terminal:

.. code-block:: bash

   git clone https://gitlab.inf.unibz.it/earth_observation_public/OpenData

This creates a copy of the repository in your current directory on the file
system. To install ``omdpb``, open a terminal and **in the projects root directory**
type:

.. code-block:: bash

   pip install -e .

Import
------

Once installed, you can import the package in a python environment using

.. code-block:: python
   
   import omdpb

Since the functions to access the Api are in the ``open_meteo_data.py``
module, I recommend to import the package as:

.. code-block:: python
   
   import omdpb.open_meteo_data as omd

To check out the functions in ``omd`` use:

.. code-block:: python

   dir(omd)

This gives you a list of functions that can be accessed by calling:

.. code-block:: python

   omd.<function_name>
   
To quickly check what a specific function does, use:

.. code-block:: python

   print(omd.<function_name>.__doc__)