Skip to content

Commit fa9fe11

Browse files
committed
minor corrections on Docstring and README
1 parent 73f3bec commit fa9fe11

File tree

2 files changed

+5
-3
lines changed

2 files changed

+5
-3
lines changed

README.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -23,8 +23,8 @@ Check `examples` folder in our [github repository](github.com/iuryt/OceanLab).
2323
## Documentation
2424

2525
- **OA**
26-
- *vectoa()*: Objective analysis for vectorial fields (Adapted from Filipe Fernandes function);
27-
- *scaloa()*: Objective analysis for scalar fields (Adapted from Filipe Fernandes function);
26+
- *vectoa()*: Objective analysis for vectorial fields;
27+
- *scaloa()*: Objective analysis for scalar fields;
2828
- **DYN**
2929
- *dyn_amp()*: Makes the projection of every dynamical mode to velocity to obtain its amplitude;
3030
- *zeta()*: Calculates the vorticity field by velocity field;

src/OceanLab/OA.py

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -3,6 +3,8 @@
33

44
def vectoa(Xg,Yg,X,Y,U,V,corrlenx,corrleny,err,b=0):
55
'''
6+
(Adapted from Filipe Fernandes function)
7+
68
Vectoa is a vectorial objective analysis function.
79
810
It interpolates a velocity field (U and V, east and north velocity components)
@@ -37,7 +39,6 @@ def vectoa(Xg,Yg,X,Y,U,V,corrlenx,corrleny,err,b=0):
3739
PYTHON VERSION by:
3840
Iury Sousa and Hélio Almeida - 30 May 2016
3941
Laboratório de Dinâmica Oceânica - IOUSP
40-
4142
======================================================================'''
4243
# making sure that the input variables aren't changed
4344
xc,yc,x,y,u,v=Xg.copy(),Yg.copy(),X.copy(),Y.copy(),U.copy(),V.copy()
@@ -112,6 +113,7 @@ def vectoa(Xg,Yg,X,Y,U,V,corrlenx,corrleny,err,b=0):
112113

113114
def scaloa(xc, yc, x, y, t=[], corrlenx=None,corrleny=None, err=None, zc=None):
114115
"""
116+
(Adapted from Filipe Fernandes function)
115117
Scalar objective analysis. Interpolates t(x, y) into tp(xc, yc)
116118
Assumes spatial correlation function to be isotropic and Gaussian in the
117119
form of: C = (1 - err) * np.exp(-d**2 / corrlen**2) where:

0 commit comments

Comments
 (0)