Skip to content

Commit

Permalink
Write doc as rest rather than notebook
Browse files Browse the repository at this point in the history
  • Loading branch information
amarandon committed Dec 9, 2024
1 parent 618806f commit 53c7d26
Show file tree
Hide file tree
Showing 3 changed files with 28 additions and 68 deletions.
27 changes: 27 additions & 0 deletions docs/add_product_type.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,27 @@
.. _add_product_type:

How to add a new product type to EODag?
=======================================


To add a new product type to EODag, you need to add an entry to the file `eodag/resources/product_types.yml`. Here is an example:

.. code-block::
CBERS4_AWFI_L2:
abstract: |
China-Brazil Earth Resources Satellite, CBERS-4 AWFI camera Level-2 product. System corrected images, expect some
translation error.
instrument: AWFI
platform: CBERS
platformSerialIdentifier: CBERS-4
processingLevel: L2
keywords: AWFI,CBERS,CBERS-4,L2
sensorType: OPTICAL
license: proprietary
missionStartDate: "2014-12-07T00:00:00Z"
title: CBERS-4 AWFI Level-2
The first line `CBERS4_AWFI_L2:` is a YAML key corresponding to the name by which the product will be referred to within EODag. Note the use of uppercase and underscores to separate words. This name will be used when searching for products of the corresponging type.

The following lines need to be indented because they make a dictionnary of configuration information for the product type we are defining. Each bit of information can usually be found on the provider's catalogue. Note that the value used for `keywords` entry puts together values from other entries such as `instrument`, `processingLevel`, `platform`, etc.
1 change: 1 addition & 0 deletions docs/index.rst
Original file line number Diff line number Diff line change
Expand Up @@ -130,6 +130,7 @@ Site contents
:caption: For Developers/Contributors

add_provider
add_product_type
plugins
params_mapping
contribute
Expand Down
68 changes: 0 additions & 68 deletions docs/notebooks/tutos/How to add a product type.ipynb

This file was deleted.

0 comments on commit 53c7d26

Please sign in to comment.