← Back to branch summary

~ubuntu-branches/ubuntu/wily/gsw/wily-proposed

« back to all changes in this revision

Viewing changes to README.rst

  • Committer: Package Import Robot
  • Author(s): Alastair McKinstry
  • Date: 2013-07-18 07:26:49 UTC
  • mfrom: (1.1.1)
  • Revision ID: package-import@ubuntu.com-20130718072649-s2yct1q8we4z1w37
Tags: 3.0.2-1
* New upstream release. 
* Move to DH 9.

Show diffs side-by-side

added added

removed removed

Lines of Context:
README.rst
17
17
 
18
18
This table shows some function names in the gibbs library and the corresponding function names in the csiro library.
19
19
 
20
 
+---------------------------------------+-------------------------------+-------------------------------------------------------+
21
 
| **Variable**                          | **SeaWater (EOS 80)**         | **Gibbs SeaWater (GSW TEOS 10)**                      |
22
 
+---------------------------------------+-------------------------------+-------------------------------------------------------+
23
 
| Absolute Salinity                     |          NA                   | gsw.SA_from_SP(SP,p,long,lat)                         |
24
 
+---------------------------------------+-------------------------------+-------------------------------------------------------+
25
 
| Conservative Temperature              |          NA                   | gsw.CT_from_t(SA,t,p)                                 |
26
 
+---------------------------------------+-------------------------------+-------------------------------------------------------+
27
 
| density (i.e. in situ density)        |  sw.dens(SP,t,p)              | gsw.rho_CT(SA,CT,p), or gsw.rho(SA,t,p), or           |
28
 
|                                       |                               | gsw.rho_CT25(SA,CT,p)                                 |
29
 
+---------------------------------------+-------------------------------+-------------------------------------------------------+
30
 
| potential density                     |  sw.pden(SP,t,p,pr)           | gsw.rho_CT(SA,CT,pr), or                              |
31
 
|                                       |                               | gsw.rho_CT25(SA,CT,pr)                                |
32
 
+---------------------------------------+-------------------------------+-------------------------------------------------------+
33
 
| potential temperature                 |  sw.ptmp(SP,t,p,pr)           | gsw.pt_from_t(SA,t,p,pr)                              |
34
 
+---------------------------------------+-------------------------------+-------------------------------------------------------+
35
 
| $\sigma_0$, using                     |  sw.dens(SP, $\theta_o$, 0)   | gsw.sigma0_CT(SA,CT)                                  |
36
 
|  $\theta_o$ = sw.ptmp(SP,t,p,0)       |  -1000 kg m :sup:`-3`         |                                                       |
37
 
+---------------------------------------+-------------------------------+-------------------------------------------------------+
38
 
| $\sigma_2$, using                     |  sw.dens(SP,$\theta_2$, 2000) | gsw.sigma2_CT(SA,CT)                                  |
39
 
|  $\theta_2$ = sw.ptmp(SP,t,p,2000)    |  -1000 kg m :sup:`-3`         |                                                       |
40
 
+---------------------------------------+-------------------------------+-------------------------------------------------------+
41
 
| $\sigma_4$, using                     |  sw.dens(SP,$\theta_4$, 4000) | gsw.sigma2_CT(SA,CT)                                  |
42
 
|  $\theta_4$ = sw.ptmp(SP,t,p,2000)    |  -1000 kg m :sup:`-3`         |                                                       |
43
 
+---------------------------------------+-------------------------------+-------------------------------------------------------+
44
 
| specific volume anomaly               |  sw.svan(SP,t,p)              | gsw.specvol_anom_CT(SA,CT,p)  or                      |
45
 
|                                       |                               | gsw.specvol_anom_CT25(SA,CT,p)                        |
46
 
+---------------------------------------+-------------------------------+-------------------------------------------------------+
47
 
| dynamic height anomaly                | -sw.gpan(SP,t,p)              | gsw.geo_strf_dyn_height(SA,CT,p,delta_p,interp_style) |
48
 
+---------------------------------------+-------------------------------+-------------------------------------------------------+
49
 
| geostrophic velocity                  |  sw.gvel(ga,lat,long)         | gsw.geostrophic_velocity(geo_str,long,lat,p)          |
50
 
+---------------------------------------+-------------------------------+-------------------------------------------------------+
51
 
| N :sup:`2`                            |  sw.bfrq(SP,t,p,lat)          | gsw.Nsquared_CT25(SA,CT,p,lat)                        |
52
 
+---------------------------------------+-------------------------------+-------------------------------------------------------+
53
 
| pressure from height                  |  sw.pres(-z,lat)              | gsw.p_from_z(z,lat)                                   |
54
 
| (SW uses depth, not height)           |                               |                                                       |
55
 
+---------------------------------------+-------------------------------+-------------------------------------------------------+
56
 
