Skip to content
Snippets Groups Projects
Commit 50d9d8c9 authored by TGermain's avatar TGermain
Browse files

new docstrings

parent 2934be99
No related branches found
No related tags found
No related merge requests found
Pipeline #1917 failed
......@@ -3,12 +3,12 @@ EODAG
| `EODAG <https://eodag.readthedocs.io/en/stable/>`_ is a command-line tool and a Python package for searching and downloading remotely sensed images while offering a unified API for data access regardless of the data provider.
| As of June 2023, Sen2chain only supports EODAG v2.8.0. A specific plugin was released for the Scihub provider. Both packages can be installed with pip.
| As of June 2023, Sen2chain only supports EODAG v2.10.0. A specific plugin was released for the Scihub provider. Both packages can be installed with pip.
.. code-block:: bash
python -m pip install eodag==2.8.0
python -m pip install eodag==2.10.0
python3 -m pip install eodag-sentinelsat
Then, import eodag in a python console to initialize the package :
......
# Setting up recurrent routines : Jobs
Sen2Chain uses jobs to execute whole processing operations (downloading L1C, computing L2A with Sen2Cor, masking clouds, and producing indices).
Jobs config files are stored in your \~/sen2chain_data/config/jobs/.
There is two kind of files for each job :
- job_jid.cfg
- job_jid.py
With _jid_ the job identifier, can be any character chain.
```python
>>> from sen2chain import Jobs, Job
```
## Jobs
The _Jobs_ class is used to list all jobs present for your user.
```python
>>> Jobs()
job_id config_file python_script logging timing cron_status cron_timing
0 0123456789 True True False 0 5 * * * absent None
1 335 True True False 10 10 * * * absent None
2 012 True False False * * * * * absent None
3 013 True False False * * * * * absent None
```
Jobs can be removed using the _remove_ function and their _job_id_ identifier
```python
>>> Jobs().remove("335")
10094:2022-03-17 17:03:35:INFO:sen2chain.jobs:Removing Python script...
10094:2022-03-17 17:03:35:INFO:sen2chain.jobs:Removing config file...
```
## Job
to be filled
......@@ -16,10 +16,6 @@ Indices
sen2chain.indices.NBR
sen2chain.indices.EVI
.. math::
NDWI(McFeeters) = {{GREEN-NIR}\over{GREEN+NIR}}
=================================================
......
0% Loading or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment