From 4ec5da9f6853a48c14a6435a79e870de3b406ff8 Mon Sep 17 00:00:00 2001
From: Rufai Omowunmi Balogun <rbalogun@eurac.edu>
Date: Thu, 26 Oct 2023 19:34:39 +0200
Subject: [PATCH] update installation guide
---
docs/source/guide/downloader.rst | 4 ++--
docs/source/guide/installation.rst | 36 +++++++++++++++++++++++++++++-
2 files changed, 37 insertions(+), 3 deletions(-)
diff --git a/docs/source/guide/downloader.rst b/docs/source/guide/downloader.rst
index 8044c32..f437007 100644
--- a/docs/source/guide/downloader.rst
+++ b/docs/source/guide/downloader.rst
@@ -22,7 +22,7 @@ Next to this, create a configuration file (JSON file) that contains all the data
the data you would like to request, example:
.. code-block:: json-object
-
+
{
"product_type": "reanalysis",
"variable": [
@@ -44,7 +44,7 @@ the data you would like to request, example:
This JSON file in general should contain the information on your **Area of Interest** and other
specific information on the datasets you would like to download.
-Step Two:
+Step Two
---------
Specify the time range (start date and end date) and download your data to the specified path:
diff --git a/docs/source/guide/installation.rst b/docs/source/guide/installation.rst
index 14b533e..852db97 100644
--- a/docs/source/guide/installation.rst
+++ b/docs/source/guide/installation.rst
@@ -1,2 +1,36 @@
+.. _install:
+
Installation
-------------
+============
+The smodex package is distributed via the Python Package Index and also available on the
+[development repo](https://gitlab.inf.unibz.it/earth_observation_public/smodex). To enable
+the full functionalities, install also the `cdsapi`
+
+
+Option 1: Use Pip (Recommended)
+-------------------------------
+The easiest way is to use pip, which contains the latest release of the package.
+Install pip in your development environment, if you do not have pip installed yet,
+if you do not have pip installed yet.
+
+
+.. code-block:: bash
+
+ pip install smodex
+
+
+Option 2: Clone the repository
+------------------------------
+The latest development version of the smode package is available on the
+[GitLab repo](https://gitlab.inf.unibz.it/earth_observation_public/smodex).
+
+
+.. caution::
+ The version on the repo is not guaranteed to be stable, but in
+ general contains new features that are yet to be released
+
+.. code-block:: bash
+
+ git clone https://gitlab.inf.unibz.it/earth_observation_public/smodex
+ cd smodex
+ python setup.py install
--
GitLab