SimbioReader 0.1.8__tar.gz → 0.2.1__tar.gz

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (36) hide show
  1. simbioreader-0.2.1/PKG-INFO +215 -0
  2. simbioreader-0.2.1/README.md +193 -0
  3. {simbioreader-0.1.8 → simbioreader-0.2.1}/pyproject.toml +5 -4
  4. simbioreader-0.2.1/src/SimbioReader/__init__.py +2 -0
  5. simbioreader-0.2.1/src/SimbioReader/__main__.py +800 -0
  6. {simbioreader-0.1.8 → simbioreader-0.2.1}/src/SimbioReader/constants.py +11 -2
  7. {simbioreader-0.1.8 → simbioreader-0.2.1}/src/SimbioReader/filters.py +1 -13
  8. simbioreader-0.2.1/src/SimbioReader/filters_tools.py +66 -0
  9. simbioreader-0.2.1/src/SimbioReader/infocli.py +152 -0
  10. simbioreader-0.2.1/src/SimbioReader/phases.py +21 -0
  11. simbioreader-0.2.1/src/SimbioReader/simbioInfo.py +596 -0
  12. simbioreader-0.2.1/src/SimbioReader/subphases.py +121 -0
  13. simbioreader-0.2.1/src/SimbioReader/tests.py +567 -0
  14. simbioreader-0.2.1/src/SimbioReader/tools.py +85 -0
  15. {simbioreader-0.1.8 → simbioreader-0.2.1}/src/SimbioReader/version.py +1 -1
  16. simbioreader-0.2.1/src/SimbioReader.egg-info/PKG-INFO +215 -0
  17. {simbioreader-0.1.8 → simbioreader-0.2.1}/src/SimbioReader.egg-info/SOURCES.txt +8 -5
  18. simbioreader-0.2.1/src/SimbioReader.egg-info/entry_points.txt +3 -0
  19. {simbioreader-0.1.8 → simbioreader-0.2.1}/src/SimbioReader.egg-info/requires.txt +1 -0
  20. {simbioreader-0.1.8 → simbioreader-0.2.1}/src/SimbioReader.egg-info/top_level.txt +0 -1
  21. simbioreader-0.2.1/test/test_db.py +60 -0
  22. simbioreader-0.1.8/PKG-INFO +0 -62
  23. simbioreader-0.1.8/README.md +0 -41
  24. simbioreader-0.1.8/src/SimbioReader/__init__.py +0 -1
  25. simbioreader-0.1.8/src/SimbioReader/console.py +0 -3
  26. simbioreader-0.1.8/src/SimbioReader/externals.py +0 -24
  27. simbioreader-0.1.8/src/SimbioReader/phases.py +0 -123
  28. simbioreader-0.1.8/src/SimbioReader/simbioreader.py +0 -367
  29. simbioreader-0.1.8/src/SimbioReader/tools.py +0 -35
  30. simbioreader-0.1.8/src/SimbioReader.egg-info/PKG-INFO +0 -62
  31. simbioreader-0.1.8/src/SimbioReader.egg-info/entry_points.txt +0 -4
  32. simbioreader-0.1.8/src/test.py +0 -9
  33. {simbioreader-0.1.8 → simbioreader-0.2.1}/LICENSE +0 -0
  34. {simbioreader-0.1.8 → simbioreader-0.2.1}/setup.cfg +0 -0
  35. {simbioreader-0.1.8 → simbioreader-0.2.1}/src/SimbioReader/exceptions.py +0 -0
  36. {simbioreader-0.1.8 → simbioreader-0.2.1}/src/SimbioReader.egg-info/dependency_links.txt +0 -0
