Use the quick search bar in the Catalog page to add a product.

To manage existing filters, take a look at Manage filters help section.

How to?

Start typing a free text and the interface will provide you with several auto-completion proposals.

If available, you can select a Collection name proposal to search for a specific product. Otherwise, you can select the By name pattern proposal to search for all products containing the entered text.

Result

The text entered in search bar is added as a filter to What filters.

More information about collection name filtering is available in Search by collection filters help section.

The results of the search take into account all filters. Catalog results are sortable, see details on Sort catalog results help section.

Definition of search filters

Important: search results take into account all filters.

Product filter

To add or modify a product filter, use the Search bar.

Where filter

To add or modify a spatial filter, click the Where option under the search bar.

More information about spatial filters is available in Search by spatial filters help section.

When filter

To add or modify a temporal filter, click the When option under the search bar.

More information about temporal filters is available in Search by temporal filters help section.

What filter

To add filters for collections, acquisition types, product formats, online capabilities, or product types, click the What option under the search bar.

You can also modify these filters by clicking on them in the filter view.

More information about acquisition type filtering is available in Search by collection filters help section.

Remove search filters

You can remove filters by clearing them:

• One by one.
• Or all at once.

You can define a spatial filter by typing a feature id or by selecting a reference layer.

A feature ID is a unique identifier associated with a specific geographic feature. This is useful when you already know the exact feature you want to target.

A reference layer is a geographic layer that remains constant over time. It represents fixed spatial boundaries or regions, such as administrative areas, hydrological basins, satellite tiles, or other commonly used geographic datasets.

When a feature or reference layer is selected, it appears in the list of active filters. Each item includes two action buttons:

• map button: displays the selected filter.
• remove button : deletes the filter from the list of applied filters.

You can apply a temporal filter by defining a rolling period, or by setting a start date and an end date.

When selecting Specific Dates, you can manually enter a start date and an end date using the date‑time fields. This allows you to restrict the search to an exact time window.

When selecting a Rolling Period, you can define a dynamic time range relative to the current date. You can configure both the start bound and the end bound by choosing a duration (for example, “3 months ago” to “2 days from now”). This option is useful when you want the time window to update automatically over time.

A summary below the fields indicates how the the filter is interpreted, as well as the timezone currently applied.

To filter search results by collection types, click the What button under the search bar, then select only the desired subset.

Collection names

You can filter results by collection name. You may also combine multiple keywords: each validated keyword is added to the search, and collections whose name contain any of these keywords will be returned. The keywords entered in the Catalog search bar are displayed here.

Acquisition types

You can choose from the following types of acquisition:

• Airborne: Acquired by drone or airplane instrument.
• Composite modes: Computed by various methods.
• In situ: Acquired by in situ equipment.
• Model: Computed by model.
• Satellite: Acquired by satellite instrument.

Product format

You can choose from the following product formats:

• Raster: a grid of pixel-based data.
• Vector: data composed of points, lines, or polygons.

Online capabilities

You can filter results to show only collections that can be displayed on the map or used to generate a chart.

Product types

You can filter results by product types:

• Demonstration products: experimental or pre‑operational datasets.
• Regular products: operational datasets.
• Reference definitions products: static reference datasets.

Filter through What view

In the What view, filters can be added or removed by using boxes.

Selecting several items, but not all of them, displays only the products matching the selected types. For example, if Satellite and Airborne are selected, only products acquired through these two methods will appear.

You can sort catalog results using the following criteria:

• Alphabetical: Sort by collection name
• Number Of Products: Prioritize collections with the highest number of matching products for your selected filters
• Product Format/Types: Sort based on the product formats or types available under the What filters (see the Search by collection filters help section for more information on these formats and types.)

Navigate the map

The Map view provides several tools to help you explore and interact with geographic data. This page describes the main navigation features.

Zoom control

You can zoom in and out of the map to view data at different scales.

Zoom in

• Mouse wheel: Scroll upward to zoom in, or hold CTRL and scroll upward.
• Zoom button: Click the + button in the upper-left corner of the map.

Zoom out

