# xover v3.2.3

**Mercurial revision 5786:5c8b45563631 | 2026-08-04**

---

## Description
`xover` is a command-line tool designed to analyze tidal wave data by computing crossover points, misfits, and generating output files for further analysis. It processes input wave data, bathymetry, and tide gauge databases to produce detailed reports and visualizations.

---
## Usage
```bash
xover [OPTIONS] wave1 [wave2 ...]
```

---
## Options

| Option | Description |
|--------|-------------|
| `-h, --help` | Display this help message and exit. |
| `-m <convention>` | Specify the atlas convention for data processing. |
| `-i <input>` | Path to the input file containing tidal data. |
| `-b <bathymetry>` | Path to the bathymetry file (default: `/home/softs/genesis/data/topography/data/legos.2.grd`). |
| `-p <path>` | Working directory path (default: current directory). |
| `-o <output>` | Path to the output file (default: `xover.out`). |
| `-c <mgrfile>` | Path to the tide gauge database file. |
| `-r <radius>` | Maximum radius (in km) for crossover detection (default: `10.0`). |
| `-x <xover_base>` | Path to the crossover location database file. |

---
## Examples

### **Basic Usage**
```bash
xover -x /path/to/xover_database.dat M2 S2
```
Processes crossover points for tidal waves `M2` and `S2` using the specified crossover database.

### **Custom Output and Bathymetry**
```bash
xover -x /path/to/xover_database.dat -o custom_output.txt -b /path/to/bathymetry.grd M2
```
Generates a custom output file and uses a specified bathymetry file for wave `M2`.

### **Full Options**
```bash
xover -m convention_name -i input_data.txt -b bathymetry.grd -p /working/dir -o results.txt -c tide_gauge.db -r 15.0 -x xover_db.dat M2 K1
```
Processes waves `M2` and `K1` with all options specified.

---
## Environment Variables
- **`PWD`**: Used as the default working directory if `-p` is not specified.

---

## Convention

The atlas file name convention uses the following placeholders:

- `WAVE`: Replaced by the **uppercase** wave name (e.g., `M2`).
- `wave`: Replaced by the **lowercase** wave name (e.g., `m2`).
- `Wave`: Replaced by the **capitalized** wave name (e.g., `M2`).

---

## Notes
- The tool requires a **crossover location database** (`-x`) to function. If not provided, it will exit with an error.
- Bathymetry and tide gauge files must be in the correct format for proper processing.
- Output files include detailed reports and legend files for visualization.