scivision / lowtran / 233

pending completion

Build # 233

Build Type

push

travis-ci

Committed by

scivision

Commit Message

<a href="https://github.com/scivision/lowtran/commit/<a class=hub.com/scivision/lowtran/commit/<a class="double-link" href="https://git"><a class=hub.com/scivision/lowtran/commit/<a class="double-link" href="https://git"><a class=hub.com/scivision/lowtran/commit/<a class="double-link" href="https://git"><a class=hub.com/scivision/lowtran/commit/92c683e91528124b1e7e387a73a0d4d4732c628a">92c683e91">&lt;a href=&quot;https://github.com/scivision/lowtran/commit/</a><a class="double-link" href="https://github.com/scivision/lowtran/commit/&lt;a class=&quot;double-link&quot; href=&quot;https://git">&lt;a class=</a>hub.com/scivision/lowtran/commit/&lt;a class=&quot;double-link&quot; href=&quot;https://git">&lt;a class=</a>hub.com/scivision/lowtran/commit/&lt;a class=&quot;double-link&quot; href=&quot;https://git">&lt;a class=</a>hub.com/scivision/lowtran/commit/&lt;a class=&quot;double-link&quot; href=&quot;https://git">&lt;a class=</a>hub.com/scivision/lowtran/commit/92c683e91528124b1e7e387a73a0d4d4732c628a">92c683e91</a><a href="https://github.com/scivision/lowtran/commit/92c683e91528124b1e7e387a73a0d4d4732c628a">&quot;&gt;&amp;lt;a href=&amp;quot;https://github.com/scivision/lowtran/commit/&lt;/a&gt;&lt;a class=&quot;double-link&quot; href=&quot;https://github.com/scivision/lowtran/commit/&amp;lt;a class=&amp;quot;double-link&amp;quot; href=&amp;quot;https://git&quot;&gt;&amp;lt;a class=&lt;/a&gt;hub.com/scivision/lowtran/commit/&amp;lt;a class=&amp;quot;double-link&amp;quot; href=&amp;quot;https://git&quot;&gt;&amp;lt;a class=&lt;/a&gt;hub.com/scivision/lowtran/commit/&amp;lt;a class=&amp;quot;double-link&amp;quot; href=&amp;quot;https://git&quot;&gt;&amp;lt;a class=&lt;/a&gt;hub.com/scivision/lowtran/commit/&amp;lt;a class=&amp;quot;double-link&amp;quot; href=&amp;quot;https://git&quot;&gt;&amp;lt;a class=&lt;/a&gt;hub.com/scivision/lowtran/commit/92c683e91528124b1e7e387a73a0d4d4732c628a&quot;&gt;92c683e91&lt;/a&gt;&lt;a href=&quot;https://github.com/scivision/lowtran/commit/92c683e91528124b1e7e387a73a0d4d4732c628a&quot;&gt;&amp;quot;&amp;gt;&amp;amp;lt;a href=&amp;amp;quot;https://github.com/scivision/lowtran/commit/&amp;lt;/a&amp;gt;&amp;lt;a class=&amp;quot;double-link&amp;quot; href=&amp;quot;https://github.com/scivision/lowtran/commit/&amp;amp;lt;a ... (continued)

Run Details

115 of 115 new or added lines in 6 files covered. (100.0%)

128 of 162 relevant lines covered (79.01%)

0.79 hits per line

Source File
Press 'n' to go to next uncovered line, 'b' for previous

73.21

/lowtran/base.py

from typing import Dict, Any
import logging
import xarray
import numpy as np
from typing import Tuple
try:
    import lowtran7  # don't use dot in front, it's linking to .dll, .pyd, or .so
except ImportError as e:
    raise ImportError(f'you must compile the Fortran code first. f2py -m lowtran7 -c lowtran7.f  {e}')


def nm2lt7(short_nm: float, long_nm: float, step_cminv: float=20) -> Tuple[float, float, float]:
    """converts wavelength in nm to cm^-1
    minimum meaningful step is 20, but 5 is minimum before crashing lowtran

    short: shortest wavelength e.g. 200 nm
    long: longest wavelength e.g. 30000 nm
    step: step size in cm^-1 e.g. 20

    output in cm^-1
    """
    short = 1e7 / short_nm
    long = 1e7 / long_nm

    N = int(np.ceil((short-long) / step_cminv)) + 1  # yes, ceil

    return short, long, N