| height from pressure                  |  z =  -sw.dpth(p,lat)         | gsw.z_from_p(p,lat)                                   |
57
 
| (SW outputs depth, not height)        |                               |                                                       |
58
 
+---------------------------------------+-------------------------------+-------------------------------------------------------+
59
 
| in situ temperature from pt           |  sw.temp(SP,pt,p,pr)          | gsw.pt_from_t(SA,pt,pr,p)                             |
60
 
+---------------------------------------+-------------------------------+-------------------------------------------------------+
61
 
| sound speed                           |  sw.svel(SP,t,p)              | gsw.sound_speed(SA,t,p)                               |
62
 
+---------------------------------------+-------------------------------+-------------------------------------------------------+
63
 
| isobaric heat capacity                |  sw.cp(SP,t,p)                | gsw.cp(SA,t,p)                                        |
64
 
+---------------------------------------+-------------------------------+-------------------------------------------------------+
65
 
| adiabatic lapse rate*                 |  sw.adtg(SP,t,p)              | gsw.adiabatic_lapse_rate(SA,t,p)                      |
66
 
+---------------------------------------+-------------------------------+-------------------------------------------------------+
67
 
| SP from cndr,  (PSS 78)               |  sw.salt(cndr,t,p)            | gsw.SP_from_cndr(cndr,t,p)                            |
68
 
+---------------------------------------+-------------------------------+-------------------------------------------------------+
69
 
| cndr from SP,  (PSS 78)               |  sw.cndr(SP,t,p)              | gsw.cndr_from_SP(SP,t,p)                              |
70
 
+---------------------------------------+-------------------------------+-------------------------------------------------------+
71
 
| distance                              |  sw.dist(lat,long,units)      | gsw.distance(long,lat,p)                              |
72
 
+---------------------------------------+-------------------------------+-------------------------------------------------------+
73
 
| gravitational acceleration            |  sw.g(lat,z)                  | gsw.grav(lat,p)                                       |
74
 
+---------------------------------------+-------------------------------+-------------------------------------------------------+
75
 
| Coriolis parameter                    |  sw.f(lat)                    | gsw.f(lat)                                            |
76
 
+---------------------------------------+-------------------------------+-------------------------------------------------------+
77
 
| testing of all functions              |  sw.test()                    | gsw.test()                                            |
78
 
+---------------------------------------+-------------------------------+-------------------------------------------------------+
 
20
+-------------------------------------------+-------------------------------------+-------------------------------------------------------+
 
21
| **Variable**                              | **SeaWater (EOS 80)**               | **Gibbs SeaWater (GSW TEOS 10)**                      |
 
22
+-------------------------------------------+-------------------------------------+-------------------------------------------------------+
 
23
| Absolute Salinity                         |          NA                         | gsw.SA_from_SP(SP,p,long,lat)                         |
 
24
+-------------------------------------------+-------------------------------------+-------------------------------------------------------+
 
25
| Conservative Temperature                  |          NA                         | gsw.CT_from_t(SA,t,p)                                 |
 
26
+-------------------------------------------+-------------------------------------+-------------------------------------------------------+
 
27
| density (i.e. in situ density)            |  sw.dens(SP,t,p)                    | gsw.rho_CT(SA,CT,p), or gsw.rho(SA,t,p), or           |
 
28
|                                           |                                     | gsw.rho_CT25(SA,CT,p)                                 |
 
29
+-------------------------------------------+-------------------------------------+-------------------------------------------------------+
 
30
| potential density                         |  sw.pden(SP,t,p,pr)                 | gsw.rho_CT(SA,CT,pr), or                              |
 
31
|                                           |                                     | gsw.rho_CT25(SA,CT,pr)                                |
 
32
+-------------------------------------------+-------------------------------------+-------------------------------------------------------+
 
33
| potential temperature                     |  sw.ptmp(SP,t,p,pr)                 | gsw.pt_from_t(SA,t,p,pr)                              |
 
34
+-------------------------------------------+-------------------------------------+-------------------------------------------------------+
 
35
| :math:`\sigma_0`, using                   |  sw.dens(SP, :math:`\theta_o`, 0)   | gsw.sigma0_CT(SA,CT)                                  |
 
36
|  :math:`\theta_o` = sw.ptmp(SP,t,p,0)     |  -1000 kg m :sup:`-3`               |                                                       |
 
37
+-------------------------------------------+-------------------------------------+-------------------------------------------------------+
 
38
| :math:`\sigma_2`, using                   |  sw.dens(SP,:math:`\theta_2`, 2000) | gsw.sigma2_CT(SA,CT)                                  |
 
39
|  :math:`\theta_2` = sw.ptmp(SP,t,p,2000)  |  -1000 kg m :sup:`-3`               |                                                       |
 
40
+-------------------------------------------+-------------------------------------+-------------------------------------------------------+
 