• Mouse wheel: Scroll downward to zoom out, or hold CTRL and scroll downward.
• Zoom button: Click the - button in the upper-left corner of the map.

Reset zoom

Click the Reset button in the upper-left corner to return to the default zoom level and map view.

Pan the map

You can move around the map without changing the zoom level.

• Click and drag: Hold the left mouse button and drag the map to the desired position.
• Arrow keys: Use the arrow keys on your keyboard to move the map in any direction.

Map information displays

The map includes several information panels to help you understand your current view and position.

Scale indicator

The scale is displayed at the top of the map, showing the distance in both metric and unit. This helps you understand the current zoom level and the distance represented on the map.

Coordinate information

The coordinates of your mouse pointer are displayed in a panel at the bottom-right corner of the map. This shows your current position as you move the mouse over the map.

You can copy the coordinates using the keyboard shortcut ALT + SHIFT + C.

Coordinate reference system

The Coordinate Reference System (CRS) is displayed in a panel at the bottom-right corner of the map. This indicates the projection used to display the geographic data.

Timezone

The timezone is displayed in a a panel at the bottom-right corner of the map. It enables to remind you the timezone used and to change it quickly.

From the Catalog or the Map view, you can add collections to your workspace. If the collection has visible layers, click on the Add to Map button: the collection is simultaneously added to your workspace and displayed on the Map. For collections without any visible layers, click the Add to Workspace button: the collection will appear in your workspace. From the Catalog view, the functionality is directly accessible from the collection card. From the Map view, you need to access the Quick Search drawer by clicking the magnifying glass button first to access the collection cards.

By default, the first available layer of the product will be displayed (if any are available).

The product timeline selection corresponds to the defined time selection (Map view bottom bar). You can later modify this selection in the timeline view to adjust the display period of the layers on the map. See Qualify / Show products availabilities help section.

The eye icon indicates visibility status of a product or layer in map:

• Undecorated eye: the requested item is visible.
• Crossed-out eye: the requested item is hidden.

Click on the icon to switch between those states.

As the visibility status is inherited from the parent products, the effective visibility is shown as follows:

• Plain color: visible (all parents are visible).
• Grayed out: one or more parent elements are hidden, so this item is not visible.

Note: Products without any layers cannot be displayed, hence the appearance of a grey crossed-out eye.

Viewable collections contain layers that can be displayed on the map. You can edit these layers from the Manage Map Layers view (layers icon) or from the Manage Workspace (tree structure icon). In the Manage Map Layers view, you can edit a layer using the Pencil icon or directly from this view using the bottom arrow.

Edit layer name

Select the layer to edit, then click the Pencil icon next to the layer, or double click the layer name.

To rename it, enter the new name then press 'Enter' to confirm the new name. Note: Empty names are not allowed. However, it is possible to use the same name for many collections.

Edit tile layer

You can change the tile layer by selecting one of the available map backgrounds. Each tile layer provides a different visual style (for example, with or without labels), allowing you to choose the background that best suits your analysis.

Modify layer appearance

You can change the order in which layers are displayed on the map. By default, the display order follows the list order, which is the order you add collections in your workspace.

You can adjust the opacity of the layer and choose whether it is visible on the map.

Change legend

You can change the color palette associated with the layer and display the legend.

A workspace is a set of collections on which several actions can be performed. A collection represents a product added to the workspace, and each collection contains one or more layers, each corresponding to a variable that can be displayed on the map. You can open the workspace from the Map view by clicking on Manage Workspace (tree structure icon).

Edit a collection

You can change the collection name, as well as the opacity and visibility of its layers by editing the collection.

To edit a collection, select it, then click the Pencil icon next to the collection, or double click the element.

To rename it, enter the new name then press Enter to confirm.

Note: Empty names are not allowed. However, it is possible to use the same name for many collections.

From the Edit collection view, you can adjust the opacity and visibility of all of its layers.

Note: The opacity slider and the visibility toggle apply all layers in the same way. However, before interaction, values can differ.

Show or hide an element on the map

Viewable products can be shown or hidden on the map. See Show or hide elements help section.

Delete elements

You can delete a collection by selecting it and clicking the trash can icon.

