Skip to content

Commit 638272f

Browse files
dchaddockdchaddock
committed
updated docs
1 parent 879b6ee commit 638272f

6 files changed

Lines changed: 95 additions & 66 deletions

File tree

‎docs/generated/index.js‎

Lines changed: 1 addition & 1 deletion
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

‎docs/generated/pyucalgarysrs/data/classes.html‎

Lines changed: 12 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -1326,17 +1326,17 @@ <h3>Methods</h3>
13261326
absorption_str = &#34;None&#34; if (self.absorption is None) else &#34;array(dims=%s, dtype=%s)&#34; % (self.absorption.shape, self.absorption.dtype)
13271327

13281328
# set central frequency string
1329-
if (len(self.band_central_frequency) == 0): # pragma: nocover
1329+
if (len(self.band_central_frequency) == 0): # pragma: nocover-ok
13301330
band_central_frequency_str = &#34;[]&#34;
1331-
elif (len(self.band_central_frequency) == 1): # pragma: nocover
1331+
elif (len(self.band_central_frequency) == 1): # pragma: nocover-ok
13321332
band_central_frequency_str = &#34;[1 central frequency]&#34;
13331333
else:
13341334
band_central_frequency_str = &#34;[%d central frequencies]&#34; % (len(self.band_central_frequency))
13351335

13361336
# set passband string
1337-
if (len(self.band_passband) == 0): # pragma: nocover
1337+
if (len(self.band_passband) == 0): # pragma: nocover-ok
13381338
band_passband_str = &#34;[]&#34;
1339-
elif (len(self.band_passband) == 1): # pragma: nocover
1339+
elif (len(self.band_passband) == 1): # pragma: nocover-ok
13401340
band_passband_str = &#34;[1 passband]&#34;
13411341
else:
13421342
band_passband_str = &#34;[%d passbands]&#34; % (len(self.band_passband))
@@ -1360,17 +1360,17 @@ <h3>Methods</h3>
13601360
absorption_str = &#34;None&#34; if (self.absorption is None) else &#34;array(dims=%s, dtype=%s)&#34; % (self.absorption.shape, self.absorption.dtype)
13611361

13621362
# set central frequency string
1363-
if (len(self.band_central_frequency) == 0): # pragma: nocover
1363+
if (len(self.band_central_frequency) == 0): # pragma: nocover-ok
13641364
band_central_frequency_str = &#34;[]&#34;
1365-
elif (len(self.band_central_frequency) == 1): # pragma: nocover
1365+
elif (len(self.band_central_frequency) == 1): # pragma: nocover-ok
13661366
band_central_frequency_str = &#34;[1 central frequency]&#34;
13671367
else:
13681368
band_central_frequency_str = &#34;[%d central frequencies]&#34; % (len(self.band_central_frequency))
13691369

13701370
# set passband string
1371-
if (len(self.band_passband) == 0): # pragma: nocover
1371+
if (len(self.band_passband) == 0): # pragma: nocover-ok
13721372
band_passband_str = &#34;[]&#34;
1373-
elif (len(self.band_passband) == 1): # pragma: nocover
1373+
elif (len(self.band_passband) == 1): # pragma: nocover-ok
13741374
band_passband_str = &#34;[1 passband]&#34;
13751375
else:
13761376
band_passband_str = &#34;[%d passbands]&#34; % (len(self.band_passband))
@@ -1440,17 +1440,17 @@ <h3>Methods</h3>
14401440
absorption_str = &#34;None&#34; if (self.absorption is None) else &#34;array(dims=%s, dtype=%s)&#34; % (self.absorption.shape, self.absorption.dtype)
14411441

14421442
# set central frequency string
1443-
if (len(self.band_central_frequency) == 0): # pragma: nocover
1443+
if (len(self.band_central_frequency) == 0): # pragma: nocover-ok
14441444
band_central_frequency_str = &#34;[]&#34;
1445-
elif (len(self.band_central_frequency) == 1): # pragma: nocover
1445+
elif (len(self.band_central_frequency) == 1): # pragma: nocover-ok
14461446
band_central_frequency_str = &#34;[1 central frequency]&#34;
14471447
else:
14481448
band_central_frequency_str = &#34;[%d central frequencies]&#34; % (len(self.band_central_frequency))
14491449

14501450
# set passband string
1451-
if (len(self.band_passband) == 0): # pragma: nocover
1451+
if (len(self.band_passband) == 0): # pragma: nocover-ok
14521452
band_passband_str = &#34;[]&#34;
1453-
elif (len(self.band_passband) == 1): # pragma: nocover
1453+
elif (len(self.band_passband) == 1): # pragma: nocover-ok
14541454
band_passband_str = &#34;[1 passband]&#34;
14551455
else:
14561456
band_passband_str = &#34;[%d passbands]&#34; % (len(self.band_passband))

‎docs/generated/pyucalgarysrs/data/read/index.html‎