41
| :math:`\sigma_4`, using                   |  sw.dens(SP,:math:`\theta_4`, 4000) | gsw.sigma2_CT(SA,CT)                                  |
 
42
|  :math:`\theta_4` = sw.ptmp(SP,t,p,2000)  |  -1000 kg m :sup:`-3`               |                                                       |
 
43
+-------------------------------------------+-------------------------------------+-------------------------------------------------------+
 
44
| specific volume anomaly                   |  sw.svan(SP,t,p)                    | gsw.specvol_anom_CT(SA,CT,p)  or                      |
 
45
|                                           |                                     | gsw.specvol_anom_CT25(SA,CT,p)                        |
 
46
+-------------------------------------------+-------------------------------------+-------------------------------------------------------+
 
47
| dynamic height anomaly                    | -sw.gpan(SP,t,p)                    | gsw.geo_strf_dyn_height(SA,CT,p,delta_p,interp_style) |
 
48
+-------------------------------------------+-------------------------------------+-------------------------------------------------------+
 
49
| geostrophic velocity                      |  sw.gvel(ga,lat,long)               | gsw.geostrophic_velocity(geo_str,long,lat,p)          |
 
50
+-------------------------------------------+-------------------------------------+-------------------------------------------------------+
 
51
| N :sup:`2`                                |  sw.bfrq(SP,t,p,lat)                | gsw.Nsquared_CT25(SA,CT,p,lat)                        |
 
52
+-------------------------------------------+-------------------------------------+-------------------------------------------------------+
 
53
| pressure from height                      |  sw.pres(-z,lat)                    | gsw.p_from_z(z,lat)                                   |
 
54
| (SW uses depth, not height)               |                                     |                                                       |
 
55
+-------------------------------------------+-------------------------------------+-------------------------------------------------------+
 
56
| height from pressure                      |  z =  -sw.dpth(p,lat)               | gsw.z_from_p(p,lat)                                   |
 
57
| (SW outputs depth, not height)            |                                     |                                                       |
 
58
+-------------------------------------------+-------------------------------------+-------------------------------------------------------+
 
59
| in situ temperature from pt               |  sw.temp(SP,pt,p,pr)                | gsw.pt_from_t(SA,pt,pr,p)                             |
 
60
+-------------------------------------------+-------------------------------------+-------------------------------------------------------+
 
61
| sound speed                               |  sw.svel(SP,t,p)                    | gsw.sound_speed(SA,t,p)                               |
 
62
+-------------------------------------------+-------------------------------------+-------------------------------------------------------+
 
63
| isobaric heat capacity                    |  sw.cp(SP,t,p)                      | gsw.cp(SA,t,p)                                        |
 
64
+-------------------------------------------+-------------------------------------+-------------------------------------------------------+
 
65
| adiabatic lapse rate*                     |  sw.adtg(SP,t,p)                    | gsw.adiabatic_lapse_rate(SA,t,p)                      |
 
66
+-------------------------------------------+-------------------------------------+-------------------------------------------------------+
 
67
| SP from cndr,  (PSS 78)                   |  sw.salt(cndr,t,p)                  | gsw.SP_from_cndr(cndr,t,p)                            |
 
68
+-------------------------------------------+-------------------------------------+-------------------------------------------------------+
 
69
| cndr from SP,  (PSS 78)                   |  sw.cndr(SP,t,p)                    | gsw.cndr_from_SP(SP,t,p)                              |
 
70
+-------------------------------------------+-------------------------------------+-------------------------------------------------------+
 
71
| distance                                  |  sw.dist(lat,long,units)            | gsw.distance(long,lat,p)                              |
 
72
+-------------------------------------------+-------------------------------------+-------------------------------------------------------+
 
73
| gravitational acceleration                |  sw.g(lat,z)                        | gsw.grav(lat,p)                                       |
 
74
+-------------------------------------------+-------------------------------------+-------------------------------------------------------+
 
75
| Coriolis parameter                        |  sw.f(lat)                          | gsw.f(lat)                                            |
 
76
+-------------------------------------------+-------------------------------------+-------------------------------------------------------+
 
77
| testing of all functions                  |  sw.test()                          | gsw.test()                                            |
 
78
+-------------------------------------------+-------------------------------------+-------------------------------------------------------+
79
79
 
80
80
\* The SW and GSW functions output the adiabatic lapse rate in different units, being  K (dbar) :sup:`-1`  and  K Pa :sup:`-1`  respectively.
81
81
 
83
83
Thanks
84
84
======
85
85
 
 
86
* Bjørn Ådlandsvik - Testing unit and several bug fixes
86
87
* Eric Firing - Support for masked arrays, re-write of _delta_SA
87
88
* Trevor J. McDougall (and all of SCOR/IAPSO WG127) for making available the Matlab and Fortran versions of this software
88
89