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

Program Installation
====================

Installation on PyCharm
------------------------

1. Install `PyCharm <https://www.jetbrains.com/fr-fr/pycharm/)>`_
2. Create a new project with the "Get from Version Control" option: enter the GitHub URL of the
   project (https://gitlab.osureunion.fr/payen/dial-lidar-ozone-retrieval-for-actris.git)
3. Install Git on PyCharm if necessary
4. Clone the program
5. Install the necessary packages (either through the graphical interface or by typing the command `pip install -r
   requierement.txt` )
6. Set the main folder as the main source. To do this, right-click on the folder "
   dial-lidar-ozone-retrieval-for-actris", go to "Mark Directory as", then "Source Root"

Installation on Linux (without IDE)
------------------------------------

Installation performed on Ubuntu 22.

1. Install `Python 3.10 <https://computingforgeeks.com/how-to-install-python-on-ubuntu-linux-system/>`_ and its
   dependencies:
    1. `sudo apt install python3.10`
    2. Install pip: `sudo apt install pip`
    3. Install venv: `sudo apt install python3.10-venv`
2. Download the DIAL software
    1. Install git: `sudo apt install git`
    2. Clone the git repository: `git clone https://gitlab.osureunion.fr/payen/dial-lidar-ozone-retrieval-for-actris.git`
3. Use a virtual environment:
    1. Create the virtual environment: `python3.10 -m venv /path/to/new/virtual/environment`
    2. Activate the virtual environment: `source venv/bin/activate`
4. Install the necessary packages: `pip install -r requirements.txt`
5. Set the main folder as the main source. To do this, type: `export PYTHONPATH=$PYTHONPATH:path_of_the_project`

In the case of installation on a server where you are only a user, you can use
the following command to install packages: `python -m pip install --user <package_name>`.