# README - Jeu de données ADVP / ADVP Dataset

*Please scroll down for the English version.*

---

##  FRANÇAIS

### Description générale
Ce jeu de données contient des profils de vitesse et d'écho traités à partir de mesures brutes d'un Profileur de Vélocité Doppler Acoustique (ADVP). Les données brutes (fichiers `.udt`) ont été converties, et les vitesses ont été projetées dans le référentiel de l'instrument en utilisant les paramètres géométriques des capteurs. 

Les fichiers traités sont sauvegardés au format binaire compressé NumPy (`.npz`) avec la nomenclature : `processed_YYYYMMDD_HHMMSS_ADVP.npz`.

### Structure du fichier de données
Les fichiers `.npz` contiennent 9 tableaux distincts. Étant donné que les données ont été sauvegardées sans clés nommées, elles sont accessibles via les identifiants génériques `arr_0` à `arr_8`.

Voici la correspondance exacte des variables :

| Clé NumPy | Variable | Description |
| :--- | :--- | :--- |
| `arr_0` | **uj** | Profil des vitesses longitudinales $u$ |
| `arr_1` | **vj** | Profil des vitesses transversales $v$ |
| `arr_2` | **wj** | Profil des vitesses verticales $w$ (calculé à partir des faisceaux 1 et 2) |
| `arr_3` | **w2j** | Profil des vitesses verticales $w$ (calculé à partir des faisceaux 3 et 4) |
| `arr_4` | **dj** | Distances de mesure depuis l'émetteur (profondeur/position des cellules) |
| `arr_5` | **echo_profile1** | Intensité du signal de retour (écho) pour le faisceau 1 |
| `arr_6` | **echo_profile2** | Intensité du signal de retour (écho) pour le faisceau 2 |
| `arr_7` | **echo_profile3** | Intensité du signal de retour (écho) pour le faisceau 3 |
| `arr_8` | **echo_profile4** | Intensité du signal de retour (écho) pour le faisceau 4 |

### Comment lire les données en Python
Voici un script rapide pour extraire les données du fichier `.npz` :

```python
import numpy as np

# Charger le fichier
data = np.load('processed_20261006_140038_ADVP.npz')

# Extraction des variables
uj = data['arr_0']
vj = data['arr_1']
wj = data['arr_2']
w2j = data['arr_3']
dj = data['arr_4']
echo_profile1 = data['arr_5']

# Fermer le fichier
data.close()

print(f"Forme du profil de vitesse U : {uj.shape}")
```

---
---

##  ENGLISH

### General Description
This dataset contains processed velocity and echo profiles derived from raw Acoustic Doppler Velocity Profiler (ADVP) measurements. The raw data (`.udt` files) have been converted, and the velocities have been transformed into the instrument's coordinate system using the specific geometric parameters of the sensors.

The processed files are saved in the NumPy compressed binary format (`.npz`) with the following naming convention: `processed_YYYYMMDD_HHMMSS_ADVP.npz`.

### Data File Structure
The `.npz` files contain 9 distinct arrays. Since the data was saved without explicit keyword arguments, they are accessible using the default NumPy identifiers `arr_0` through `arr_8`.

Here is the exact mapping of the variables:

| NumPy Key | Variable | Description |
| :--- | :--- | :--- |
| `arr_0` | **uj** | Longitudinal velocity profiles $u$ |
| `arr_1` | **vj** | Transverse velocity profiles $v$ |
| `arr_2` | **wj** | Vertical velocity profiles $w$ (computed from beams 1 and 2) |
| `arr_3` | **w2j** | Vertical velocity profiles $w$ (computed from beams 3 and 4) |
| `arr_4` | **dj** | Measurement distance from the emitter (depth/cell position) |
| `arr_5` | **echo_profile1** | Acoustic backscatter (echo) intensity for beam 1 |
| `arr_6` | **echo_profile2** | Acoustic backscatter (echo) intensity for beam 2 |
| `arr_7` | **echo_profile3** | Acoustic backscatter (echo) intensity for beam 3 |
| `arr_8` | **echo_profile4** | Acoustic backscatter (echo) intensity for beam 4 |

### How to load the data in Python
Here is a quick script to extract the data from the `.npz` file:

```python
import numpy as np

# Load the file
data = np.load('processed_20261006_140038_ADVP.npz')

# Extract variables
uj = data['arr_0']
vj = data['arr_1']
wj = data['arr_2']
w2j = data['arr_3']
dj = data['arr_4']
echo_profile1 = data['arr_5']

# Close the file
data.close()

print(f"Shape of the U velocity profile: {uj.shape}")
```