diff --git a/docs/source/getting_started/configuration.rst b/docs/source/getting_started/configuration.rst index 4c857643fcc742e79769e3d3bb142c5096fa27e4..7e7243d79c43354b394fe1c452430fd656a2f10a 100644 --- a/docs/source/getting_started/configuration.rst +++ b/docs/source/getting_started/configuration.rst @@ -38,7 +38,7 @@ Update Sen2Chain cd sen2chain git pull - pip3 install --user -e . + pip3 install -e . Sen2Chain Configuration diff --git a/docs/source/getting_started/eodag.rst b/docs/source/getting_started/eodag.rst index 3713bb573819bc9e2ed8cb3e7f475513d6ba9d90..b5c4b897ac482292f9b41536af57a21e756324e0 100644 --- a/docs/source/getting_started/eodag.rst +++ b/docs/source/getting_started/eodag.rst @@ -8,8 +8,7 @@ EODAG .. code-block:: bash - python -m pip install eodag==2.10.0 - python3 -m pip install eodag-sentinelsat + python -m pip install eodag Then, import eodag in a python console to initialize the package : @@ -23,7 +22,7 @@ Then, import eodag in a python console to initialize the package : Hubs logins & EODAG configuration file ======================================= -`Register <https://eodag.readthedocs.io/en/stable/getting_started_guide/register.html>`_ to PEPS, Scihub or any provider you deem relevant for your work, and get the required credentials (username/password). +`Register <https://eodag.readthedocs.io/en/stable/getting_started_guide/register.html>`_ to PEPS, cop_data_space or any provider you deem relevant for your work, and get the required credentials (username/password). | Follow the guidelines provided in `EODAG's documentation <https://eodag.readthedocs.io/en/stable/getting_started_guide/configure.html>`_ to configure the plugin. | You can create a dedicated configuration file or edit the default one in: @@ -35,7 +34,7 @@ Hubs logins & EODAG configuration file .. code-block:: bash - scihub: + PEPS : priority: 1 # Highest number for your preferred provider, see more in eodag documentation api: credentials: diff --git a/docs/source/getting_started/index.rst b/docs/source/getting_started/index.rst index b62b1a5a768c5be52b4ce599bd650d5f97577065..1b70c81351ce15f88ffd8c846688bef53b937bee 100644 --- a/docs/source/getting_started/index.rst +++ b/docs/source/getting_started/index.rst @@ -10,6 +10,7 @@ Why sen2chain, how to install, configure it, go! :caption: Contents: my_install + venv_python eodag sen2cor configuration diff --git a/docs/source/getting_started/my_install.rst b/docs/source/getting_started/my_install.rst index 4f81fe3783dcd1c595362801e13dd18818999a77..d0f6af21c691f8523d98c321deb106523d726aeb 100644 --- a/docs/source/getting_started/my_install.rst +++ b/docs/source/getting_started/my_install.rst @@ -24,25 +24,25 @@ Git Sen2cor 2.11 ---------------- -1. Download Sen2Cor v2.11.00 +1. Download Sen2Cor v2.12.03 .. code-block:: bash - wget https://step.esa.int/thirdparties/sen2cor/2.11.0/Sen2Cor-02.11.00-Linux64.run + wget https://step.esa.int/thirdparties/sen2cor/2.12.03/Sen2Cor-02.12.03-Linux64.run 2. Make it executable .. code-block:: bash - chmod +x Sen2Cor-02.11.00-Linux64.run + chmod +x Sen2Cor-02.12.03-Linux64.run 3. Install Sen2Cor .. code-block:: bash - ./Sen2Cor-02.11.00-Linux64.run + ./Sen2Cor-02.12.03-Linux64.run .. note:: diff --git a/docs/source/getting_started/sen2cor.rst b/docs/source/getting_started/sen2cor.rst index 29e91ad48e6213028e0d45da78e97701db8d7f5e..8ff8a72c1ec27a7e7c91ff7adcdfa3d12e2840e9 100644 --- a/docs/source/getting_started/sen2cor.rst +++ b/docs/source/getting_started/sen2cor.rst @@ -6,21 +6,23 @@ Sen2Cor Configuration .. note:: If you want to process products from 2017 and before, you need to install previous versions of Sen2Cor and follow the guidelines :ref:`here <configure_sen2cor>`. -This section focuses on Sen2Cor 2.11 configuration. +This section focuses on Sen2Cor 2.12 configuration. -1. Move or create symlink to `ESACCI-LC package for SC module <https://earth.esa.int/eogateway/ftp/Sentinel-2/ESACCI-LC-L4-ALL-FOR-SEN2COR-2.10.tar.gz>`_ content to Sen2Cor directory: +1. To configure sen2cor, you must first download the context data used for certain Sentinel-2 pre-processing steps here `ESACCI-LC package for SC module <https://earth.esa.int/eogateway/ftp/Sentinel-2/ESACCI-LC-L4-ALL-FOR-SEN2COR-2.10.tar.gz>`_ + +2. Then, move or create symlink to Sen2Cor directory: .. code-block:: bash - ln -s /path/to/ESACCI-LC-L4-ALL-FOR-SEN2COR-2.10/ESACCI-LC-L4-LCCS-Map-300m-P1Y-2015-v2.0.7.tif /path/to/Sen2Cor-02.11.00-Linux64/lib/python2.7/site-packages/sen2cor/aux_data - ln -s /path/to/ESACCI-LC-L4-WB-Map-150m-P13Y-2000-v4.0.tif /path/to/Sen2Cor-02.11.00-Linux64/lib/python2.7/site-packages/sen2cor/aux_data/ - ln -s /path/to/ESACCI-LC-L4-Snow-Cond-500m-MONTHLY-2000-2012-v2.4 /path/to/Sen2Cor-02.11.00-Linux64/lib/python2.7/site-packages/sen2cor/aux_data/ + ln -s /path/to/ESACCI-LC-L4-ALL-FOR-SEN2COR-2.10/ESACCI-LC-L4-LCCS-Map-300m-P1Y-2015-v2.0.7.tif /path/to/Sen2Cor-02.12.03-Linux64/lib/python2.7/site-packages/sen2cor/aux_data + ln -s /path/to/ESACCI-LC-L4-ALL-FOR-SEN2COR-2.10/ESACCI-LC-L4-WB-Map-150m-P13Y-2000-v4.0.tif /path/to/Sen2Cor-02.12.03-Linux64/lib/python2.7/site-packages/sen2cor/aux_data/ + ln -s /path/to/ESACCI-LC-L4-ALL-FOR-SEN2COR-2.10/ESACCI-LC-L4-Snow-Cond-500m-MONTHLY-2000-2012-v2.4 /path/to/Sen2Cor-02.12.03-Linux64/lib/python2.7/site-packages/sen2cor/aux_data/ 2. Create or symlink DEM directory .. code-block:: bash - ln -s /path/to/dem ~/sen2cor/2.11/dem + ln -s /path/to/dem ~/sen2cor/2.12/dem 3. Update Sen2Cor configuration file ``nano ~/sen2cor/2.11/cfg/L2A_GIPP.xml`` @@ -34,7 +36,7 @@ This section focuses on Sen2Cor 2.11 configuration. .. code-block:: bash - sen2cor_bashrc_paths = /path/to/Sen2Cor-02.11.01-Linux64/L2A_Bashrc + sen2cor_bashrc_paths = /path/to/Sen2Cor-02.12.03-Linux64/L2A_Bashrc 5. Then update Sen2Chain by using any method : diff --git a/docs/source/getting_started/venv_python.rst b/docs/source/getting_started/venv_python.rst new file mode 100644 index 0000000000000000000000000000000000000000..5bc8eb7287a2560ec6e10f2730a1fb995ded2b06 --- /dev/null +++ b/docs/source/getting_started/venv_python.rst @@ -0,0 +1,33 @@ +Setting up the virtual environement +====== + +| It's best to use virtualization to install Sen2Chain properly. There are different virtual environments for Python. Here we present the procedure for venv. + +| First you need to install venv Python : + +.. code-block:: bash + + sudo apt install python-3-venv + +| Then, create your venv workspace where Sen2Chain will be installed : + +.. code-block:: bash + + python3 -m venv --system-site-package ~/.venv_sen2chain + +| The --system-site-package is important because it allows you to retrieve glbally installed packages such as GDAL. The command will create a folder containing the Python packages for this virtual machine. + +| Next, activate the new environment (the basic name of the start prompt will change): + +.. code-block:: bash + + source ~/.venv_sen2chain/bin/activate + +| This virtual environment can then be deactivated as follows + +.. code-block:: bash + + deactivate + +| Once the environment has been activated, the following python packages can be installed. + diff --git a/docs/source/going_further/Jobs.rst b/docs/source/going_further/Jobs.rst index 92c66c18bbedb0abe081467d2cbdb09a812882c9..3dbbbe1599918866e3b10223ed99868fdff1bad6 100644 --- a/docs/source/going_further/Jobs.rst +++ b/docs/source/going_further/Jobs.rst @@ -77,8 +77,8 @@ This command creates a configuration file in ``~/sen2chain_data/config/jobs/`` : clean_before = True clean_after = True - tile;date_min;date_max;max_clouds;l1c;l2a;cloudmasks;indices;remove;comments - 40KCB;;today;80;True;True;CM004-CSH1-CMP1-CHP1-TCI1-ITER1;NDVI/NDWIGAO/MNDWI/NDRE/IRECI/BIGR/BIRNIR/BIBG/EVI/NBR;l1c/l2a; + tile;date_min;date_max;max_clouds;provider;download;compute_l2a;cloudmasks;indices;remove;comments + 40KCB;;today;80;peps,L1C;True;CM004-CSH1-CMP1-CHP1-TCI1-ITER1;NDVI/NDWIGAO/MNDWI/NDRE/IRECI/BIGR/BIRNIR/BIBG/EVI/NBR;l1c/l2a;Reunion The configuration file first section is a list of global parameters for the job execution : @@ -97,12 +97,15 @@ The second section of the configuration file is a list of tasks that will be pro - **date_min**: Start date for this task, possible values: empty (2015-01-01 will be used) | any date | today-xx (xx nb of days before today to consider) - **date_max**: Last date for this task, possible values: empty (9999-12-31 will be used) | any date | today - **max_clouds**: Max cloud cover to consider for downloading images -- **l1c**: Download l1c: True|False -- **l2a**: Compute L2A with sen2chain: True | False -- **cloudmasks**: Cloudmask(s) to compute and mask indice(s). Possible values range from none (False) to multiple cloudmasks: False | CM001/CM002/CM003-PRB1-ITER5/CM004-CSH1-CMP1-CHP1-TCI1-ITER0/etc. -- **indices**: False | All | NDVI/NDWIGAO/etc. -- **remove**: Remove downloaded L1C and/or produced L2A when task is done, possible values: False | l1c | l2a | l1c/l2a -- **comments**: free user comments, ie tile name, etc. +- **provider: the provider where to get the data (l1c/l2a), possible values: empty (peps will be used) | peps | cop_dataspace +- **pb_min the minimum processing baseline for this task, possible values: empty (0 will be used) | any positive float number +- **pb_max the maximum processing baseline for this task, possible values: empty (98 will be used) | any positive float number +- **download: product type to download: l1c|l2a|False +- **compute_l2a: computing l2a using sen2chain / sen2cor: True | False +- **cloudmasks: the cloudmask(s) to compute and use to mask indice(s). Possible values range from none (False) to multiple cloudmasks: empty or False | CM001/CM002/CM003-PRB1-ITER5/CM004-CSH1-CMP1-CHP1-TCI1-ITER0/etc. +- **indices: empty or False | All | NDVI/NDWIGAO/etc. +- **remove: used to remove L1C and L2A products, considering only new products (-new) (dowloaded or produced) or the whole time serie (-all) and with possible filtering to remove products above specified cloud couver (-ccXX), example of possible values: empty or False | l1c-new-cc80 | l1c-all | l2a-new | l1c-all/l2a-new-cc25 +- **comments: free user comments, ie tile name, etc. Configure Job ---------------