File: test_octave.py

package info (click to toggle)
gsw 3.0.3-2
  • links: PTS
  • area: main
  • in suites: stretch
  • size: 5,812 kB
  • ctags: 892
  • sloc: python: 9,017; makefile: 85; sh: 3
file content (214 lines) | stat: -rw-r--r-- 9,029 bytes parent folder | download | duplicates (2)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
# -*- coding: utf-8 -*-
#
# test_octave.py
#
# purpose:  Quick "compare test" with octave results.
# author:   Filipe P. A. Fernandes
# e-mail:   ocefpaf@gmail
# web:      http://ocefpaf.tiddlyspot.com/
# created:  13-Jun-2013
# modified: Tue 02 Jul 2013 07:45:17 PM BRT
#
# obs:  This is different from `test_check_values.py`, that tests
# against the results in the docs, `test_octave.py` uses same input values to
# run both python and Matlab versions (using Octave).
#
# This is not a thorough test, just an "ad hoc" test to compare when a new
# Matlab version is released.
#

import os
import sys
from collections import OrderedDict

import numpy as np

from oct2py import octave
from oct2py._utils import Oct2PyError

import gsw

try:
    path = sys.argv[1]
except IndexError:
    path = "./matlab_gsw_v3_03"


# We have to supply a fake superiorfloat function for octave.
# We are writing it in the local directory, which is not a nice
# thing to do; maybe this can be improved later.

_sfloat = """function out = superiorfloat(varargin)
out = 'double';
"""
open('superiorfloat.m', 'wt').write(_sfloat)


if not os.path.exists(path):
    raise ValueError("matlab gsw path %s not found" % path)

_ = octave.addpath(octave.genpath(path))
_ = octave.addpath('./')


def compare_results(name, function, args):
    args = [values.get(arg) for arg in args]
    print(name)

    try:  # Python.
        res = function(*args)
    except:
        print('%s: python runtime error' % name)
        raise
        return 'no_python'

    nout = 1
    if isinstance(res, tuple):
        nout = len(res)
        res = res[0]

    try:  # Octave.
        val = octave.call('gsw_%s' % name, *args, verbose=True, nout=nout)
        if nout > 1:
            val = val[0]
    except Oct2PyError:
        print('%s: Octave runtime error' % name)
        print("python:\n%s" % res)
        return 'no_octave'

    try:
        val = val.flatten()
        perfect = (val == res).all()
    except:
        print('%s: Comparison failed' % name)
        print("octave:\n%s" % val)
        print("python:\n%s" % res)
        return 'no_comparison'
    if np.allclose(val, res, rtol=1e-15, atol=0):
        print('%s: Passed' % name)
        return 'passed'
    else:
        print('%s: Failed' % name)
        print("octave:\n%s" % val)
        print("python:\n%s" % res)
        return 'failed'
    print('')

values = dict(C=np.array([34.5487, 34.7275, 34.8605, 34.6810, 34.568, 34.56]),
              t=np.array([28.7856, 28.4329, 22.8103, 10.2600, 6.8863, 4.4036]),
              p=np.array([10., 50., 125., 250., 600., 1000.]),
              SP=np.array([34.5487, 34.7275, 34.8605, 34.6810, 34.5680,
                           34.5600]),
              SA=np.array([34.7118, 34.8915, 35.0256, 34.8472, 34.7366,
                           34.7324]),
              CT=np.array([28.7856, 28.4329, 22.8103, 10.2600, 6.8863,
                           4.4036]),
              rho=np.array([1021.8484, 1022.2647, 1024.4207, 1027.7841,
                            1029.8287, 1031.9916]),
              ps=0, pt=0, pp=0,
              lat=np.array([4., 4., 4., 4., 4., 4.]),
              lon=np.array([188., 188., 188., 188., 188., 188.]),
              pt0=np.array([28.8099, 28.4392, 22.7862, 10.2262, 6.8272,
                            4.3236]),
              spycnl=np.array([21.8482, 22.2647, 24.4207, 27.7841, 29.8287,
                               31.9916]),
              A='gn',  # or s2 for sigma2; but then spycnl would need to change
              # Also, the matlab code is incorrect for the s2 case.
              p_i=np.array([500.0, 600.0, 700.0]),
              # Baltic.
              SAb=np.array([6.6699, 6.7738, 6.9130, 7.3661, 7.5862, 10.3895]),
              SPb=np.array([6.5683, 6.6719, 6.8108, 7.2629, 7.4825, 10.2796]),
              latb=np.array([59., 59., 59., 59., 59., 59.]),
              lonb=np.array([20., 20., 20., 20., 20., 20.])
              )