@@ -0,0 +1,215 @@
1
+ Metadata-Version: 2.1
2
+ Name: SimbioReader
3
+ Version: 0.2.1
4
+ Summary: Python Reader for the data from SIMBIO-SYS instrument suite on-board the ESA mission BepiColombo
5
+ Author-email: Romolo Politi <Romolo.Politi@inaf.it>
6
+ License: GNU GPL ver3
7
+ Project-URL: Repository, https://github.com/SIMBIO-SYS/SimbioReader
8
+ Keywords: data reader,Space Mission,BepiColombo,SIMBIO-SYS
9
+ Classifier: Development Status :: 2 - Pre-Alpha
10
+ Classifier: License :: OSI Approved :: GNU General Public License v3 (GPLv3)
11
+ Description-Content-Type: text/markdown
12
+ License-File: LICENSE
13
+ Requires-Dist: numpy
14
+ Requires-Dist: pandas
15
+ Requires-Dist: rich
16
+ Requires-Dist: rich_click
17
+ Requires-Dist: update_checker
18
+ Requires-Dist: pillow
19
+ Requires-Dist: importlib-metadata; python_version > "3.10"
20
+ Provides-Extra: docs
21
+ Requires-Dist: sphinx; extra == "docs"
22
+
23
+ ![Version 0.2.1](https://img.shields.io/badge/version-0.2.1-blue?style=plastic)
24
+ ![Language Python 3.12](https://img.shields.io/badge/python-3.12-orange?style=plastic&logo=python)
25
+ ![BepiColombo SIMBIO-SYS](https://img.shields.io/badge/BepiColombo-SIMBIO--SYS-blue?style=plastic)
26
+ [![Upload Python Package](https://github.com/SIMBIO-SYS/SimbioReader/actions/workflows/python-publish.yml/badge.svg)](https://github.com/SIMBIO-SYS/SimbioReader/actions/workflows/python-publish.yml)
27
+ [![SimbioReader Test](https://github.com/SIMBIO-SYS/SimbioReader/actions/workflows/test.yml/badge.svg)](https://github.com/SIMBIO-SYS/SimbioReader/actions/workflows/test.yml)
28
+
29
+ # SimbioReader
30
+
31
+
32
+ SimbioReader is the official Python reader for the data of the Spectrometer And Imagers For Mpo Bepicolombo Integrated Observatory System on board the ESA mission BepiColombo.
33
+
34
+ For more information about SIMBIO-SYS you can visit the official [ESA SIMBIO-SYS webpage](https://www.cosmos.esa.int/web/bepicolombo/simbio-sys)
35
+
36
+ ## Installation
37
+
38
+ To install the reader you can use the command:
39
+
40
+ ```console
41
+ $ python3 -m pip install SimbioReader
42
+ ```
43
+
44
+ ## Usage
45
+
46
+ The package contain a class that read and decode the SIMBIO-SYS image
47
+
48
+ ```python
49
+ from SimbioReader import SimbioReader as SR
50
+
51
+ dat = SimbioReader("sim_raw_sc_vihi_internal_cruise_ico4_2020-12-14_001.dat")
52
+ ```
53
+
54
+ ## Command line tools
55
+
56
+ In the package are included two command line tools:
57
+
58
+ + **simbioReader** show the info of a specific SIMBIO-SYS data product;
59
+ + **simbioInfo** show the information about phases, subphases and test of SIMBIO-SYS;
60
+
61
+ ### simbioReader
62
+
63
+ ```console
64
+ simbioReader sim_raw_sc_vihi_internal_cruise_ico6_2021-11-22_001.dat
65
+ ```
66
+
67
+ will show the main information about the product.
68
+
69
+ Are avalaible some options:
70
+
71
+ - **--all** will display all the avilable information
72
+ - **--hk** wil display also the housekeeping
73
+ - **--detector** will display all the detector information
74
+ - **--data-structure** will display the data structure of the file
75
+ - **--filter** will display the information about the used filter if the data come from HRIC or STC, otherwise the option will be ignored
76
+
77
+ For any details you can use the option **--help**.
78
+
79
+ Using the option **--version** will be shown the software version and the datamodel version implemented in it.
80
+
81
+ ### simbioInfo
82
+
83
+ ***simbioInfo*** tool is a command line interface (cli) wiith three subcommands:
84
+
85
+ - **filters** Show the definition of filter(s) of a specific channel
86
+ - **phases** Show the past mission phase(s);
87
+ - **subphases** Show the past mission subphase(s);
88
+ - **tests** Show the past SIMBIO-SYS performed test(s)
89
+
90
+ #### filters
91
+
92
+ The subcommand **filter** has an argument, the channel and an option ***--name***.
93
+
94
+ If the user provides only the channel, all the filters specific to that channel will be shown.
95
+ If the user adds the -name option, only the selected filter will be displayed, if found.
96
+
97
+ A description of argument and options coul be required using the option ***--help***
98
+
99
+ ##### Examples
100
+
101
+ ```console
102
+ simbioInfo filters hric
103
+ ```
104
+
105
+ will show all the filters of the channel HRIC
106
+
107
+ ```console
108
+ simbioInfo flters hric -n pan-l
109
+ ```
110
+
111
+ will show the *HRIC* filter with the name *PAN-L*
112
+
113
+
114
+
115
+ #### phases
116
+
117
+ The subcommand **phases** will display a table of all or filtered past mission phases.
118
+
119
+ The options are:
120
+
121
+ - **--all** Show all the past mission phases;
122
+ - **--date** Show all the phases for the given date;
123
+ - **--name** Show the phase with the given name.
124
+
125
+ ##### Examples
126
+
127
+ ```console
128
+ simbioInfo phases --all
129
+ ```
130
+ will show all the past mission phases.
131
+
132
+
133
+ ```console
134
+ simbioInfo phases --date 2024-04-08
135
+ ```
136
+
137
+ will show the phase that include the day *2024-04-08*
138
+
139
+ ```console
140
+ simbioInfo phases --name necp
141
+ ```
142
+ will show the phase with the name *necp*
143
+
144
+ #### subphases
145
+
146
+ The subcommand **subphases** will display a table of all or filtered past mission subphases.
147
+
148
+ The options are:
149
+
150
+ - **--all** Show all the past mission subphases;
151
+ - **--date** Show all the subphases for the given date;
152
+ - **--name** Show the subphase with the given name.
153
+
154
+ ##### Examples
155
+
156
+ ```console
157
+ simbioInfo subphases --all
158
+ ```
159
+ will show all the past mission subphases.
160
+
161
+ ```console
162
+ simbioInfo subphases --date 2024-04-08
163
+ ```
164
+
165
+ will show the subphase that include the day *2024-04-08*, the **ico11**.
166
+
167
+ ```console
168
+ simbioInfo subphases --name ico9
169
+ ```
170
+ will show the phase with the name *ico9*
171
+
172
+ #### tests
173
+
174
+ The subcommand **tests** will display a table of all or filtered SIMBIO-SYS tests.
175
+
176
+ The options are:
177
+
178
+ - **--all** Show all the past SIMBIO-SYS tests;
179
+ - **--date** Show all the SIMBIO-SYS tests for the given date;
180
+ - **--name** Show the SIMBIO-SYS tests with the given name;
181
+ - **--phase** Show the SIMBIO-SYS tests for the specific phase;
182
+ - **--subphase** Show the SIMBIO-SYS tests for the specific subphase.
183
+
184
+ > [!NOTE]
185
+ > The tests name are not unique. Please use the option **--subphase** togeter the option **--name**
186
+
187
+ ##### Examples
188
+
189
+ ```console
190
+ simbioInfo tests --all
191
+ ```
192
+
193
+ will show all the SIMBIO-SYS tests.
194
+
195
+ ```console
196
+ simbioInfo tests -d 2024-04-08\ 2:00:00
197
+ ````
198
+
199
+ will show the test that SIMBIO-SYS was performing at 2:00:00 on 2024-04-08, the *Interference Test* in the subphase *ico11*
200
+
201
+ ```console
202
+ simbioInfo tests --name hric\ functional --subphase ico9
203
+ ```
204
+ will show the test with the name that contain the string *hric functional* performed during the subphase *ico9*
205
+
206
+
207
+ ## Class Description
208
+
209
+ ### Methods
210
+
211
+ + **Show()** display the main information related to the data file
212
+
213
+ ```python
214
+ dat.Show()
215
+ ```
@@ -0,0 +1,193 @@
1
+ ![Version 0.2.1](https://img.shields.io/badge/version-0.2.1-blue?style=plastic)
2
+ ![Language Python 3.12](https://img.shields.io/badge/python-3.12-orange?style=plastic&logo=python)
3
+ ![BepiColombo SIMBIO-SYS](https://img.shields.io/badge/BepiColombo-SIMBIO--SYS-blue?style=plastic)
4
+ [![Upload Python Package](https://github.com/SIMBIO-SYS/SimbioReader/actions/workflows/python-publish.yml/badge.svg)](https://github.com/SIMBIO-SYS/SimbioReader/actions/workflows/python-publish.yml)
5
+ [![SimbioReader Test](https://github.com/SIMBIO-SYS/SimbioReader/actions/workflows/test.yml/badge.svg)](https://github.com/SIMBIO-SYS/SimbioReader/actions/workflows/test.yml)
6
+
7
+ # SimbioReader
8
+
9
+
10
+ SimbioReader is the official Python reader for the data of the Spectrometer And Imagers For Mpo Bepicolombo Integrated Observatory System on board the ESA mission BepiColombo.
11
+
12
+ For more information about SIMBIO-SYS you can visit the official [ESA SIMBIO-SYS webpage](https://www.cosmos.esa.int/web/bepicolombo/simbio-sys)
13
+
14
+ ## Installation
15
+
16
+ To install the reader you can use the command:
17
+
18
+ ```console
19
+ $ python3 -m pip install SimbioReader
20
+ ```
21
+
22
+ ## Usage
23
+
24
+ The package contain a class that read and decode the SIMBIO-SYS image
25
+
26
+ ```python
27
+ from SimbioReader import SimbioReader as SR
28
+
29
+ dat = SimbioReader("sim_raw_sc_vihi_internal_cruise_ico4_2020-12-14_001.dat")
30
+ ```
31
+
32
+ ## Command line tools
33
+
34
+ In the package are included two command line tools:
35
+
36
+ + **simbioReader** show the info of a specific SIMBIO-SYS data product;
37
+ + **simbioInfo** show the information about phases, subphases and test of SIMBIO-SYS;
38
+
39
+ ### simbioReader
40
+
41
+ ```console
42
+ simbioReader sim_raw_sc_vihi_internal_cruise_ico6_2021-11-22_001.dat
43
+ ```
44
+
45
+ will show the main information about the product.
46
+
47
+ Are avalaible some options:
48
+
49
+ - **--all** will display all the avilable information
50
+ - **--hk** wil display also the housekeeping
51
+ - **--detector** will display all the detector information
52
+ - **--data-structure** will display the data structure of the file
53
+ - **--filter** will display the information about the used filter if the data come from HRIC or STC, otherwise the option will be ignored
54
+
55
+ For any details you can use the option **--help**.
56
+
57
+ Using the option **--version** will be shown the software version and the datamodel version implemented in it.
58
+
59
+ ### simbioInfo
60
+
61
+ ***simbioInfo*** tool is a command line interface (cli) wiith three subcommands:
62
+
63
+ - **filters** Show the definition of filter(s) of a specific channel
64
+ - **phases** Show the past mission phase(s);
65
+ - **subphases** Show the past mission subphase(s);
66
+ - **tests** Show the past SIMBIO-SYS performed test(s)
67
+
68
+ #### filters
69
+
70
+ The subcommand **filter** has an argument, the channel and an option ***--name***.
71
+
72
+ If the user provides only the channel, all the filters specific to that channel will be shown.
73
+ If the user adds the -name option, only the selected filter will be displayed, if found.
74
+
75
+ A description of argument and options coul be required using the option ***--help***
76
+
77
+ ##### Examples
78
+
79
+ ```console
80
+ simbioInfo filters hric
81
+ ```
82
+
83
+ will show all the filters of the channel HRIC
84
+
85
+ ```console
86
+ simbioInfo flters hric -n pan-l
87
+ ```
88
+
89
+ will show the *HRIC* filter with the name *PAN-L*
90
+
91
+
92
+
93
+ #### phases
94
+
95
+ The subcommand **phases** will display a table of all or filtered past mission phases.
96
+
97
+ The options are:
98
+
99
+ - **--all** Show all the past mission phases;
100
+ - **--date** Show all the phases for the given date;
101
+ - **--name** Show the phase with the given name.
102
+
103
+ ##### Examples
104
+
105
+ ```console
106
+ simbioInfo phases --all
107
+ ```
108
+ will show all the past mission phases.
109
+
110
+
111
+ ```console
112
+ simbioInfo phases --date 2024-04-08
113
+ ```
114
+
115
+ will show the phase that include the day *2024-04-08*
116
+
117
+ ```console
118
+ simbioInfo phases --name necp
119
+ ```
120
+ will show the phase with the name *necp*
121
+
122
+ #### subphases
123
+
124
+ The subcommand **subphases** will display a table of all or filtered past mission subphases.
125
+
126
+ The options are:
127
+
128
+ - **--all** Show all the past mission subphases;
129
+ - **--date** Show all the subphases for the given date;
130
+ - **--name** Show the subphase with the given name.
131
+
132
+ ##### Examples
133
+
134
+ ```console
135
+ simbioInfo subphases --all
136
+ ```
137
+ will show all the past mission subphases.
138
+
139
+ ```console
140
+ simbioInfo subphases --date 2024-04-08
141
+ ```
142
+
143
+ will show the subphase that include the day *2024-04-08*, the **ico11**.
144
+
145
+ ```console
146
+ simbioInfo subphases --name ico9
147
+ ```
148
+ will show the phase with the name *ico9*
149
+
150
+ #### tests
151
+
152
+ The subcommand **tests** will display a table of all or filtered SIMBIO-SYS tests.
153
+
154
+ The options are:
155
+
156
+ - **--all** Show all the past SIMBIO-SYS tests;
157
+ - **--date** Show all the SIMBIO-SYS tests for the given date;
158
+ - **--name** Show the SIMBIO-SYS tests with the given name;
159
+ - **--phase** Show the SIMBIO-SYS tests for the specific phase;
160
+ - **--subphase** Show the SIMBIO-SYS tests for the specific subphase.
161
+
162
+ > [!NOTE]
163
+ > The tests name are not unique. Please use the option **--subphase** togeter the option **--name**
164
+
165
+ ##### Examples
166
+
167
+ ```console
168
+ simbioInfo tests --all
169
+ ```
170
+
171
+ will show all the SIMBIO-SYS tests.
172
+
173
+ ```console
174
+ simbioInfo tests -d 2024-04-08\ 2:00:00
175
+ ````
176
+
177
+ will show the test that SIMBIO-SYS was performing at 2:00:00 on 2024-04-08, the *Interference Test* in the subphase *ico11*
178
+
179
+ ```console
180
+ simbioInfo tests --name hric\ functional --subphase ico9
181
+ ```
182
+ will show the test with the name that contain the string *hric functional* performed during the subphase *ico9*
183
+
184
+
185
+ ## Class Description
186
+
187
+ ### Methods
188
+
189
+ + **Show()** display the main information related to the data file
190
+
191
+ ```python
192
+ dat.Show()
193
+ ```
@@ -1,11 +1,12 @@
1
1
  [project]
2
2
  name = "SimbioReader"
3
- version = "0.1.8"
3
+ version = "0.2.1"
4
4
  description="Python Reader for the data from SIMBIO-SYS instrument suite on-board the ESA mission BepiColombo"
5
5
  dependencies = [
6
6
  "numpy",
7
7
  "pandas",
8
8
  "rich",
9
+ "rich_click",
9
10
  "update_checker",
10
11
  "pillow",
11
12
  'importlib-metadata; python_version>"3.10"',
@@ -28,9 +29,9 @@ Repository = "https://github.com/SIMBIO-SYS/SimbioReader"
28
29
  docs = ["sphinx"]
29
30
 
30
31
  [project.scripts]
31
- simbioPhases = "SimbioReader.externals:simbioPhases"
32
- hricFilters = "SimbioReader.externals:hricFilters"
33
- stcFilters = "SimbioReader.externals:stcFilters"
32
+ simbioReader = "SimbioReader.__main__:cli"
33
+ simbioInfo = "SimbioReader.infocli:cli"
34
+
34
35
 
35
36
  [build-system]
36
37
  requires = ["setuptools"]
@@ -0,0 +1,2 @@
1
+ from SimbioReader.__main__ import SimbioReader, DataStructure, SubFrame, Detector, HK
2
+ from SimbioReader.__main__ import __version__