# analysis-ecoop v3.2.3

**Mercurial revision 5770:c90c3015e72d | 2026-05-22**

---

## Description

`analysis-ecoop` is a tool designed to **detide a time series** from an ASCII-formatted input file. It processes observational and model data, performs spectral analysis, and generates statistical outputs.

---

## Usage

```bash
analysis-ecoop FILE [OPTIONS]
```

---

## Options


| Option          | Description                                                     |
| --------------- | --------------------------------------------------------------- |
| `-h`, `--help`  | Display help and exit.                                          |
| `-d <file>`     | Path to the **observation file** to process.                    |
| `-m <file>`     | Path to a **list file** containing all model files to process.  |
| `-start <date>` | Start date for the analysis. See [Date Formats](#date-formats1). |
| `-end <date>`   | End date for the analysis. See [Date Formats](#date-formats1).   |
| `--save_psd`    | Save the **power spectral density** in the file `psd_r1_c.py`.  |


---

(date-formats1)=
## Date Formats

The following formats are accepted:

- `yyyy/mm/dd HH:MM:SS.SSS`
- `dd/mm/yyyy HH:MM:SS.SSS`
- `mm/yyyy`

> **Notes:**
>
> - The least significant parts (seconds, minutes, hours, days, months) are **optional**. 
> - The separator can be **any non-numeric character** (e.g., `/`, `-`, `` ).
> - **End dates are inclusive.** Examples:
>   - `2000` → `2001/01/01 00:00:00`
>   - `2000/01` → `2000/02/01 00:00:00`
>   - `2000/01/01` → `2000/01/02 00:00:00`
>   - `2000/01/01 00` → `2000/01/01 01:00:00`
>   - `2000/01/01 00:00` → `2000/01/01 00:01:00`

---

## Examples

### **Basic Usage**

Process a single observation file:

```bash
analysis-ecoop -d observation.txt -m model_list.txt
```

### **Specify Date Range**

Process data between January 2000 and December 2005:

```bash
analysis-ecoop -d observation.txt -m model_list.txt -start 01/2000 -end 12/2005
```

### **Save Power Spectral Density**

Process data and save the power spectral density:

```bash
analysis-ecoop -d observation.txt -m model_list.txt --save_psd
```

### **Full Example**

Process data with a custom date range and save the power spectral density:

```bash
analysis-ecoop -d observation.txt -m model_list.txt -start 06/2000 -end 06/2010 --save_psd
```

---

## Environment Variables

`analysis-ecoop` does not use specific environment variables. However, ensure your system has sufficient resources for processing large time series datasets.

---

## Notes

1. **Input File Format:**
  - The input file **must be in ASCII format**.
  - The tool expects time series data for both observations and model outputs.
2. **Output Files:**
  - The tool generates:
    - `.obs`: Observed sea level data (no correction).
    - `.dif`: Observed sea level data corrected by the model.
    - `.fft`: Fourier-transformed data for spectral analysis.
    - `statistics`: A file containing statistical summaries (mean, variance, etc.).
    - `psd_r1_c.py`: Power spectral density (if `--save_psd` is enabled).
3. **Data Conversion:**
  - Model and observation data are converted to **centimeters** for consistency.
4. **Mask Handling:**
  - Missing or invalid data points are handled using a mask value (`999.9`).
5. **Performance:**
  - For large datasets, ensure sufficient memory and CPU resources are available.

---

## See Also

- [CF Conventions for Time Coordinates](http://cfconventions.org/cf-conventions/cf-conventions.html#time-coordinate) (for reference on date formats)