# Functions.
library = OrderedDict({
    # library.py
    'deltaSA_atlas': (gsw.library.deltaSA_atlas, ('p', 'lon', 'lat')),
    'enthalpy_SSO_0_p': (gsw.library.enthalpy_SSO_0_p, ('p')),
    'entropy_part': (gsw.library.entropy_part, ('SA', 't', 'p')),
    'entropy_part_zerop': (gsw.library.entropy_part_zerop, ('SA', 'pt0')),
    'Fdelta': (gsw.library.Fdelta, ('p', 'lon', 'lat')),
    'gibbs': (gsw.library.gibbs, ('ps', 'pt', 'pp', 'SA', 't', 'p')),
    'gibbs_pt0_pt0': (gsw.library.gibbs_pt0_pt0, ('SA', 'pt0')),
    'Hill_ratio_at_SP2': (gsw.library.Hill_ratio_at_SP2, ('t')),
    'infunnel': (gsw.library.infunnel, ('SA', 'CT', 'p')),
    # FIXME: There is a problem with the argument handling in interp_SA_CT.
    'interp_ref_cast': (gsw.library.interp_ref_cast, ('spycnl', 'A')),
    'interp_SA_CT': (gsw.library.interp_SA_CT, ('SA', 'CT', 'p', 'p_i')),
    'SAAR': (gsw.library.SAAR, ('p', 'lon', 'lat')),
    'SA_from_SP_Baltic': (gsw.library.SA_from_SP_Baltic, ('SPb', 'lonb',
                                                          'latb')),
    'specvol_SSO_0_p': (gsw.library.specvol_SSO_0_p, ('p')),
    'SP_from_SA_Baltic': (gsw.library.SP_from_SA_Baltic, ('SAb', 'lonb',
                                                          'latb')),
    # thermodynamics_from_t.py
    #'adiabatic_lapse_rate_from_t': (gsw.adiabatic_lapse_rate_from_t,
                                    #('SA', 't', 'p')),
    'alpha_wrt_CT_t_exact': (gsw.alpha_wrt_CT_t_exact, ('SA', 't', 'p')),
    'alpha_wrt_pt_t_exact': (gsw.alpha_wrt_pt_t_exact, ('SA', 't', 'p')),
    'alpha_wrt_t_exact': (gsw.alpha_wrt_t_exact, ('SA', 't', 'p')),
    'beta_const_CT_t_exact': (gsw.beta_const_CT_t_exact, ('SA', 't', 'p')),
    'beta_const_pt_t_exact': (gsw.beta_const_pt_t_exact, ('SA', 't', 'p')),
    'beta_const_t_exact': (gsw.beta_const_t_exact, ('SA', 't', 'p')),
    'chem_potential_relative_t_exact': (gsw.chem_potential_relative_t_exact,
                                        ('SA', 't', 'p')),
    'chem_potential_salt_t_exact': (gsw.chem_potential_salt_t_exact,
                                    ('SA', 't', 'p')),
    'chem_potential_water_t_exact': (gsw.chem_potential_water_t_exact,
                                     ('SA', 't', 'p')),
    'cp_t_exact': (gsw.cp_t_exact, ('SA', 't', 'p')),
    #'deltaSA_from_rho_t_exact': (gsw.deltaSA_from_rho_t_exact,
                                 #('rho', 'SP', 't', 'p')),
    'dynamic_enthalpy_t_exact': (gsw.dynamic_enthalpy_t_exact,
                                 ('SA', 't', 'p')),
    'enthalpy_t_exact': (gsw.enthalpy_t_exact, ('SA', 't', 'p')),
    'entropy_t_exact': (gsw.entropy_t_exact, ('SA', 't', 'p')),
    'Helmholtz_energy_t_exact': (gsw.Helmholtz_energy_t_exact,
                                 ('SA', 't', 'p')),
    'internal_energy_t_exact': (gsw.internal_energy_t_exact, ('SA', 't', 'p')),
    'isochoric_heat_cap_t_exact': (gsw.isochoric_heat_cap_t_exact,
                                   ('SA', 't', 'p')),
    'kappa_const_t_exact': (gsw.kappa_const_t_exact, ('SA', 't', 'p')),
    'kappa_t_exact': (gsw.kappa_t_exact, ('SA', 't', 'p')),
    'osmotic_coefficient_t_exact': (gsw.osmotic_coefficient_t_exact,
                                    ('SA', 't', 'p')),
    'osmotic_pressure_t_exact': (gsw.osmotic_pressure_t_exact,
                                 ('SA', 't', 'pw')),
    'pot_rho_t_exact': (gsw.pot_rho_t_exact, ('SA', 't', 'p', 'p_ref')),
    'rho_t_exact': (gsw.rho_t_exact, ('SA', 't', 'p')),
    'SA_from_rho_t_exact': (gsw.SA_from_rho_t_exact, ('rho', 't', 'p')),
    #'SA_from_rho_t': (gsw.SA_from_rho_t, ('rho', 't', 'p')),
    'sigma0_pt0_exact': (gsw.sigma0_pt0_exact, ('SA', 'pt0')),
    'sound_speed_t_exact': (gsw.sound_speed_t_exact, ('SA', 't', 'p')),
    'specvol_anom_t_exact': (gsw.specvol_anom_t_exact, ('SA', 't', 'p')),
    'specvol_t_exact': (gsw.specvol_t_exact, ('SA', 't', 'p')),
    't_from_rho_exact': (gsw.t_from_rho_exact, ('rho', 'SA', 'p')),
    't_maxdensity_exact': (gsw.t_maxdensity_exact, ('SA', 'p')),
    # absolute_salinity_sstar_ct.py
    'SA_from_SP': (gsw.SA_from_SP, ('SP', 'p', 'lon', 'lat'))})

def iteritems(d):
    'Factor-out Py2-to-3 differences in dictionary item iterator methods'
    try:
         return d.iteritems()
    except AttributeError:
         return d.items()

if __name__ == '__main__':
    outcomes = ['passed', 'no_octave', 'no_python', 'failed', 'no_comparison']
    results = dict([(k, list()) for k in outcomes])

    for name, (function, args) in iteritems(library):
        ret = compare_results(name=name, function=function, args=args)
        results[ret].append(name)

    #os.remove('superiorfloat.m')

    print('\nSummary:')
    print('passed:\n  %s' % '\n  '.join(results['passed']))
    print('octave call failed:\n  %s' % '\n  '.join(results['no_octave']))
    print('python call failed:\n  %s' % '\n  '.join(results['no_python']))
    print('results did not match:\n  %s' % '\n  '.join(results['failed']))
    print('comparison failed:\n  %s' % '\n  '.join(results['no_comparison']))
    print('')