Note: Removing a collection will remove all its layers.

Order elements

In order to modify that order, you can use the drag-and-drop system by:

1. Press and hold mouse left button on the product you want to move.
2. Move the product to the place you want.
3. Release your click.

Edit layers

Viewable collections contain layers that can be displayed on the map. You can edit layers by clicking the Pencil icon next to them. You can also edit layers from the Manage Map Layers view (layers icon).

See Edit layers help section.

Principles

hydroweb.next creates a new workspace by default, where products and layers are stored. It is, however, possible to define more than one workspace, and switch between those that are open.

In Manage workspace view

The Manage Workspace view displays the content of the currently opened workspace. It provides the following workspaces-related options:

• Insert new elements, such as collections, reference, or layers, by clicking the plus icon.
• Edit workspace, by clicking the pen icon.
• Open workspaces list, by clicking the folder icon.
• Download collections, by clicking the dots icon, to download all collections, or only visible ones.

Edit a workspace

Select the pen icon in Manage Workspace view to edit your workspace. You can change your workspace's name and its timezone. This view also displays the workspace's coordinate reference system.

To rename it, enter the new name then press 'Enter' to confirm the new name.

Note: Empty names are not allowed. However, it is not possible to use the same name for multiple workspaces.

The timezone field shows the current time based on the selected timezone and provides a list of available timezones. The chosen timezone plays a crucial role in hydroweb.next, influencing:

• The formatting of displayed dates.
• The interpretation of input dates.
• Presentation of days availability in the timeline.
• Determination of the product display range in the timeline.

By default, the selected timezone matches the browser's timezone.

View workspaces

Click the folder icon in Manage Workspace to open the workspaces list and to create a new workspace.

The workspace list view displays all known workspaces with some quick information. It allows you to:

• Rename a workspace.
• Open a workspace, when that workspace is not already opened.
• Duplicate a workspace, and open it immediately.
• Delete a workspace, when that workspace is not already opened. Please note that this action cannot be undone.
• Create a new workspace, and open it immediately.

Timeline

The timeline allows you to define the time period displayed on the map for all time‑based products added to the workspace.
It controls map visualization only: changing the timeline does not affect search filters or product availability queries.

Opening the timeline selection

The timeline is available in the bottom bar of the Map view.
Clicking on the purple timeline area opens the Timeline Selection dialog.

Timeline Selection dialog

The dialog lets you configure the displayed temporal range using the following parameters:

• Selected Date
  The reference date used to position the time range.
• Range Duration
  The size of the time window to display around the selected date.
• Range Duration Unit
  The unit applied to the duration (for example: hours, days, months, or years).
• Range Alignment
  Defines how the range is positioned relative to the selected date
  (for example: Centered around the date).

After adjusting the parameters, click Confirm to apply the timeline to the map.

Behavior

• The selected timeline is applied globally to all visualized products.
• If a product is not visible on the map, its availability period may fall outside the selected timeline.
• When no product is selected, the timeline can still be configured.
  Any product added afterward will automatically use the current timeline settings.

Selecting points of interest on the map allows you to inspect the data available at a specific location, retrieve layer values, and generate plots for the selected features.

Enabling Map Selection

To enable map picking, ensure the following:

1. The workspace contains visible products with visible layers.
2. Product layers are visible at the current map location.

Picking Features on the Map

To select points of interest, simply click on the map at the desired location.

This action triggers the following steps:

• Points of interest located at the clicked position are retrieved.
• The Pick Map Features view opens, allowing you to view the selected points of interest and create plots based on them.

The behavior depends on the type of product:

• Raster products: If a raster tile exists at the clicked location, the point of interest values will be displayed for the exact coordinates.
• Vector products (such as stations, points, lines, or polygons): The corresponding vector elements will be selected as points of interest, and their values will be shown if they exist under the clicked coordinates.

The Pick Map Features view also provides options to delete previously selected elements.

Note: Deleting elements in the Pick Map Features view does not affect your workspace content.

Retrieving Layer Values

To consult layer values:

