Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

feat(core): shared and multiple auth per provider #1292

Merged
merged 15 commits into from
Oct 2, 2024
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
8 changes: 0 additions & 8 deletions docs/_static/product_types_information.csv
Original file line number Diff line number Diff line change
Expand Up @@ -13,14 +13,6 @@ CAMS_GREENHOUSE_INVERSION,"This data set contains net fluxes at the surface, atm
CAMS_GRF,"This dataset provides geographical distributions of the radiative forcing (RF) by key atmospheric constituents. The radiative forcing estimates are based on the CAMS reanalysis and additional model simulations and are provided separately for CO2 CH4, O3 (tropospheric and stratospheric), interactions between anthropogenic aerosols and radiation and interactions between anthropogenic aerosols and clouds. Radiative forcing measures the imbalance in the Earth's energy budget caused by a perturbation of the climate system, such as changes in atmospheric composition caused by human activities. RF is a useful predictor of globally-averaged temperature change, especially when rapid adjustments of atmospheric temperature and moisture profiles are taken into account. RF has therefore become a quantitative metric to compare the potential climate response to different perturbations. Increases in greenhouse gas concentrations over the industrial era exerted a positive RF, causing a gain of energy in the climate system. In contrast, concurrent changes in atmospheric aerosol concentrations are thought to exert a negative RF leading to a loss of energy. Products are quantified both in ""all-sky"" conditions, meaning that the radiative effects of clouds are included in the radiative transfer calculations, and in ""clear-sky"" conditions, which are computed by excluding clouds in the radiative transfer calculations. The upgrade from version 1.5 to 2 consists of an extension of the period by 2017-2018, the addition of an ""effective radiative forcing"" product and new ways to calculate the pre-industrial reference state for aerosols and cloud condensation nuclei. More details are given in the documentation section. New versions may be released in future as scientific methods develop, and existing versions may be extended with later years if data for the period is available from the CAMS reanalysis. Newer versions supercede old versions so it is always recommended to use the latest one. CAMS also produces distributions of aerosol optical depths, distinguishing natural from anthropogenic aerosols, which are a separate dataset. See ""Related Data"". ",CAMS,,CAMS,,"Copernicus,ADS,CAMS,Atmospheric,Atmosphere,RF,CO2,CH4,O3,Aerosol",ATMOSPHERIC,proprietary,CAMS global radiative forcings,2003-01-01T00:00:00Z,CAMS_GRF,,,available,,,,,,available,,,,,,,,,,,,,,,,,available,
CAMS_GRF_AUX,"This dataset provides aerosol optical depths and aerosol-radiation radiative effects for four different aerosol origins: anthropogenic, mineral dust, marine, and land-based fine-mode natural aerosol. The latter mostly consists of biogenic aerosols. The data are a necessary complement to the ""CAMS global radiative forcings"" dataset (see ""Related Data""). The calculation of aerosol radiative forcing requires a discrimination between aerosol of anthropogenic and natural origin. However, the CAMS reanalysis, which is used to provide the aerosol concentrations, does not make this distinction. The anthropogenic fraction was therefore derived by a method which uses aerosol size as a proxy for aerosol origin. ",CAMS,,CAMS,,"Copernicus,ADS,CAMS,Atmospheric,Atmosphere,RF,CO2,CH4,O3,Aerosol",ATMOSPHERIC,proprietary,CAMS global radiative forcing - auxilliary variables,2003-01-01T00:00:00Z,CAMS_GRF_AUX,,,available,,,,,,available,,,,,,,,,,,,,,,,,available,
CAMS_SOLAR_RADIATION,"The CAMS solar radiation services provide historical values (2004 to present) of global (GHI), direct (BHI) and diffuse (DHI) solar irradiation, as well as direct normal irradiation (BNI). The aim is to fulfil the needs of European and national policy development and the requirements of both commercial and public downstream services, e.g. for planning, monitoring, efficiency improvements and the integration of solar energy systems into energy supply grids. For clear-sky conditions, an irradiation time series is provided for any location in the world using information on aerosol, ozone and water vapour from the CAMS global forecasting system. Other properties, such as ground albedo and ground elevation, are also taken into account. Similar time series are available for cloudy (or ""all sky"") conditions but, since the high-resolution cloud information is directly inferred from satellite observations, these are currently only available inside the field-of-view of the Meteosat Second Generation (MSG) satellite, which is roughly Europe, Africa, the Atlantic Ocean and the Middle East. Data is offered in both ASCII and netCDF format. Additionally, an ASCII ""expert mode"" format can be selected which contains in addition to the irradiation, all the input data used in their calculation (aerosol optical properties, water vapour concentration, etc). This additional information is only meaningful in the time frame at which the calculation is performed and so is only available at 1-minute time steps in universal time (UT). ",CAMS,,CAMS,,"Copernicus,ADS,CAMS,Solar,Radiation",ATMOSPHERIC,proprietary,CAMS solar radiation time-series,2004-01-02T00:00:00Z,CAMS_SOLAR_RADIATION,,,available,,,,,,available,,,,,,,,,,,,,,,,,available,
CBERS4_AWFI_L2,"China-Brazil Earth Resources Satellite, CBERS-4 AWFI camera Level-2 product. System corrected images, expect some translation error. ",CBERS,AWFI,CBERS-4,L2,"AWFI,CBERS,CBERS-4,L2",OPTICAL,proprietary,CBERS-4 AWFI Level-2,2014-12-07T00:00:00Z,CBERS4_AWFI_L2,,available,,,,,,,,,,,,,,,,,,,,,,,,,
CBERS4_AWFI_L4,"China-Brazil Earth Resources Satellite, CBERS-4 AWFI camera Level-4 product. Orthorectified with ground control points. ",CBERS,AWFI,CBERS-4,L4,"AWFI,CBERS,CBERS-4,L4",OPTICAL,proprietary,CBERS-4 AWFI Level-4,2014-12-07T00:00:00Z,CBERS4_AWFI_L4,,available,,,,,,,,,,,,,,,,,,,,,,,,,
CBERS4_MUX_L2,"China-Brazil Earth Resources Satellite, CBERS-4 MUX camera Level-2 product. System corrected images, expect some translation error. ",CBERS,MUX,CBERS-4,L2,"MUX,CBERS,CBERS-4,L2",OPTICAL,proprietary,CBERS-4 MUX Level-2,2014-12-07T00:00:00Z,CBERS4_MUX_L2,,available,,,,,,,,,,,,,,,,,,,,,,,,,
CBERS4_MUX_L4,"China-Brazil Earth Resources Satellite, CBERS-4 MUX camera Level-4 product. Orthorectified with ground control points. ",CBERS,MUX,CBERS-4,L4,"MUX,CBERS,CBERS-4,L4",OPTICAL,proprietary,CBERS-4 MUX Level-4,2014-12-07T00:00:00Z,CBERS4_MUX_L4,,available,,,,,,,,,,,,,,,,,,,,,,,,,
CBERS4_PAN10M_L2,"China-Brazil Earth Resources Satellite, CBERS-4 PAN10M camera Level-2 product. System corrected images, expect some translation error. ",CBERS,PAN10M,CBERS-4,L2,"PAN10M,CBERS,CBERS-4,L2",OPTICAL,proprietary,CBERS-4 PAN10M Level-2,2014-12-07T00:00:00Z,CBERS4_PAN10M_L2,,available,,,,,,,,,,,,,,,,,,,,,,,,,
CBERS4_PAN10M_L4,"China-Brazil Earth Resources Satellite, CBERS-4 PAN10M camera Level-4 product. Orthorectified with ground control points. ",CBERS,PAN10M,CBERS-4,L4,"PAN10M,CBERS,CBERS-4,L4",OPTICAL,proprietary,CBERS-4 PAN10M Level-4,2014-12-07T00:00:00Z,CBERS4_PAN10M_L4,,available,,,,,,,,,,,,,,,,,,,,,,,,,
CBERS4_PAN5M_L2,"China-Brazil Earth Resources Satellite, CBERS-4 PAN5M camera Level-2 product. System corrected images, expect some translation error. ",CBERS,PAN5M,CBERS-4,L2,"PAN5M,CBERS,CBERS-4,L2",OPTICAL,proprietary,CBERS-4 PAN5M Level-2,2014-12-07T00:00:00Z,CBERS4_PAN5M_L2,,available,,,,,,,,,,,,,,,,,,,,,,,,,
CBERS4_PAN5M_L4,"China-Brazil Earth Resources Satellite, CBERS-4 PAN5M camera Level-4 product. Orthorectified with ground control points. ",CBERS,PAN5M,CBERS-4,L4,"PAN5M,CBERS,CBERS-4,L4",OPTICAL,proprietary,CBERS-4 PAN5M Level-4,2014-12-07T00:00:00Z,CBERS4_PAN5M_L4,,available,,,,,,,,,,,,,,,,,,,,,,,,,
CLMS_CORINE,"The CORINE Land Cover (CLC) inventory was initiated in 1985 (reference year 1990). Updates have been produced in 2000, 2006, 2012, and 2018. It consists of an inventory of land cover in 44 classes. CLC uses a Minimum Mapping Unit (MMU) of 25 hectares (ha) for areal phenomena and a minimum width of 100 m for linear phenomena. The time series are complemented by change layers, which highlight changes in land cover with an MMU of 5 ha. Different MMUs mean that the change layer has higher resolution than the status layer. Due to differences in MMUs the difference between two status layers will not equal to the corresponding CLC-Changes layer. If you are interested in CLC-Changes between two neighbour surveys always use the CLC-Change layer. ","Sentinel-2, LANDSAT, SPOT-4/5, IRS P6 LISS III",,"S2, L5, L7, L8, SPOT4, SPOT5",,"Land-cover,LCL,CORINE,CLMS",,proprietary,CORINE Land Cover,1986-01-01T00:00:00Z,CLMS_CORINE,,,,,,,,,available,,,,,,,,,,,,,,,,,,available
CLMS_GLO_DMP_333M,"Dry matter Productivity (DMP) is an indication of the overall growth rate or dry biomass increase of the vegetation and is directly related to ecosystem Net Primary Productivity (NPP), however its units (kilograms of gross dry matter per hectare per day) are customized for agro-statistical purposes. Compared to the Gross DMP (GDMP), or its equivalent Gross Primary Productivity, the main difference lies in the inclusion of the autotrophic respiration. Like the FAPAR products that are used as input for the GDMP estimation, these GDMP products are provided in Near Real Time, with consolidations in the next periods, or as offline product. ",Sentinel-3,"OLCI,PROBA-V",,,"Land,Dry-matter-productivity,DMP,OLCI,PROBA-V,Sentinel-3",,proprietary,10-daily Dry Matter Productivity 333M,2014-01-10T00:00:00Z,CLMS_GLO_DMP_333M,,,,,,,,,available,,,,,,,,,,,,,,,,,,available
CLMS_GLO_FAPAR_333M,"The FAPAR quantifies the fraction of the solar radiation absorbed by plants for photosynthesis. It refers only to the green and living elements of the canopy. The FAPAR depends on the canopy structure, vegetation element optical properties, atmospheric conditions and angular configuration. To overcome this latter dependency, a daily integrated FAPAR value is assessed. FAPAR is very useful as input to a number of primary productivity models and is recognized as an Essential Climate Variable (ECV) by the Global Climate Observing System (GCOS). The product at 333m resolution is provided in Near Real Time and consolidated in the next six periods. ",Sentinel-3,"OLCI,PROBA-V",,,"Land,Fraction-of-absorbed-PAR,FAPAR,OLCI,PROBA-V,Sentinel-3",,proprietary,Global 10-daily Fraction of Absorbed PAR 333m,2014-01-10T00:00:00Z,CLMS_GLO_FAPAR_333M,,,,,,,,,available,,,,,,,,,,,,,,,,,,available
Expand Down
7 changes: 7 additions & 0 deletions docs/add_provider.rst
Original file line number Diff line number Diff line change
Expand Up @@ -46,6 +46,13 @@ provide the new provider's configuration in a ``YAML`` format. The following exa
It configures the following existing plugins: :class:`~eodag.plugins.search.qssearch.StacSearch` (search),
:class:`~eodag.plugins.authentication.aws_auth.AwsAuth` (authentication) and :class:`~eodag.plugins.download.aws.AwsDownload` (download).

