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¶

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.
`-end <date>`	End date for the analysis. See Date Formats.
`--save_psd`	Save the power spectral density in the file `psd_r1_c.py`.

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:

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

Specify Date Range¶

Process data between January 2000 and December 2005:

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:

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:

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¶

Input File Format:

The input file must be in ASCII format.
The tool expects time series data for both observations and model outputs.

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).

Data Conversion:

Model and observation data are converted to centimeters for consistency.

Mask Handling:

Missing or invalid data points are handled using a mask value (999.9).

Performance:

For large datasets, ensure sufficient memory and CPU resources are available.