def loopuserdef(c1: Dict[str, Any]) -> xarray.DataArray:
    """
    golowtran() is for scalar parameters only
    (besides vector of wavelength, which Lowtran internally loops over)

    wmol, p, t must all be vector(s) of same length
    """

    wmol = np.atleast_2d(c1['wmol'])
    P = np.atleast_1d(c1['p'])
    T = np.atleast_1d(c1['t'])
    time = np.atleast_1d(c1['time'])

    assert wmol.shape[0] == len(P) == len(T) == len(time), 'WMOL, P, T,time must be vectors of equal length'

    N = len(P)
# %% 3-D array indexed by metadata
    TR = xarray.Dataset(coords={'time': time, 'wavelength_nm': None, 'angle_deg': None})

    for i in range(N):
        c = c1.copy()
        c['wmol'] = wmol[i, :]
        c['p'] = P[i]
        c['t'] = T[i]
        c['time'] = time[i]

        TR = TR.merge(golowtran(c))

    #   TR = TR.sort_index(axis=0) # put times in order, sometimes CSV is not monotonic in time.

    return TR


def loopangle(c1: Dict[str, Any]) -> xarray.Dataset:
    """
    loop over "ANGLE"
    """
    angles = np.atleast_1d(c1['angle'])
    TR = xarray.Dataset(coords={'wavelength_nm': None, 'angle_deg': angles})

    for a in angles:
        c = c1.copy()
        c['angle'] = a
        TR = TR.merge(golowtran(c))

    return TR


def golowtran(c1: Dict[str, Any]) -> xarray.Dataset:
    """directly run Fortran code"""
# %% default parameters
    if 'time' not in c1:
        c1['time'] = None

    defp = ('h1', 'h2', 'angle', 'im', 'iseasn', 'ird1', 'range_km', 'zmdl', 'p', 't')
    for p in defp:
        if p not in c1:
            c1[p] = 0

    if 'wmol' not in c1:
        c1['wmol'] = [0]*12
# %% input check
    assert len(c1['wmol']) == 12, 'see Lowtran user manual for 12 values of WMOL'
    assert np.isfinite(c1['h1']), 'per Lowtran user manual Table 14, H1 must always be defined'
# %% setup wavelength
    if 'wlstep' not in c1:
        c1['wlstep'] = 20
    if c1['wlstep'] < 5:
        logging.critical('minimum resolution 5 cm^-1, specified resolution 20 cm^-1')

    wlshort, wllong, nwl = nm2lt7(c1['wlshort'], c1['wllong'], c1['wlstep'])

    if not 0 < wlshort and wllong <= 50000:
        logging.critical('specified model range 0 <= wavelength [cm^-1] <= 50000')
# %% invoke lowtran
    """
    Note we invoke case "3a" from table 14, only observer altitude and apparent
    angle are specified
    """
    Tx, V, Alam, trace, unif, suma, irrad, sumvv = lowtran7.lwtrn7(
        True, nwl, wllong, wlshort, c1['wlstep'],
        c1['model'], c1['itype'], c1['iemsct'], c1['im'],
        c1['iseasn'], c1['ird1'],
        c1['zmdl'], c1['p'], c1['t'], c1['wmol'],
        c1['h1'], c1['h2'], c1['angle'], c1['range_km'])

    dims = ('time', 'wavelength_nm', 'angle_deg')
    TR = xarray.Dataset({'transmission': (dims, Tx[:, 9][None, :, None]),
                         'radiance': (dims, sumvv[None, :, None]),
                         'irradiance': (dims, irrad[:, 0][None, :, None]),
                         'pathscatter': (dims, irrad[:, 2][None, :, None])},
                        coords={'time': [c1['time']],
                                'wavelength_nm': Alam*1e3,
                                'angle_deg': [c1['angle']]})

    return TR

