2.2. ecco
This page describes the modules available in the ecco package.
2.2.1. exf
The exf modules is designed to read and write external forcing files.
2.2.1.1. read_ecco_exf_file
Read an external forcing field used in ECCO Version 5 Alpha. (e.g. EIG_dsw_plus_ECCO_v4r1_ctrl_2008)
2.2.1.1.1. Parameters
- data_dirstr
A file path to the directory where the exf files are stored.
- file_prefixfloat
The prefix of the file omitting the year (e.g. EIG_dsw_plus_ECCO_v4r1_ctrl)
- yearint
The year of the file (e.g. 2008)
2.2.1.1.2. Returns
- lon1-d numpy array
An array of longitude values corresponding to the geometry of the grid.
- lat1-d numpy array
An array of latitude values corresponding to the geometry of the grid.
- lon3-d numpy array
An array of external forcing values corresponding to file requested.