1. With map selection enabled, click on the map at the desired location.
2. If there are visible layers with data at this location, a row will be added for each selected element in the Pick Map Feature view. Note: Toggling layer visibility in the workspace view will add or remove values from selected elements accordingly.
3. If no data is available at the clicked location, the Pick Map Feature view will remain unchanged.

Preview operational product time series

If only one feature exists at the selected location, the plot is displayed immediately in a dialog box.

Otherwise, each vector product row (for non-reference products) offers a Chart option. Clicking this allows you to create a plot, which will display a curve for each visible layer at the selected points of interest.

For more details on plots, see Show Variables Evolution help section.

Search products in shape

The search icon enables to add the shape of the feature as a filter in your workspace. This enables you to view other products that overlap with the shape of the feature.

Add reference collection

From Pick Map Feature menu, you can add reference and station collections—such as lakes, rivers, regions, satellites or stations—to your workspace.

The time evolution of variable quantities at a point of interest can be visualized using the plot view.
This view is displayed when creating a new plot for selected point of interest, see Select point of interest help section for more details.

Plot content

The plot view displays the evolution of variable layers over time as curves for the given point of interest. If several layers are available for the selected point of interest, one plot per layer will be displayed one after another.

The horizontal axis represents time, from the oldest to the most recent date.

The vertical axis represents values, spanning from the minimum to the maximum value of the layer, with a small margin.

The plot tooltip indicates precise values, uncertainties and dates when hovering with the mouse.

If there are too many data points, the curve is sampled and a message appears in the tooltip.

Plot area

The plot area is computed when the plot is opened. It is defined by:

• Maximum horizontal range (period): the full availability of the product.
• Default horizontal range: the product's temporal search filter range.
  • If the product has no temporal filter, the default range is the maximum range.
  • If filters span outside maximum horizontal range, it is restricted to the maximum range.
• Current horizontal range: the last range set by the user (via zoom), or the default horizontal range if none.
• Maximum vertical range (values): the full value range of the layer, with spacing margins.
• Current vertical range: the last range set by the user (via zoom), or the maximum vertical range if none.

When closing and reopening a plot, the last horizontal and vertical ranges are restored.

Plot zoom control

The plot view provides the following interactions to adjust the displayed area:

• Zoom in
  • Select the Zoom in button in the upper-right corner, then click on the plot to zoom in around the clicked location.
  • Or spin the mouse wheel upward while holding the CTRL key (zooms at mouse position).
• Zoom out
  • Select the Zoom out button in the upper-right corner, then click on the plot to zoom out around the clicked location.
  • Or spin the mouse wheel downward while holding the CTRL key.
• Scroll through time (horizontal axis)
  • Use the horizontal scrollbar.
  • Or spin the mouse wheel while holding the SHIFT key.
• Scroll through values (vertical axis)
  • Use the vertical scrollbar.
  • Or spin the mouse wheel, with no modifier key.
• Scroll in any direction
  • Drag the plot with the left mouse button.
• Zoom to a specific area
  • Select the Zoom in button in the upper-right corner, then drag to draw the zoom area.
  • Or drag with the left mouse button while holding the SHIFT key pressed (no need to select Zoom in first).
• Reset zoom
  • Click the Reset zoom button in the upper-right corner. This restores the default horizontal range and the maximum vertical range.

Download chart

You can download the plot series by clicking the Download CSV button in the view upper-right corner. The entire series is downloaded in CSV format, regardless of the current zoom level.

Before downloading any data, you must be authenticated. Use the login button to create an account or to sign in if you already have one.

WARNING: The total amount of requested downloads is limited to 100 GB. Any new download request will be blocked until your used download space falls below this quota. Please contact the support for more information.

Search for the collection you want to download from the Catalog view or using the Search in catalog button in the Map view. To access the download menu, click the Download button under the collection.

Download a product

Click the Order products button to download all product files (according to the applied search filters) as a ZIP archive.

This option downloads the complete dataset for the selected filters.

A notification will appear showing the download request. Preparation will begin; this may take some time depending on your bandwidth and on the selected product. You may click on the View Downloads button to monitor the download progress. At the end of the preparation, a notification appears indicating that the collection is ready for download.