1	from typing import Dict, Any	1✔
2	import logging	1✔
3	import xarray	1✔
4	import numpy as np	1✔
5	from typing import Tuple	1✔
6	try:	1✔
7	import lowtran7 # don't use dot in front, it's linking to .dll, .pyd, or .so	1✔
8	except ImportError as e:
9	raise ImportError(f'you must compile the Fortran code first. f2py -m lowtran7 -c lowtran7.f {e}')
10
11
12	def nm2lt7(short_nm: float, long_nm: float, step_cminv: float=20) -> Tuple[float, float, float]:	1✔
13	"""converts wavelength in nm to cm^-1
14	minimum meaningful step is 20, but 5 is minimum before crashing lowtran
15
16	short: shortest wavelength e.g. 200 nm
17	long: longest wavelength e.g. 30000 nm
18	step: step size in cm^-1 e.g. 20
19
20	output in cm^-1
21	"""
22	short = 1e7 / short_nm	1✔
23	long = 1e7 / long_nm	1✔
24
25	N = int(np.ceil((short-long) / step_cminv)) + 1 # yes, ceil	1✔
26
27	return short, long, N	1✔
28
29
30	def loopuserdef(c1: Dict[str, Any]) -> xarray.DataArray:	1✔
31	"""
32	golowtran() is for scalar parameters only
33	(besides vector of wavelength, which Lowtran internally loops over)
34
35	wmol, p, t must all be vector(s) of same length
36	"""
37
38	wmol = np.atleast_2d(c1['wmol'])	×
39	P = np.atleast_1d(c1['p'])	×
40	T = np.atleast_1d(c1['t'])	×
41	time = np.atleast_1d(c1['time'])	×
42
43	assert wmol.shape[0] == len(P) == len(T) == len(time), 'WMOL, P, T,time must be vectors of equal length'	×
44
45	N = len(P)	×
46	# %% 3-D array indexed by metadata
47	TR = xarray.Dataset(coords={'time': time, 'wavelength_nm': None, 'angle_deg': None})	×
48
49	for i in range(N):	×
50	c = c1.copy()	×
51	c['wmol'] = wmol[i, :]	×
52	c['p'] = P[i]	×
53	c['t'] = T[i]	×
54	c['time'] = time[i]	×
55
56	TR = TR.merge(golowtran(c))	×
57
58	# TR = TR.sort_index(axis=0) # put times in order, sometimes CSV is not monotonic in time.
59
60	return TR	×
61
62
63	def loopangle(c1: Dict[str, Any]) -> xarray.Dataset:	1✔
64	"""
65	loop over "ANGLE"
66	"""
67	angles = np.atleast_1d(c1['angle'])	1✔
68	TR = xarray.Dataset(coords={'wavelength_nm': None, 'angle_deg': angles})	1✔
69
70	for a in angles:	1✔
71	c = c1.copy()	1✔
72	c['angle'] = a	1✔
73	TR = TR.merge(golowtran(c))	1✔
74
75	return TR	1✔
76
77
78	def golowtran(c1: Dict[str, Any]) -> xarray.Dataset:	1✔
79	"""directly run Fortran code"""
80	# %% default parameters
81	if 'time' not in c1:	1✔
82	c1['time'] = None	1✔
83
84	defp = ('h1', 'h2', 'angle', 'im', 'iseasn', 'ird1', 'range_km', 'zmdl', 'p', 't')	1✔
85	for p in defp:	1✔
86	if p not in c1:	1✔
87	c1[p] = 0	1✔
88
89	if 'wmol' not in c1:	1✔
90	c1['wmol'] = [0]*12	1✔
91	# %% input check
92	assert len(c1['wmol']) == 12, 'see Lowtran user manual for 12 values of WMOL'	1✔
93	assert np.isfinite(c1['h1']), 'per Lowtran user manual Table 14, H1 must always be defined'	1✔
94	# %% setup wavelength
95	if 'wlstep' not in c1:	1✔
96	c1['wlstep'] = 20	1✔
97	if c1['wlstep'] < 5:	1✔
98	logging.critical('minimum resolution 5 cm^-1, specified resolution 20 cm^-1')
99
100	wlshort, wllong, nwl = nm2lt7(c1['wlshort'], c1['wllong'], c1['wlstep'])	1✔
101
102	if not 0 < wlshort and wllong <= 50000:	1✔
103	logging.critical('specified model range 0 <= wavelength [cm^-1] <= 50000')
104	# %% invoke lowtran
105	"""
106	Note we invoke case "3a" from table 14, only observer altitude and apparent
107	angle are specified
108	"""
109	Tx, V, Alam, trace, unif, suma, irrad, sumvv = lowtran7.lwtrn7(	1✔
110	True, nwl, wllong, wlshort, c1['wlstep'],
111	c1['model'], c1['itype'], c1['iemsct'], c1['im'],
112	c1['iseasn'], c1['ird1'],
113	c1['zmdl'], c1['p'], c1['t'], c1['wmol'],
114	c1['h1'], c1['h2'], c1['angle'], c1['range_km'])
115
116	dims = ('time', 'wavelength_nm', 'angle_deg')	1✔
117	TR = xarray.Dataset({'transmission': (dims, Tx[:, 9][None, :, None]),	1✔
118	'radiance': (dims, sumvv[None, :, None]),
119	'irradiance': (dims, irrad[:, 0][None, :, None]),
120	'pathscatter': (dims, irrad[:, 2][None, :, None])},
121	coords={'time': [c1['time']],
122	'wavelength_nm': Alam*1e3,
123	'angle_deg': [c1['angle']]})
124
125	return TR	1✔

scivision / lowtran / 233

Source File Press 'n' to go to next uncovered line, 'b' for previous

Source File
Press 'n' to go to next uncovered line, 'b' for previous