edview 1.0.0__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.
edview-1.0.0/LICENSE ADDED
@@ -0,0 +1,201 @@
1
+ Apache License
2
+ Version 2.0, January 2004
3
+ http://www.apache.org/licenses/
4
+
5
+ TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
6
+
7
+ 1. Definitions.
8
+
9
+ "License" shall mean the terms and conditions for use, reproduction,
10
+ and distribution as defined by Sections 1 through 9 of this document.
11
+
12
+ "Licensor" shall mean the copyright owner or entity authorized by
13
+ the copyright owner that is granting the License.
14
+
15
+ "Legal Entity" shall mean the union of the acting entity and all
16
+ other entities that control, are controlled by, or are under common
17
+ control with that entity. For the purposes of this definition,
18
+ "control" means (i) the power, direct or indirect, to cause the
19
+ direction or management of such entity, whether by contract or
20
+ otherwise, or (ii) ownership of fifty percent (50%) or more of the
21
+ outstanding shares, or (iii) beneficial ownership of such entity.
22
+
23
+ "You" (or "Your") shall mean an individual or Legal Entity
24
+ exercising permissions granted by this License.
25
+
26
+ "Source" form shall mean the preferred form for making modifications,
27
+ including but not limited to software source code, documentation
28
+ source, and configuration files.
29
+
30
+ "Object" form shall mean any form resulting from mechanical
31
+ transformation or translation of a Source form, including but
32
+ not limited to compiled object code, generated documentation,
33
+ and conversions to other media types.
34
+
35
+ "Work" shall mean the work of authorship, whether in Source or
36
+ Object form, made available under the License, as indicated by a
37
+ copyright notice that is included in or attached to the work
38
+ (an example is provided in the Appendix below).
39
+
40
+ "Derivative Works" shall mean any work, whether in Source or Object
41
+ form, that is based on (or derived from) the Work and for which the
42
+ editorial revisions, annotations, elaborations, or other modifications
43
+ represent, as a whole, an original work of authorship. For the purposes
44
+ of this License, Derivative Works shall not include works that remain
45
+ separable from, or merely link (or bind by name) to the interfaces of,
46
+ the Work and Derivative Works thereof.
47
+
48
+ "Contribution" shall mean any work of authorship, including
49
+ the original version of the Work and any modifications or additions
50
+ to that Work or Derivative Works thereof, that is intentionally
51
+ submitted to Licensor for inclusion in the Work by the copyright owner
52
+ or by an individual or Legal Entity authorized to submit on behalf of
53
+ the copyright owner. For the purposes of this definition, "submitted"
54
+ means any form of electronic, verbal, or written communication sent
55
+ to the Licensor or its representatives, including but not limited to
56
+ communication on electronic mailing lists, source code control systems,
57
+ and issue tracking systems that are managed by, or on behalf of, the
58
+ Licensor for the purpose of discussing and improving the Work, but
59
+ excluding communication that is conspicuously marked or otherwise
60
+ designated in writing by the copyright owner as "Not a Contribution."
61
+
62
+ "Contributor" shall mean Licensor and any individual or Legal Entity
63
+ on behalf of whom a Contribution has been received by Licensor and
64
+ subsequently incorporated within the Work.
65
+
66
+ 2. Grant of Copyright License. Subject to the terms and conditions of
67
+ this License, each Contributor hereby grants to You a perpetual,
68
+ worldwide, non-exclusive, no-charge, royalty-free, irrevocable
69
+ copyright license to reproduce, prepare Derivative Works of,
70
+ publicly display, publicly perform, sublicense, and distribute the
71
+ Work and such Derivative Works in Source or Object form.
72
+
73
+ 3. Grant of Patent License. Subject to the terms and conditions of
74
+ this License, each Contributor hereby grants to You a perpetual,
75
+ worldwide, non-exclusive, no-charge, royalty-free, irrevocable
76
+ (except as stated in this section) patent license to make, have made,
77
+ use, offer to sell, sell, import, and otherwise transfer the Work,
78
+ where such license applies only to those patent claims licensable
79
+ by such Contributor that are necessarily infringed by their
80
+ Contribution(s) alone or by combination of their Contribution(s)
81
+ with the Work to which such Contribution(s) was submitted. If You
82
+ institute patent litigation against any entity (including a
83
+ cross-claim or counterclaim in a lawsuit) alleging that the Work
84
+ or a Contribution incorporated within the Work constitutes direct
85
+ or contributory patent infringement, then any patent licenses
86
+ granted to You under this License for that Work shall terminate
87
+ as of the date such litigation is filed.
88
+
89
+ 4. Redistribution. You may reproduce and distribute copies of the
90
+ Work or Derivative Works thereof in any medium, with or without
91
+ modifications, and in Source or Object form, provided that You
92
+ meet the following conditions:
93
+
94
+ (a) You must give any other recipients of the Work or
95
+ Derivative Works a copy of this License; and
96
+
97
+ (b) You must cause any modified files to carry prominent notices
98
+ stating that You changed the files; and
99
+
100
+ (c) You must retain, in the Source form of any Derivative Works
101
+ that You distribute, all copyright, patent, trademark, and
102
+ attribution notices from the Source form of the Work,
103
+ excluding those notices that do not pertain to any part of
104
+ the Derivative Works; and
105
+
106
+ (d) If the Work includes a "NOTICE" text file as part of its
107
+ distribution, then any Derivative Works that You distribute must
108
+ include a readable copy of the attribution notices contained
109
+ within such NOTICE file, excluding those notices that do not
110
+ pertain to any part of the Derivative Works, in at least one
111
+ of the following places: within a NOTICE text file distributed
112
+ as part of the Derivative Works; within the Source form or
113
+ documentation, if provided along with the Derivative Works; or,
114
+ within a display generated by the Derivative Works, if and
115
+ wherever such third-party notices normally appear. The contents
116
+ of the NOTICE file are for informational purposes only and
117
+ do not modify the License. You may add Your own attribution
118
+ notices within Derivative Works that You distribute, alongside
119
+ or as an addendum to the NOTICE text from the Work, provided
120
+ that such additional attribution notices cannot be construed
121
+ as modifying the License.
122
+
123
+ You may add Your own copyright statement to Your modifications and
124
+ may provide additional or different license terms and conditions
125
+ for use, reproduction, or distribution of Your modifications, or
126
+ for any such Derivative Works as a whole, provided Your use,
127
+ reproduction, and distribution of the Work otherwise complies with
128
+ the conditions stated in this License.
129
+
130
+ 5. Submission of Contributions. Unless You explicitly state otherwise,
131
+ any Contribution intentionally submitted for inclusion in the Work
132
+ by You to the Licensor shall be under the terms and conditions of
133
+ this License, without any additional terms or conditions.
134
+ Notwithstanding the above, nothing herein shall supersede or modify
135
+ the terms of any separate license agreement you may have executed
136
+ with Licensor regarding such Contributions.
137
+
138
+ 6. Trademarks. This License does not grant permission to use the trade
139
+ names, trademarks, service marks, or product names of the Licensor,
140
+ except as required for reasonable and customary use in describing the
141
+ origin of the Work and reproducing the content of the NOTICE file.
142
+
143
+ 7. Disclaimer of Warranty. Unless required by applicable law or
144
+ agreed to in writing, Licensor provides the Work (and each
145
+ Contributor provides its Contributions) on an "AS IS" BASIS,
146
+ WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
147
+ implied, including, without limitation, any warranties or conditions
148
+ of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
149
+ PARTICULAR PURPOSE. You are solely responsible for determining the
150
+ appropriateness of using or redistributing the Work and assume any
151
+ risks associated with Your exercise of permissions under this License.
152
+
153
+ 8. Limitation of Liability. In no event and under no legal theory,
154
+ whether in tort (including negligence), contract, or otherwise,
155
+ unless required by applicable law (such as deliberate and grossly
156
+ negligent acts) or agreed to in writing, shall any Contributor be
157
+ liable to You for damages, including any direct, indirect, special,
158
+ incidental, or consequential damages of any character arising as a
159
+ result of this License or out of the use or inability to use the
160
+ Work (including but not limited to damages for loss of goodwill,
161
+ work stoppage, computer failure or malfunction, or any and all
162
+ other commercial damages or losses), even if such Contributor
163
+ has been advised of the possibility of such damages.
164
+
165
+ 9. Accepting Warranty or Additional Liability. While redistributing
166
+ the Work or Derivative Works thereof, You may choose to offer,
167
+ and charge a fee for, acceptance of support, warranty, indemnity,
168
+ or other liability obligations and/or rights consistent with this
169
+ License. However, in accepting such obligations, You may act only
170
+ on Your own behalf and on Your sole responsibility, not on behalf
171
+ of any other Contributor, and only if You agree to indemnify,
172
+ defend, and hold each Contributor harmless for any liability
173
+ incurred by, or claims asserted against, such Contributor by reason
174
+ of your accepting any such warranty or additional liability.
175
+
176
+ END OF TERMS AND CONDITIONS
177
+
178
+ APPENDIX: How to apply the Apache License to your work.
179
+
180
+ To apply the Apache License to your work, attach the following
181
+ boilerplate notice, with the fields enclosed by brackets "[]"
182
+ replaced with your own identifying information. (Don't include
183
+ the brackets!) The text should be enclosed in the appropriate
184
+ comment syntax for the file format. We also recommend that a
185
+ file or class name and description of purpose be included on the
186
+ same "printed page" as the copyright notice for easier
187
+ identification within third-party archives.
188
+
189
+ Copyright [yyyy] [name of copyright owner]
190
+
191
+ Licensed under the Apache License, Version 2.0 (the "License");
192
+ you may not use this file except in compliance with the License.
193
+ You may obtain a copy of the License at
194
+
195
+ http://www.apache.org/licenses/LICENSE-2.0
196
+
197
+ Unless required by applicable law or agreed to in writing, software
198
+ distributed under the License is distributed on an "AS IS" BASIS,
199
+ WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
200
+ See the License for the specific language governing permissions and
201
+ limitations under the License.
edview-1.0.0/PKG-INFO ADDED
@@ -0,0 +1,158 @@
1
+ Metadata-Version: 2.4
2
+ Name: edview
3
+ Version: 1.0.0
4
+ Summary: GUI software for viewing EDXD/EDDT data processed by Algodif.
5
+ Author-email: Nghia Vo <nvo@bnl.gov>
6
+ License-Expression: Apache-2.0
7
+ Project-URL: Homepage, https://github.com/algodif/edview
8
+ Project-URL: Source, https://github.com/algodif/edview.git
9
+ Keywords: EDXD,EDDT,Energy-dispersive X-ray diffraction,Energy-dispersive X-ray diffraction tomography,Data viewer,GeRM detector
10
+ Classifier: Programming Language :: Python :: 3
11
+ Classifier: Intended Audience :: Science/Research
12
+ Classifier: Operating System :: OS Independent
13
+ Classifier: Natural Language :: English
14
+ Classifier: Topic :: Scientific/Engineering
15
+ Requires-Python: >=3.10
16
+ Description-Content-Type: text/markdown
17
+ License-File: LICENSE
18
+ Requires-Dist: algodif>=1.1.0
19
+ Requires-Dist: numpy
20
+ Requires-Dist: h5py
21
+ Requires-Dist: pillow
22
+ Requires-Dist: PySide6
23
+ Requires-Dist: pyqtgraph
24
+ Requires-Dist: PyOpenGL
25
+ Dynamic: license-file
26
+
27
+ # EDView
28
+ #### (**E**)nergy-(**D**)ispersive X-ray diffraction data (**View**)er
29
+
30
+ GUI software for viewing data of the Energy-Dispersive X-ray Diffraction
31
+ Tomography (EDDT) technique, processed by [Algodif](https://github.com/algodif/algodif).
32
+ Built on Algodif, PySide6, pyqtgraph, and pyopengl. This unified GUI combines the
33
+ separate GUIs published in the Algodif codebase.
34
+
35
+ Tabs
36
+ ====
37
+
38
+ - **Data browser**: folder tree, file list and preview of images, text/JSON
39
+ files and HDF datasets. Send the selected files or folders to other tab
40
+ with *View in* or *Add to*.
41
+
42
+ ![img](https://github.com/algodif/edview/raw/main/figs/data_browser.png)
43
+
44
+ - **Data correction**:
45
+ - *Correction*: correct raw scans (a scan folder with a `tifs` sub-folder,
46
+ a folder of tif files, files, an HDF file, or a range of `scan_xxxxx`
47
+ folders) with q or energy calibration coefficients, with optional
48
+ background removal. Output per scan: tif, HDF, or xy/csv (raw or corrected), plus
49
+ `metadata.json` (with the output step), the coefficients and the map of
50
+ the raw pixels.
51
+
52
+ ![img](https://github.com/algodif/edview/raw/main/figs/data_correction.png)
53
+
54
+ - *Conversion*: tif folder to 3D HDF, 3D HDF to tif folder, tif folder of
55
+ a 2D scan to 4D HDF, tif folder or HDF to xy/csv files.
56
+
57
+ - **EDDT viewer**: image of a 1D scan, q-slice across the scan, and the
58
+ diffraction pattern of the selected row.
59
+
60
+ ![img](https://github.com/algodif/edview/raw/main/figs/eddt_viewer.png)
61
+
62
+ - **Multiple-lines viewer**: as above, with the patterns of all images at
63
+ the selected row.
64
+
65
+ ![img](https://github.com/algodif/edview/raw/main/figs/multiple_lines_viewer.png)
66
+
67
+ - **Multiple-scans viewer**: several 1D scans; patterns of all scans at the
68
+ same image and row.
69
+
70
+ ![img](https://github.com/algodif/edview/raw/main/figs/multiple_scans_viewer.png)
71
+
72
+ - **2D-scan viewer**: image at a scan position (tif files named
73
+ `..._<row>_<col>.tif`, loaded on demand, a 4D HDF dataset, or a 3D HDF
74
+ dataset with the scan rows, columns and scan order given: row, column,
75
+ snake_row or snake_column), its pattern, and the q-slice along one scan
76
+ axis.
77
+
78
+ ![img](https://github.com/algodif/edview/raw/main/figs/2d_scan_viewer.png)
79
+
80
+ - **4D viewer**: a 4D HDF dataset (q, Z, scan rows, scan columns) of a 2D
81
+ scan, read on demand. Shows the volume (mean over a q-range) in 3D, with
82
+ transparency thresholds and real pixel sizes, a 2D slice of the volume
83
+ (fixed row, column or Z), the q-Z image at a scan position, and the
84
+ diffraction pattern at a Z. Large files can be downsampled (mean binning
85
+ along q, Z, rows and columns) to a smaller HDF file, and viewed directly.
86
+ Without PyOpenGL, the 3D view is replaced by a 2D image of the volume.
87
+
88
+ ![img](https://github.com/algodif/edview/raw/main//figs/4D_viewer.png)
89
+
90
+ The viewers read the q-step and the motor positions from the JSON metadata next
91
+ to the data (e.g. written by the Data correction tab or `process_data.py` of
92
+ Algodif), or from the HDF file. Clicking on the image selects a row and an x-value;
93
+ clicking on the q-slice selects a row and a scan position.
94
+
95
+ Installation
96
+ ============
97
+
98
+ Install [Miniconda, Anaconda or Miniforge](https://docs.conda.io/projects/conda/en/latest/user-guide/install/index.html), then
99
+ open a Linux terminal or the Miniconda/Anaconda PowerShell prompt and use the
100
+ following commands for installation.
101
+
102
+ Using pip:
103
+ ```commandline
104
+ pip install edview
105
+ ```
106
+ Using conda:
107
+ ```commandline
108
+ conda install -c algotom -c conda-forge edview
109
+ ```
110
+ Once installed, launch EDView with
111
+ ```commandline
112
+ edview
113
+ ```
114
+ or with a base folder for the data browser:
115
+ ```commandline
116
+ edview -b /path/to/data
117
+ ```
118
+ ---
119
+ Installing from source:
120
+ - Create a conda environment
121
+ ```commandline
122
+ conda create -n edview python=3.11
123
+ conda activate edview
124
+ ```
125
+ - Clone the source (git needs to be installed)
126
+ ```commandline
127
+ git clone https://github.com/algodif/edview.git
128
+ ```
129
+ - Navigate to the cloned directory (having the pyproject.toml file)
130
+ ```commandline
131
+ pip install .
132
+ ```
133
+ - Or run without installing, from the cloned directory, in an environment
134
+ having the packages in requirements.txt:
135
+ ```commandline
136
+ python -m edview.main
137
+ ```
138
+
139
+ The 3D views of the multiple-lines and 4D viewers need PyOpenGL (installed
140
+ with EDView); without it, 2D plots are used.
141
+
142
+ Building a conda package from the recipe:
143
+ ```commandline
144
+ conda install conda-build
145
+ conda build -c algotom -c conda-forge recipe
146
+ ```
147
+
148
+ Generating the executable application
149
+ -------------------------------------
150
+
151
+ - Install the packages in requirements.txt, PyInstaller, and Pillow (to
152
+ convert the PNG icon) in your environment.
153
+ - From the repository root, run:
154
+ ```commandline
155
+ python build_exe_app.py
156
+ ```
157
+ - The application is generated in the **build_app/edview** folder. To move
158
+ the app to a different place, move the entire folder.
edview-1.0.0/README.md ADDED
@@ -0,0 +1,132 @@
1
+ # EDView
2
+ #### (**E**)nergy-(**D**)ispersive X-ray diffraction data (**View**)er
3
+
4
+ GUI software for viewing data of the Energy-Dispersive X-ray Diffraction
5
+ Tomography (EDDT) technique, processed by [Algodif](https://github.com/algodif/algodif).
6
+ Built on Algodif, PySide6, pyqtgraph, and pyopengl. This unified GUI combines the
7
+ separate GUIs published in the Algodif codebase.
8
+
9
+ Tabs
10
+ ====
11
+
12
+ - **Data browser**: folder tree, file list and preview of images, text/JSON
13
+ files and HDF datasets. Send the selected files or folders to other tab
14
+ with *View in* or *Add to*.
15
+
16
+ ![img](https://github.com/algodif/edview/raw/main/figs/data_browser.png)
17
+
18
+ - **Data correction**:
19
+ - *Correction*: correct raw scans (a scan folder with a `tifs` sub-folder,
20
+ a folder of tif files, files, an HDF file, or a range of `scan_xxxxx`
21
+ folders) with q or energy calibration coefficients, with optional
22
+ background removal. Output per scan: tif, HDF, or xy/csv (raw or corrected), plus
23
+ `metadata.json` (with the output step), the coefficients and the map of
24
+ the raw pixels.
25
+
26
+ ![img](https://github.com/algodif/edview/raw/main/figs/data_correction.png)
27
+
28
+ - *Conversion*: tif folder to 3D HDF, 3D HDF to tif folder, tif folder of
29
+ a 2D scan to 4D HDF, tif folder or HDF to xy/csv files.
30
+
31
+ - **EDDT viewer**: image of a 1D scan, q-slice across the scan, and the
32
+ diffraction pattern of the selected row.
33
+
34
+ ![img](https://github.com/algodif/edview/raw/main/figs/eddt_viewer.png)
35
+
36
+ - **Multiple-lines viewer**: as above, with the patterns of all images at
37
+ the selected row.
38
+
39
+ ![img](https://github.com/algodif/edview/raw/main/figs/multiple_lines_viewer.png)
40
+
41
+ - **Multiple-scans viewer**: several 1D scans; patterns of all scans at the
42
+ same image and row.
43
+
44
+ ![img](https://github.com/algodif/edview/raw/main/figs/multiple_scans_viewer.png)
45
+
46
+ - **2D-scan viewer**: image at a scan position (tif files named
47
+ `..._<row>_<col>.tif`, loaded on demand, a 4D HDF dataset, or a 3D HDF
48
+ dataset with the scan rows, columns and scan order given: row, column,
49
+ snake_row or snake_column), its pattern, and the q-slice along one scan
50
+ axis.
51
+
52
+ ![img](https://github.com/algodif/edview/raw/main/figs/2d_scan_viewer.png)
53
+
54
+ - **4D viewer**: a 4D HDF dataset (q, Z, scan rows, scan columns) of a 2D
55
+ scan, read on demand. Shows the volume (mean over a q-range) in 3D, with
56
+ transparency thresholds and real pixel sizes, a 2D slice of the volume
57
+ (fixed row, column or Z), the q-Z image at a scan position, and the
58
+ diffraction pattern at a Z. Large files can be downsampled (mean binning
59
+ along q, Z, rows and columns) to a smaller HDF file, and viewed directly.
60
+ Without PyOpenGL, the 3D view is replaced by a 2D image of the volume.
61
+
62
+ ![img](https://github.com/algodif/edview/raw/main//figs/4D_viewer.png)
63
+
64
+ The viewers read the q-step and the motor positions from the JSON metadata next
65
+ to the data (e.g. written by the Data correction tab or `process_data.py` of
66
+ Algodif), or from the HDF file. Clicking on the image selects a row and an x-value;
67
+ clicking on the q-slice selects a row and a scan position.
68
+
69
+ Installation
70
+ ============
71
+
72
+ Install [Miniconda, Anaconda or Miniforge](https://docs.conda.io/projects/conda/en/latest/user-guide/install/index.html), then
73
+ open a Linux terminal or the Miniconda/Anaconda PowerShell prompt and use the
74
+ following commands for installation.
75
+
76
+ Using pip:
77
+ ```commandline
78
+ pip install edview
79
+ ```
80
+ Using conda:
81
+ ```commandline
82
+ conda install -c algotom -c conda-forge edview
83
+ ```
84
+ Once installed, launch EDView with
85
+ ```commandline
86
+ edview
87
+ ```
88
+ or with a base folder for the data browser:
89
+ ```commandline
90
+ edview -b /path/to/data
91
+ ```
92
+ ---
93
+ Installing from source:
94
+ - Create a conda environment
95
+ ```commandline
96
+ conda create -n edview python=3.11
97
+ conda activate edview
98
+ ```
99
+ - Clone the source (git needs to be installed)
100
+ ```commandline
101
+ git clone https://github.com/algodif/edview.git
102
+ ```
103
+ - Navigate to the cloned directory (having the pyproject.toml file)
104
+ ```commandline
105
+ pip install .
106
+ ```
107
+ - Or run without installing, from the cloned directory, in an environment
108
+ having the packages in requirements.txt:
109
+ ```commandline
110
+ python -m edview.main
111
+ ```
112
+
113
+ The 3D views of the multiple-lines and 4D viewers need PyOpenGL (installed
114
+ with EDView); without it, 2D plots are used.
115
+
116
+ Building a conda package from the recipe:
117
+ ```commandline
118
+ conda install conda-build
119
+ conda build -c algotom -c conda-forge recipe
120
+ ```
121
+
122
+ Generating the executable application
123
+ -------------------------------------
124
+
125
+ - Install the packages in requirements.txt, PyInstaller, and Pillow (to
126
+ convert the PNG icon) in your environment.
127
+ - From the repository root, run:
128
+ ```commandline
129
+ python build_exe_app.py
130
+ ```
131
+ - The application is generated in the **build_app/edview** folder. To move
132
+ the app to a different place, move the entire folder.
@@ -0,0 +1,6 @@
1
+ from importlib.metadata import version, PackageNotFoundError
2
+
3
+ try:
4
+ __version__ = version("edview")
5
+ except PackageNotFoundError: # Running from source without installing
6
+ __version__ = "unknown"
File without changes
File without changes