Each plugin configuration is inserted following the appropriate plugin topic key:

- ``search`` for `search plugins <plugins_reference/search.rst>`_
- ``download`` for `download plugins <plugins_reference/download.rst>`_
- ``auth``, ``search_auth``, or ``download_auth`` for `authentication plugins <plugins_reference/auth.rst>`_
- ``api`` for `api plugins <plugins_reference/api.rst>`_

Of course, it is also necessary to know how to configure these plugins (which parameters they take, what values they can have, etc.).
You can get some inspiration from the *Providers pre-configuration* section by analysing how ``eodag`` configures the providers it comes installed with.

Expand Down
2 changes: 1 addition & 1 deletion docs/getting_started_guide/index.rst
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,7 @@ This getting started aims at introducing you to ``eodag`` and at getting you usi
it efficiently as quickly as possible.

.. toctree::
:maxdepth: 2
:maxdepth: 1

overview
install
Expand Down
43 changes: 20 additions & 23 deletions docs/getting_started_guide/providers.rst
Original file line number Diff line number Diff line change
Expand Up @@ -8,34 +8,31 @@ Description

Products from the following providers are made avaiable through ``eodag``:

* `usgs <https://earthexplorer.usgs.gov/>`_: U.S geological survey catalog for Landsat products
* `theia <https://theia.cnes.fr/atdistrib/rocket/>`_: French National Space Agency (CNES) value-adding products for Land surfaces
* `peps <https://peps.cnes.fr/rocket/#/home>`_: French National Space Agency (CNES) catalog for Sentinel products
* `astraea_eod <https://eod-catalog-svc-prod.astraea.earth/api.html>`_: Astraea Earth OnDemand STAC API
* `aws_eos <https://eos.com/>`_: EOS search for Amazon public datasets
* `cop_ads <https://ads.atmosphere.copernicus.eu>`_: Copernicus Atmosphere Data Store
* `cop_cds <https://cds.climate.copernicus.eu>`_: Copernicus Climate Data Store
* `cop_dataspace <https://dataspace.copernicus.eu/>`_: Copernicus Data Space
* `cop_marine <https://marine.copernicus.eu>`_: Copernicus Marine Service
* `creodias <https://creodias.eu/>`_: CloudFerro DIAS
* `creodias_s3 <https://creodias.eu/>`_: CloudFerro DIAS data through S3 protocol
* `onda <https://www.onda-dias.eu/cms/>`_: Serco DIAS
* `astraea_eod <https://eod-catalog-svc-prod.astraea.earth/api.html>`_: Astraea Earth OnDemand STAC API
* `usgs_satapi_aws <https://landsatlook.usgs.gov/sat-api/>`_: USGS Landsatlook SAT API
* `dedl <https://hda.data.destination-earth.eu/ui>`_: Destination Earth Data Lake (DEDL)
* `dedt_lumi <https://polytope.lumi.apps.dte.destination-earth.eu/openapi>`_: DestinE Digital Twin output on Lumi
* `earth_search and earth_search_cog <https://www.element84.com/earth-search/>`_: Element84 Earth Search
* `earth_search_gcs <https://cloud.google.com/storage/docs/public-datasets>`_: Element84 Earth Search and Google Cloud Storage download
* `earth_search_gcs <https://cloud.google.com/storage/docs/public-datasets>`_: Element84 Earth Search and Google Cloud
Storage download
* `ecmwf <https://www.ecmwf.int/>`_: European Centre for Medium-Range Weather Forecasts
* `cop_ads <https://ads.atmosphere.copernicus.eu>`_: Copernicus Atmosphere Data Store
* `cop_cds <https://cds.climate.copernicus.eu>`_: Copernicus Climate Data Store
* `cop_marine <https://marine.copernicus.eu>`_: Copernicus Marine Service
* `sara <https://copernicus.nci.org.au>`_: Sentinel Australasia Regional Access
* `eumetsat_ds <https://data.eumetsat.int>`_: EUMETSAT Data Store (European Organisation for the Exploitation of Meteorological Satellites)
* `hydroweb_next <https://hydroweb.next.theia-land.fr>`_: hydroweb.next thematic hub for hydrology data access
* `meteoblue <https://content.meteoblue.com/en/business-solutions/weather-apis/dataset-api>`_: Meteoblue forecast
* `cop_dataspace <https://dataspace.copernicus.eu/>`_: Copernicus Data Space
* `onda <https://www.onda-dias.eu/cms/>`_: Serco DIAS
* `peps <https://peps.cnes.fr/rocket/#/home>`_: French National Space Agency (CNES) catalog for Sentinel products
* `planetary_computer <https://planetarycomputer.microsoft.com/>`_: Microsoft Planetary Computer
* `hydroweb_next <https://hydroweb.next.theia-land.fr>`_: hydroweb.next thematic hub for hydrology data access
* `wekeo_main <https://www.wekeo.eu/>`_: WEkEO Copernicus Sentinel, DEM, and CLMS data
* `wekeo_ecmwf <https://www.wekeo.eu/>`_: WEkEO ECMWF data
* `sara <https://copernicus.nci.org.au>`_: Sentinel Australasia Regional Access
* `theia <https://theia.cnes.fr/atdistrib/rocket/>`_: French National Space Agency (CNES) value-adding products for Land
surfaces
* `usgs <https://earthexplorer.usgs.gov/>`_: U.S geological survey catalog for Landsat products
* `usgs_satapi_aws <https://landsatlook.usgs.gov/sat-api/>`_: USGS Landsatlook SAT API
* `wekeo_cmems <https://www.wekeo.eu>`_: Copernicus Marine (CMEMS) data from WEkEO
* `dedt_lumi <https://polytope.lumi.apps.dte.destination-earth.eu/openapi>`_: DestinE Digital Twin output on Lumi
* `dedl <https://hda.data.destination-earth.eu/ui>`_: Destination Earth Data Lake (DEDL)
* `eumetsat_ds <https://data.eumetsat.int>`_: EUMETSAT Data Store (European Organisation for the Exploitation of Meteorological Satellites)

Providers available through an external plugin:

* `SciHub / Copernicus Open Access Hub <https://scihub.copernicus.eu/userguide/WebHome>`_: available using
`eodag-sentinelsat <https://github.com/CS-SI/eodag-sentinelsat>`_
* `wekeo_ecmwf <https://www.wekeo.eu/>`_: WEkEO ECMWF data
* `wekeo_main <https://www.wekeo.eu/>`_: WEkEO Copernicus Sentinel, DEM, and CLMS data
Loading