Then, from the Downloads view (accessed from the notification or from the shortcut in the top bar), click the Download button.

Download a sample

Click the Download a sample button to download a sample file.

This option is useful for previewing the data format and structure before downloading the full product. The sample contains a small subset of the data to help you understand its structure and format.

Download Python script

Click the Download by script button to download a ready-to-use py_hydroweb Python script.

This option generates a customized Python script that you can use to download the collection programmatically using the same search filters you applied in the interface. This is useful for automated downloads, batch processing, or integrating downloads into your workflow.

Take a look at Using scripts help section for more details about this script.

Download several products

Multi‑collection downloads will be available soon.

hydroweb.next enables data download via a Python script, accessible from the Downloads view when retrieving either search results or workspace content.

WARNING: The total amount of requested downloads is limited to 100 GB. Any new download request will be blocked until your used download space falls below this quota. Please contact support for more information.

Authentication

Similar to the web app, the Python script requires authentication. This is done using an API key provided by hydroweb.next, which you can obtain in the Account view.

If needed, refer to the Account page to generate a new API key.

Script Execution

Choosing an Authentication Method

Before running the script, choose how to provide the authentication key:

1. In the code: Use the api_key parameter when creating py_hydroweb.Client. This allows quick execution but doesn't support sharing the API key across multiple scripts (uncomment the corresponding line).

client: py_hydroweb.Client = py_hydroweb.Client("https://download.hygor.dev.hysope2.cnes.fr/api",api_key="<your api key here>")

2. Environment variable: Set the API key as HYDROWEB_API_KEY environment variable in your operating system. This allows the same API key to be shared across all scripts unless they specify the api_key parameter. Please refer to the section below to set an environment variable on your work station.

By default, the script uses the second method, so you'll need to set up the environment variable. If you prefer the first method, comment out line 39 and uncomment line 41 as indicated in the script.

Downloading Multiple Collections

The script is set up to download the collection you selected. You can add a collection to the script basket using the collection identifier provided on the Details view.

basket.add_collection("C3S_CDS_TOTAL_PRECIPITATION_ERA5_HOURLY")

Running the Script

In your Python environment, follow the script instructions and execute it!

Customizing your Script

To customize your own Python script using the py_hydroweb library, check out the official documentation on PyPi.

Please note that by script you can add as many collections as you want (providing that you respect your overall download quota).

Setting Environment Variables

Temporarily (Current Session Only)

Linux/macOS

export VARIABLE_NAME=value

Windows Command Prompt

set VARIABLE_NAME=value

Windows PowerShell

$env:VARIABLE_NAME = "value"

Permanently

Linux

1. For current user, add to ~/.bashrc or ~/.zshrc:

export VARIABLE_NAME=value

2. For all users, create a new file in /etc/profile.d/:

sudo nano /etc/profile.d/my_variables.sh

# Add the following line:
export VARIABLE_NAME=value

3. Apply changes:

source ~/.bashrc  # For current user
# or
source /etc/profile.d/my_variables.sh  # For system-wide changes

macOS

1. For current user, add to ~/.zshrc (default shell since Catalina) or ~/.bash_profile:

export VARIABLE_NAME=value

2. For all users, create a file in /etc/profile.d/:

sudo nano /etc/profile.d/my_variables.sh

# Add the following line:
export VARIABLE_NAME=value

3. Apply changes:

source ~/.zshrc  # For current user
# or
source /etc/profile.d/my_variables.sh  # For system-wide changes

Windows

1. Using GUI:

   • Right-click on 'This PC' or 'My Computer'
   • Click 'Properties'
   • Click 'Advanced system settings'
   • Click 'Environment Variables'
   • Click 'New' under either User or System variables
   • Enter variable name and value
   • Click 'OK' to save

2. Using Command Prompt (Admin):

setx VARIABLE_NAME "value"              # For current user
setx VARIABLE_NAME "value" /M           # For system variables

3. Using PowerShell (Admin):

[System.Environment]::SetEnvironmentVariable('VARIABLE_NAME', 'value', 'User')     # For current user
[System.Environment]::SetEnvironmentVariable('VARIABLE_NAME', 'value', 'Machine')  # For system variables