Lines changed: 12 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -857,10 +857,10 @@ <h2 class="section-title" id="header-classes">Classes</h2>
857857
timestamp_list.append(datetime.datetime.strptime(m[&#34;image_request_start_timestamp&#34;], &#34;%Y-%m-%d %H:%M:%S.%f UTC&#34;))
858858
elif (&#34;Image request start&#34; in m):
859859
timestamp_list.append(datetime.datetime.strptime(m[&#34;Image request start&#34;], &#34;%Y-%m-%d %H:%M:%S.%f UTC&#34;))
860-
elif (m == {}): # pragma: nocover
860+
elif (m == {}): # pragma: nocover-ok
861861
# a problematic file, skip it
862862
pass
863-
else: # pragma: nocover
863+
else: # pragma: nocover-ok
864864
raise SRSError(&#34;Unexpected timestamp metadata format&#34;)
865865

866866
# convert to return type
@@ -987,7 +987,7 @@ <h2 class="section-title" id="header-classes">Classes</h2>
987987
timestamp_list = []
988988
if (no_metadata is False):
989989
timestamp_list = timestamp_np.tolist()
990-
else: # pragma: nocover
990+
else: # pragma: nocover-ok
991991
raise SRSUnsupportedReadError(&#34;Unexpected Spectrograph file format&#34;)
992992

993993
# convert to return type
@@ -1091,10 +1091,10 @@ <h2 class="section-title" id="header-classes">Classes</h2>
10911091
for m in meta:
10921092
if (&#34;image_request_start&#34; in m):
10931093
timestamp_list.append(datetime.datetime.strptime(m[&#34;image_request_start&#34;], &#34;%Y-%m-%d %H:%M:%S.%f UTC&#34;))
1094-
elif (m == {}): # pragma: nocover
1094+
elif (m == {}): # pragma: nocover-ok
10951095
# a problematic file, skip it
10961096
pass
1097-
else: # pragma: nocover
1097+
else: # pragma: nocover-ok
10981098
raise SRSError(&#34;Unexpected timestamp metadata format&#34;)
10991099

11001100
# convert to return type
@@ -1215,7 +1215,7 @@ <h2 class="section-title" id="header-classes">Classes</h2>
12151215
#
12161216
# NOTE: bytscl_values was not present in early THEMIS skymap files, so
12171217
# we conditionally add it
1218-
if (&#34;bytscl_values&#34; in item_recarray.generation_info[0].dtype.names): # pragma: nocover
1218+
if (&#34;bytscl_values&#34; in item_recarray.generation_info[0].dtype.names): # pragma: nocover-ok
12191219
generation_info_obj.bytscl_values = item_recarray.generation_info[0].bytscl_values
12201220

12211221
# flip certain things
@@ -2811,7 +2811,7 @@ <h2 id="raises">Raises</h2>
28112811
#
28122812
# NOTE: bytscl_values was not present in early THEMIS skymap files, so
28132813
# we conditionally add it
2814-
if (&#34;bytscl_values&#34; in item_recarray.generation_info[0].dtype.names): # pragma: nocover
2814+
if (&#34;bytscl_values&#34; in item_recarray.generation_info[0].dtype.names): # pragma: nocover-ok
28152815
generation_info_obj.bytscl_values = item_recarray.generation_info[0].bytscl_values
28162816

28172817
# flip certain things
@@ -2996,10 +2996,10 @@ <h2 id="raises">Raises</h2>
29962996
for m in meta:
29972997
if (&#34;image_request_start&#34; in m):
29982998
timestamp_list.append(datetime.datetime.strptime(m[&#34;image_request_start&#34;], &#34;%Y-%m-%d %H:%M:%S.%f UTC&#34;))
2999-
elif (m == {}): # pragma: nocover
2999+
elif (m == {}): # pragma: nocover-ok
30003000
# a problematic file, skip it
30013001
pass
3002-
else: # pragma: nocover
3002+
else: # pragma: nocover-ok
30033003
raise SRSError(&#34;Unexpected timestamp metadata format&#34;)
30043004

30053005
# convert to return type
@@ -3795,10 +3795,10 @@ <h2 id="raises">Raises</h2>
37953795
timestamp_list.append(datetime.datetime.strptime(m[&#34;image_request_start_timestamp&#34;], &#34;%Y-%m-%d %H:%M:%S.%f UTC&#34;))
37963796
elif (&#34;Image request start&#34; in m):
37973797
timestamp_list.append(datetime.datetime.strptime(m[&#34;Image request start&#34;], &#34;%Y-%m-%d %H:%M:%S.%f UTC&#34;))
3798-
elif (m == {}): # pragma: nocover
3798+
elif (m == {}): # pragma: nocover-ok
37993799
# a problematic file, skip it
38003800
pass
3801-
else: # pragma: nocover
3801+
else: # pragma: nocover-ok
38023802
raise SRSError(&#34;Unexpected timestamp metadata format&#34;)
38033803

38043804
# convert to return type
@@ -3986,7 +3986,7 @@ <h2 id="raises">Raises</h2>
39863986
timestamp_list = []
39873987
if (no_metadata is False):
39883988
timestamp_list = timestamp_np.tolist()
3989-
else: # pragma: nocover
3989+
else: # pragma: nocover-ok
39903990
raise SRSUnsupportedReadError(&#34;Unexpected Spectrograph file format&#34;)
39913991

39923992
# convert to return type

‎docs/generated/pyucalgarysrs/models/atm/classes_forward.html‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -719,7 +719,7 @@ <h3>Instance variables</h3>
719719
continue
720720

721721
# exclude based on version
722-
if (self.request_info.request.atm_model_version == &#34;1.0&#34; and &#34;production_rate_&#34; in var_name):
722+
if (self.request_info.request.atm_model_version == &#34;1.0&#34; and &#34;production_rate_&#34; in var_name): # pragma: nocover-ok
723723
continue
724724

725725
# convert var to string format we want
@@ -997,7 +997,7 @@ <h3>Methods</h3>
997997
continue
998998

999999
# exclude based on version
1000-
if (self.request_info.request.atm_model_version == &#34;1.0&#34; and &#34;production_rate_&#34; in var_name):
1000+
if (self.request_info.request.atm_model_version == &#34;1.0&#34; and &#34;production_rate_&#34; in var_name): # pragma: nocover-ok
10011001
continue
10021002

10031003
# convert var to string format we want

0 commit comments

Comments
 (0)