Skip to content

Commit 446ff28

Browse files
authored
1822 hi restructure hi modules (#1823)
* Flatten hi directory structure * Move functions from science_direct_events.py into hi_l1a.py * Move functions from histogram.py into hi_l1a.py * fix documentation build and missed test failures
1 parent 736a4a7 commit 446ff28

File tree

20 files changed

+581
-599
lines changed

20 files changed

+581
-599
lines changed

docs/source/code-documentation/hi.rst

Lines changed: 9 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -7,25 +7,27 @@ IMAP-Hi
77

88
This is the IMAP-Hi instrument module, which contains the code for processing data from the IMAP-Hi instrument.
99

10-
The processing code is divided into several submodules, each of which is
10+
The processing code is divided into several modules, each of which is
1111
used to process different level of data.
1212

13-
Level 1A Processing code.
13+
Hi Processing code by level of product it produces.
1414

1515
.. autosummary::
1616
:toctree: generated/
1717
:template: autosummary.rst
1818
:recursive:
1919

20-
l1a.hi_l1a
21-
l1a.histogram
22-
l1a.science_direct_event
20+
hi_l1a
21+
hi_l1b
22+
hi_l1c
23+
hi_l2
2324

24-
Level 1B Processing code.
25+
The modules below contain various utility classes and functions to support L0
26+
and L1a processing:
2527

2628
.. autosummary::
2729
:toctree: generated/
2830
:template: autosummary.rst
2931
:recursive:
3032

31-
l1b.hi_l1b
33+
utils

docs/source/conf.py

Lines changed: 4 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -105,10 +105,12 @@
105105
(r"py:.*", r".*IntEnum.*"),
106106
(r"py:.*", r".*space_packet_parser.*"),
107107
(r"py:.*", r".*CoDICECompression.*"),
108+
(r"py:.*", r".*RectangularSkyMap.*"),
108109
(r"py:.*", r".*.lo.l0.utils.*"),
109110
(r"py:.*", r".*.lo.l0.data_classes.*"),
110-
(r"py:.*", r".*.hi.l1b.hi_l1b.CoincidenceBitmap.*"),
111-
(r"py:.*", r".*.hi.l1b.hi_l1b.TriggerId.*"),
111+
(r"py:.*", r".*.hi.*.CoincidenceBitmap.*"),
112+
(r"py:.*", r".*.hi.hi_l1b.TriggerId.*"),
113+
(r"py:.*", r".*.hi.hi_l1c.CalibrationProductConfig.*"),
112114
(r"py:.*", r".*.hit.l0.utils.*"),
113115
(r"py:.*", r".*.hit.l0.data_classes.*"),
114116
(r"py:.*", r".*.hit.l1a.*"),

imap_processing/cli.py

Lines changed: 1 addition & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -51,10 +51,7 @@
5151
from imap_processing.glows.l1a.glows_l1a import glows_l1a
5252
from imap_processing.glows.l1b.glows_l1b import glows_l1b
5353
from imap_processing.glows.l2.glows_l2 import glows_l2
54-
from imap_processing.hi.l1a import hi_l1a
55-
from imap_processing.hi.l1b import hi_l1b
56-
from imap_processing.hi.l1c import hi_l1c
57-
from imap_processing.hi.l2 import hi_l2
54+
from imap_processing.hi import hi_l1a, hi_l1b, hi_l1c, hi_l2
5855
from imap_processing.hit.l1a.hit_l1a import hit_l1a
5956
from imap_processing.hit.l1b.hit_l1b import hit_l1b
6057
from imap_processing.hit.l2.hit_l2 import hit_l2

0 commit comments

Comments
 (0)