Verifying Environment Variables

Linux/macOS

echo $VARIABLE_NAME    # Print specific variable
env                    # List all environment variables
printenv               # Alternative to list all variables

Windows Command Prompt

echo %VARIABLE_NAME%   # Print specific variable
set                    # List all environment variables

Windows PowerShell

$env:VARIABLE_NAME     # Print specific variable
Get-ChildItem Env:     # List all environment variables

Important Notes

• Windows requires a restart of Command Prompt/PowerShell or applications to recognize new environment variables
• Linux/macOS require reloading the shell configuration file or terminal restart to recognize permanent changes
• Variable names are conventionally UPPERCASE with underscores
• Avoid spaces around the equals sign in Linux/macOS export commands
• Always back up configuration files before making changes.

Display view

To access this view, you must be authenticated. To log in, click the log-in option in the top bar and either create an account or sign in if you already have one. You can access your account settings by clicking the profile button in the top right corner of the application bar. This view provides access to the following options.

Account

You can delete your account.

Note: This action is irreversible.

API key

The API key section allows you to manage your API key.

In the API key section, you can:

• create a new API key by clicking the Create option. Once created, it is shown in this section for a limited time and can be copied with the Copy option.
• revoke your API key by clicking on the Delete API key option.
• renew your API key by clicking the Update option.

Note: You should keep that key secret, as other users could access your data with it. Revoke or create it again if you lost it or think it may have been disclosed.

Email notifications

You can choose which emails you want to receive (news, download updates, technical support, and user surveys).

Quick tips

Quick tips are contextual hints that help you understand interface features. Quick tips are hidden after closing. To re-enable the quick tips, you must clear the site's data in your browser settings.

The available quick tips correspond to the main search filters:

• Where: Tips for spatial filtering.
• When: Tips for temporal filtering.
• What: Tips for collection type filtering (acquisition types, product formats, online capabilities, product types, etc.).
• All filters.

Several global actions are available from the top bar. You can access them by clicking the three‑dot button located on the right side of the top bar.

Contact support team

This button opens your email client using a mailto link, allowing you to contact the operations team directly if you need assistance or encounter an issue.

What’s new

This section will soon provide information about recent updates, improvements, and new features available.

Give us feedback

This button allows you to share your experience using the platform. Your feedback helps us improve hydroweb.next and better understand your needs.

hydroweb.next has an up-to-date STAC API (Version 1.0.0) for exploring collections and products.

The STAC landing page is at https://hydroweb.next.theia-land.fr/api/catalog/stac.

You can use any STAC-compatible client to explore this API. Here are a few examples.

Prerequisites

Most of our collections are publicly available for exploring.

You need to be authenticated:

• To explore access restricted collections.
• To download any of our products.

To handle authentication, you have to use an API key. Please refer to Account page, and see settings help page for further information..

STAC Tools

• STAC browser: STAC browser lets you browse the STAC catalogue as a public user.

Python clients

PySTAC client

PySTAC client is useful for exploring hydroweb.next products.

Reference documentation: https://pystac-client.readthedocs.io/en/stable/

Tutorials: https://pystac-client.readthedocs.io/en/stable/tutorials.html

See which extensions are available at STAC conformance endpoint.

Code snippets:

• List all collections with PySTAC client
• Search items with PySTAC client

Downloading is not supported out of the box by PySTAC, but you can implement this function using the library of your choice (e.g., requests) and the links provided in the assets.

Warning : only internal collection assets can be downloaded with PySTAC client! Check collection_type on collection properties.

For faster, more robust downloads, we recommend using the dedicated hydroweb.next client.
This client enables you to download any type of data, regardless of the type of collection to which it belongs.

EODAG

EODAG can be used as a command line tool to list, search and download products.

Warning : only internal collection assets can be downloaded with EODAG! Check collection_type on collection properties.

hydroweb.next is an official provider of EODAG.

Reference documentation: https://eodag.readthedocs.io/en/stable/

Code snippets:

• Advanced download script with EODAG