ptydy 0.0.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.
ptydy-0.0.1/LICENSE ADDED
@@ -0,0 +1,165 @@
1
+ GNU LESSER GENERAL PUBLIC LICENSE
2
+ Version 3, 29 June 2007
3
+
4
+ Copyright (C) 2007 Free Software Foundation, Inc. <https://fsf.org/>
5
+ Everyone is permitted to copy and distribute verbatim copies
6
+ of this license document, but changing it is not allowed.
7
+
8
+
9
+ This version of the GNU Lesser General Public License incorporates
10
+ the terms and conditions of version 3 of the GNU General Public
11
+ License, supplemented by the additional permissions listed below.
12
+
13
+ 0. Additional Definitions.
14
+
15
+ As used herein, "this License" refers to version 3 of the GNU Lesser
16
+ General Public License, and the "GNU GPL" refers to version 3 of the GNU
17
+ General Public License.
18
+
19
+ "The Library" refers to a covered work governed by this License,
20
+ other than an Application or a Combined Work as defined below.
21
+
22
+ An "Application" is any work that makes use of an interface provided
23
+ by the Library, but which is not otherwise based on the Library.
24
+ Defining a subclass of a class defined by the Library is deemed a mode
25
+ of using an interface provided by the Library.
26
+
27
+ A "Combined Work" is a work produced by combining or linking an
28
+ Application with the Library. The particular version of the Library
29
+ with which the Combined Work was made is also called the "Linked
30
+ Version".
31
+
32
+ The "Minimal Corresponding Source" for a Combined Work means the
33
+ Corresponding Source for the Combined Work, excluding any source code
34
+ for portions of the Combined Work that, considered in isolation, are
35
+ based on the Application, and not on the Linked Version.
36
+
37
+ The "Corresponding Application Code" for a Combined Work means the
38
+ object code and/or source code for the Application, including any data
39
+ and utility programs needed for reproducing the Combined Work from the
40
+ Application, but excluding the System Libraries of the Combined Work.
41
+
42
+ 1. Exception to Section 3 of the GNU GPL.
43
+
44
+ You may convey a covered work under sections 3 and 4 of this License
45
+ without being bound by section 3 of the GNU GPL.
46
+
47
+ 2. Conveying Modified Versions.
48
+
49
+ If you modify a copy of the Library, and, in your modifications, a
50
+ facility refers to a function or data to be supplied by an Application
51
+ that uses the facility (other than as an argument passed when the
52
+ facility is invoked), then you may convey a copy of the modified
53
+ version:
54
+
55
+ a) under this License, provided that you make a good faith effort to
56
+ ensure that, in the event an Application does not supply the
57
+ function or data, the facility still operates, and performs
58
+ whatever part of its purpose remains meaningful, or
59
+
60
+ b) under the GNU GPL, with none of the additional permissions of
61
+ this License applicable to that copy.
62
+
63
+ 3. Object Code Incorporating Material from Library Header Files.
64
+
65
+ The object code form of an Application may incorporate material from
66
+ a header file that is part of the Library. You may convey such object
67
+ code under terms of your choice, provided that, if the incorporated
68
+ material is not limited to numerical parameters, data structure
69
+ layouts and accessors, or small macros, inline functions and templates
70
+ (ten or fewer lines in length), you do both of the following:
71
+
72
+ a) Give prominent notice with each copy of the object code that the
73
+ Library is used in it and that the Library and its use are
74
+ covered by this License.
75
+
76
+ b) Accompany the object code with a copy of the GNU GPL and this license
77
+ document.
78
+
79
+ 4. Combined Works.
80
+
81
+ You may convey a Combined Work under terms of your choice that,
82
+ taken together, effectively do not restrict modification of the
83
+ portions of the Library contained in the Combined Work and reverse
84
+ engineering for debugging such modifications, if you also do each of
85
+ the following:
86
+
87
+ a) Give prominent notice with each copy of the Combined Work that
88
+ the Library is used in it and that the Library and its use are
89
+ covered by this License.
90
+
91
+ b) Accompany the Combined Work with a copy of the GNU GPL and this license
92
+ document.
93
+
94
+ c) For a Combined Work that displays copyright notices during
95
+ execution, include the copyright notice for the Library among
96
+ these notices, as well as a reference directing the user to the
97
+ copies of the GNU GPL and this license document.
98
+
99
+ d) Do one of the following:
100
+
101
+ 0) Convey the Minimal Corresponding Source under the terms of this
102
+ License, and the Corresponding Application Code in a form
103
+ suitable for, and under terms that permit, the user to
104
+ recombine or relink the Application with a modified version of
105
+ the Linked Version to produce a modified Combined Work, in the
106
+ manner specified by section 6 of the GNU GPL for conveying
107
+ Corresponding Source.
108
+
109
+ 1) Use a suitable shared library mechanism for linking with the
110
+ Library. A suitable mechanism is one that (a) uses at run time
111
+ a copy of the Library already present on the user's computer
112
+ system, and (b) will operate properly with a modified version
113
+ of the Library that is interface-compatible with the Linked
114
+ Version.
115
+
116
+ e) Provide Installation Information, but only if you would otherwise
117
+ be required to provide such information under section 6 of the
118
+ GNU GPL, and only to the extent that such information is
119
+ necessary to install and execute a modified version of the
120
+ Combined Work produced by recombining or relinking the
121
+ Application with a modified version of the Linked Version. (If
122
+ you use option 4d0, the Installation Information must accompany
123
+ the Minimal Corresponding Source and Corresponding Application
124
+ Code. If you use option 4d1, you must provide the Installation
125
+ Information in the manner specified by section 6 of the GNU GPL
126
+ for conveying Corresponding Source.)
127
+
128
+ 5. Combined Libraries.
129
+
130
+ You may place library facilities that are a work based on the
131
+ Library side by side in a single library together with other library
132
+ facilities that are not Applications and are not covered by this
133
+ License, and convey such a combined library under terms of your
134
+ choice, if you do both of the following:
135
+
136
+ a) Accompany the combined library with a copy of the same work based
137
+ on the Library, uncombined with any other library facilities,
138
+ conveyed under the terms of this License.
139
+
140
+ b) Give prominent notice with the combined library that part of it
141
+ is a work based on the Library, and explaining where to find the
142
+ accompanying uncombined form of the same work.
143
+
144
+ 6. Revised Versions of the GNU Lesser General Public License.
145
+
146
+ The Free Software Foundation may publish revised and/or new versions
147
+ of the GNU Lesser General Public License from time to time. Such new
148
+ versions will be similar in spirit to the present version, but may
149
+ differ in detail to address new problems or concerns.
150
+
151
+ Each version is given a distinguishing version number. If the
152
+ Library as you received it specifies that a certain numbered version
153
+ of the GNU Lesser General Public License "or any later version"
154
+ applies to it, you have the option of following the terms and
155
+ conditions either of that published version or of any later version
156
+ published by the Free Software Foundation. If the Library as you
157
+ received it does not specify a version number of the GNU Lesser
158
+ General Public License, you may choose any version of the GNU Lesser
159
+ General Public License ever published by the Free Software Foundation.
160
+
161
+ If the Library as you received it specifies that a proxy can decide
162
+ whether future versions of the GNU Lesser General Public License shall
163
+ apply, that proxy's public statement of acceptance of any version is
164
+ permanent authorization for you to choose that version for the
165
+ Library.
ptydy-0.0.1/PKG-INFO ADDED
@@ -0,0 +1,61 @@
1
+ Metadata-Version: 2.4
2
+ Name: ptydy
3
+ Version: 0.0.1
4
+ Summary: Ptydy: a PtyRAD studio for planning, inspecting, and reconstructing ptychography data
5
+ Author-email: Chia-Hao Lee <cl2696@cornell.edu>
6
+ License-Expression: LGPL-3.0
7
+ Project-URL: Homepage, https://github.com/chiahao3/ptydy
8
+ Project-URL: Repository, https://github.com/chiahao3/ptydy
9
+ Project-URL: Issues, https://github.com/chiahao3/ptydy/issues
10
+ Project-URL: Changelog, https://github.com/chiahao3/ptydy/blob/main/CHANGELOG.md
11
+ Keywords: Ptychography,4D-STEM,Electron microscopy,GUI
12
+ Classifier: Development Status :: 1 - Planning
13
+ Classifier: Programming Language :: Python :: 3
14
+ Classifier: Operating System :: OS Independent
15
+ Classifier: Intended Audience :: Science/Research
16
+ Classifier: Topic :: Scientific/Engineering :: Physics
17
+ Requires-Python: >=3.10
18
+ Description-Content-Type: text/markdown
19
+ License-File: LICENSE
20
+ Provides-Extra: test
21
+ Requires-Dist: pytest; extra == "test"
22
+ Provides-Extra: dev
23
+ Requires-Dist: pytest; extra == "dev"
24
+ Requires-Dist: build; extra == "dev"
25
+ Requires-Dist: twine; extra == "dev"
26
+ Dynamic: license-file
27
+
28
+ # Ptydy
29
+
30
+ *A PtyRAD studio. Pronounced "tidy".*
31
+
32
+ > **Status: planning.** This package is an early placeholder and has no functionality yet.
33
+
34
+ Ptydy will be a desktop program that brings the [PtyRAD](https://github.com/chiahao3/ptyrad) ecosystem together in one place, so the steps of a ptychography workflow share their settings instead of being copied between tools by hand:
35
+
36
+ 1. **Experiment planning**: dose, probe overlap, sampling, and the expected result
37
+ 2. **Dataset inspection**: a fast 4D-STEM viewer with fast-acbf calibration (scan rotation, defocus, diffraction center)
38
+ 3. **PtyRAD plan helper**: build and check reconstruction settings, then submit jobs to a local or remote GPU
39
+ 4. **Dataset simulation**: simulated datasets with known ground truth
40
+ 5. **Output inspector**: look at reconstruction results next to their inputs
41
+
42
+ ## Design goals
43
+
44
+ - **One shared project file** that every step reads and writes, and that also works from scripts and notebooks
45
+ - **Plugins for each task**: install only the parts you need
46
+ - **Anything the GUI does can also be done in a script**: the GUI shows the settings it generates, so you learn the format as you go
47
+ - **Remote reconstruction**: set up on a laptop, run on a GPU node or Slurm cluster
48
+
49
+ Built with PySide6 and pyqtgraph.
50
+
51
+ ## Installation
52
+
53
+ ```sh
54
+ pip install ptydy
55
+ ```
56
+
57
+ This currently installs an empty placeholder.
58
+
59
+ ## License
60
+
61
+ LGPL-3.0. See [LICENSE](LICENSE).
ptydy-0.0.1/README.md ADDED
@@ -0,0 +1,34 @@
1
+ # Ptydy
2
+
3
+ *A PtyRAD studio. Pronounced "tidy".*
4
+
5
+ > **Status: planning.** This package is an early placeholder and has no functionality yet.
6
+
7
+ Ptydy will be a desktop program that brings the [PtyRAD](https://github.com/chiahao3/ptyrad) ecosystem together in one place, so the steps of a ptychography workflow share their settings instead of being copied between tools by hand:
8
+
9
+ 1. **Experiment planning**: dose, probe overlap, sampling, and the expected result
10
+ 2. **Dataset inspection**: a fast 4D-STEM viewer with fast-acbf calibration (scan rotation, defocus, diffraction center)
11
+ 3. **PtyRAD plan helper**: build and check reconstruction settings, then submit jobs to a local or remote GPU
12
+ 4. **Dataset simulation**: simulated datasets with known ground truth
13
+ 5. **Output inspector**: look at reconstruction results next to their inputs
14
+
15
+ ## Design goals
16
+
17
+ - **One shared project file** that every step reads and writes, and that also works from scripts and notebooks
18
+ - **Plugins for each task**: install only the parts you need
19
+ - **Anything the GUI does can also be done in a script**: the GUI shows the settings it generates, so you learn the format as you go
20
+ - **Remote reconstruction**: set up on a laptop, run on a GPU node or Slurm cluster
21
+
22
+ Built with PySide6 and pyqtgraph.
23
+
24
+ ## Installation
25
+
26
+ ```sh
27
+ pip install ptydy
28
+ ```
29
+
30
+ This currently installs an empty placeholder.
31
+
32
+ ## License
33
+
34
+ LGPL-3.0. See [LICENSE](LICENSE).
@@ -0,0 +1,51 @@
1
+ [build-system]
2
+ requires = ["setuptools>=61.0"]
3
+ build-backend = "setuptools.build_meta"
4
+
5
+ [project]
6
+ name = "ptydy"
7
+ dynamic = ["version"]
8
+ authors = [
9
+ { name="Chia-Hao Lee", email="cl2696@cornell.edu" },
10
+ ]
11
+ description = "Ptydy: a PtyRAD studio for planning, inspecting, and reconstructing ptychography data"
12
+ readme = "README.md"
13
+ keywords = ["Ptychography", "4D-STEM", "Electron microscopy", "GUI"]
14
+ license = "LGPL-3.0"
15
+ license-files = ["LICENSE"]
16
+ requires-python = ">=3.10"
17
+ classifiers = [
18
+ "Development Status :: 1 - Planning",
19
+ "Programming Language :: Python :: 3",
20
+ "Operating System :: OS Independent",
21
+ "Intended Audience :: Science/Research",
22
+ "Topic :: Scientific/Engineering :: Physics",
23
+ ]
24
+
25
+ dependencies = []
26
+
27
+ [project.optional-dependencies]
28
+ test = [
29
+ "pytest",
30
+ ]
31
+ dev = [
32
+ "pytest",
33
+ "build",
34
+ "twine",
35
+ ]
36
+
37
+ [project.urls]
38
+ "Homepage" = "https://github.com/chiahao3/ptydy"
39
+ "Repository" = "https://github.com/chiahao3/ptydy"
40
+ "Issues" = "https://github.com/chiahao3/ptydy/issues"
41
+ "Changelog" = "https://github.com/chiahao3/ptydy/blob/main/CHANGELOG.md"
42
+
43
+ [tool.setuptools]
44
+ package-dir = {"" = "src"}
45
+ include-package-data = false
46
+
47
+ [tool.setuptools.packages.find]
48
+ where = ["src"]
49
+
50
+ [tool.setuptools.dynamic]
51
+ version = {attr = "ptydy.__version__"}
ptydy-0.0.1/setup.cfg ADDED
@@ -0,0 +1,4 @@
1
+ [egg_info]
2
+ tag_build =
3
+ tag_date = 0
4
+
@@ -0,0 +1,8 @@
1
+ """Ptydy: a PtyRAD studio.
2
+
3
+ Ptydy (pronounced "tidy") is a desktop program that brings the PtyRAD tools together:
4
+ experiment planning, dataset inspection, reconstruction setup, simulation,
5
+ and output inspection. It is in the planning stage.
6
+ """
7
+
8
+ __version__ = "0.0.1" # 2026.09.29
@@ -0,0 +1,61 @@
1
+ Metadata-Version: 2.4
2
+ Name: ptydy
3
+ Version: 0.0.1
4
+ Summary: Ptydy: a PtyRAD studio for planning, inspecting, and reconstructing ptychography data
5
+ Author-email: Chia-Hao Lee <cl2696@cornell.edu>
6
+ License-Expression: LGPL-3.0
7
+ Project-URL: Homepage, https://github.com/chiahao3/ptydy
8
+ Project-URL: Repository, https://github.com/chiahao3/ptydy
9
+ Project-URL: Issues, https://github.com/chiahao3/ptydy/issues
10
+ Project-URL: Changelog, https://github.com/chiahao3/ptydy/blob/main/CHANGELOG.md
11
+ Keywords: Ptychography,4D-STEM,Electron microscopy,GUI
12
+ Classifier: Development Status :: 1 - Planning
13
+ Classifier: Programming Language :: Python :: 3
14
+ Classifier: Operating System :: OS Independent
15
+ Classifier: Intended Audience :: Science/Research
16
+ Classifier: Topic :: Scientific/Engineering :: Physics
17
+ Requires-Python: >=3.10
18
+ Description-Content-Type: text/markdown
19
+ License-File: LICENSE
20
+ Provides-Extra: test
21
+ Requires-Dist: pytest; extra == "test"
22
+ Provides-Extra: dev
23
+ Requires-Dist: pytest; extra == "dev"
24
+ Requires-Dist: build; extra == "dev"
25
+ Requires-Dist: twine; extra == "dev"
26
+ Dynamic: license-file
27
+
28
+ # Ptydy
29
+
30
+ *A PtyRAD studio. Pronounced "tidy".*
31
+
32
+ > **Status: planning.** This package is an early placeholder and has no functionality yet.
33
+
34
+ Ptydy will be a desktop program that brings the [PtyRAD](https://github.com/chiahao3/ptyrad) ecosystem together in one place, so the steps of a ptychography workflow share their settings instead of being copied between tools by hand:
35
+
36
+ 1. **Experiment planning**: dose, probe overlap, sampling, and the expected result
37
+ 2. **Dataset inspection**: a fast 4D-STEM viewer with fast-acbf calibration (scan rotation, defocus, diffraction center)
38
+ 3. **PtyRAD plan helper**: build and check reconstruction settings, then submit jobs to a local or remote GPU
39
+ 4. **Dataset simulation**: simulated datasets with known ground truth
40
+ 5. **Output inspector**: look at reconstruction results next to their inputs
41
+
42
+ ## Design goals
43
+
44
+ - **One shared project file** that every step reads and writes, and that also works from scripts and notebooks
45
+ - **Plugins for each task**: install only the parts you need
46
+ - **Anything the GUI does can also be done in a script**: the GUI shows the settings it generates, so you learn the format as you go
47
+ - **Remote reconstruction**: set up on a laptop, run on a GPU node or Slurm cluster
48
+
49
+ Built with PySide6 and pyqtgraph.
50
+
51
+ ## Installation
52
+
53
+ ```sh
54
+ pip install ptydy
55
+ ```
56
+
57
+ This currently installs an empty placeholder.
58
+
59
+ ## License
60
+
61
+ LGPL-3.0. See [LICENSE](LICENSE).
@@ -0,0 +1,10 @@
1
+ LICENSE
2
+ README.md
3
+ pyproject.toml
4
+ src/ptydy/__init__.py
5
+ src/ptydy.egg-info/PKG-INFO
6
+ src/ptydy.egg-info/SOURCES.txt
7
+ src/ptydy.egg-info/dependency_links.txt
8
+ src/ptydy.egg-info/requires.txt
9
+ src/ptydy.egg-info/top_level.txt
10
+ tests/test_import.py
@@ -0,0 +1,8 @@
1
+
2
+ [dev]
3
+ pytest
4
+ build
5
+ twine
6
+
7
+ [test]
8
+ pytest
@@ -0,0 +1 @@
1
+ ptydy
@@ -0,0 +1,5 @@
1
+ import ptydy
2
+
3
+
4
+ def test_version():
5
+ assert isinstance(ptydy.__version__, str)