empix 0.0.4__py3-none-any.whl → 0.0.5__py3-none-any.whl
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.
- empix/version.py +16 -3
- empix-0.0.5.dist-info/METADATA +170 -0
- empix-0.0.5.dist-info/RECORD +7 -0
- empix-0.0.4.dist-info/METADATA +0 -62
- empix-0.0.4.dist-info/RECORD +0 -7
- {empix-0.0.4.dist-info → empix-0.0.5.dist-info}/WHEEL +0 -0
- {empix-0.0.4.dist-info → empix-0.0.5.dist-info}/licenses/LICENSE +0 -0
- {empix-0.0.4.dist-info → empix-0.0.5.dist-info}/top_level.txt +0 -0
empix/version.py
CHANGED
|
@@ -1,7 +1,14 @@
|
|
|
1
1
|
# file generated by setuptools-scm
|
|
2
2
|
# don't change, don't track in version control
|
|
3
3
|
|
|
4
|
-
__all__ = [
|
|
4
|
+
__all__ = [
|
|
5
|
+
"__version__",
|
|
6
|
+
"__version_tuple__",
|
|
7
|
+
"version",
|
|
8
|
+
"version_tuple",
|
|
9
|
+
"__commit_id__",
|
|
10
|
+
"commit_id",
|
|
11
|
+
]
|
|
5
12
|
|
|
6
13
|
TYPE_CHECKING = False
|
|
7
14
|
if TYPE_CHECKING:
|
|
@@ -9,13 +16,19 @@ if TYPE_CHECKING:
|
|
|
9
16
|
from typing import Union
|
|
10
17
|
|
|
11
18
|
VERSION_TUPLE = Tuple[Union[int, str], ...]
|
|
19
|
+
COMMIT_ID = Union[str, None]
|
|
12
20
|
else:
|
|
13
21
|
VERSION_TUPLE = object
|
|
22
|
+
COMMIT_ID = object
|
|
14
23
|
|
|
15
24
|
version: str
|
|
16
25
|
__version__: str
|
|
17
26
|
__version_tuple__: VERSION_TUPLE
|
|
18
27
|
version_tuple: VERSION_TUPLE
|
|
28
|
+
commit_id: COMMIT_ID
|
|
29
|
+
__commit_id__: COMMIT_ID
|
|
19
30
|
|
|
20
|
-
__version__ = version = '0.0.
|
|
21
|
-
__version_tuple__ = version_tuple = (0, 0,
|
|
31
|
+
__version__ = version = '0.0.5'
|
|
32
|
+
__version_tuple__ = version_tuple = (0, 0, 5)
|
|
33
|
+
|
|
34
|
+
__commit_id__ = commit_id = None
|
|
@@ -0,0 +1,170 @@
|
|
|
1
|
+
Metadata-Version: 2.4
|
|
2
|
+
Name: empix
|
|
3
|
+
Version: 0.0.5
|
|
4
|
+
Summary: Contains tools for analyzing electron microscopy data that are not available in ``hyperspy``.
|
|
5
|
+
Author-email: Matthew Fitzpatrick <matthew.rc.fitzpatrick@gmail.com>
|
|
6
|
+
Project-URL: Homepage, https://mrfitzpa.github.io/empix
|
|
7
|
+
Project-URL: Repository, https://github.com/mrfitzpa/empix
|
|
8
|
+
Keywords: hyperspy,microscopy,cropping,downsampling,resampling,azimuthal integration,annular integration
|
|
9
|
+
Classifier: License :: OSI Approved :: GNU General Public License v3 (GPLv3)
|
|
10
|
+
Classifier: Development Status :: 5 - Production/Stable
|
|
11
|
+
Classifier: Intended Audience :: Science/Research
|
|
12
|
+
Classifier: Programming Language :: Python
|
|
13
|
+
Classifier: Programming Language :: Python :: 3
|
|
14
|
+
Classifier: Programming Language :: Python :: 3.8
|
|
15
|
+
Classifier: Programming Language :: Python :: 3.9
|
|
16
|
+
Classifier: Programming Language :: Python :: 3.10
|
|
17
|
+
Classifier: Programming Language :: Python :: 3.11
|
|
18
|
+
Classifier: Programming Language :: Python :: 3.12
|
|
19
|
+
Classifier: Operating System :: OS Independent
|
|
20
|
+
Classifier: Natural Language :: English
|
|
21
|
+
Requires-Python: >=3.8
|
|
22
|
+
Description-Content-Type: text/markdown
|
|
23
|
+
License-File: LICENSE
|
|
24
|
+
Requires-Dist: czekitout
|
|
25
|
+
Requires-Dist: fancytypes>=1.0.0
|
|
26
|
+
Requires-Dist: hyperspy
|
|
27
|
+
Requires-Dist: pyFAI
|
|
28
|
+
Requires-Dist: numba
|
|
29
|
+
Provides-Extra: tests
|
|
30
|
+
Requires-Dist: pytest-cov; extra == "tests"
|
|
31
|
+
Provides-Extra: examples
|
|
32
|
+
Requires-Dist: jupyter; extra == "examples"
|
|
33
|
+
Requires-Dist: ipympl; extra == "examples"
|
|
34
|
+
Provides-Extra: docs
|
|
35
|
+
Requires-Dist: sphinx<7; extra == "docs"
|
|
36
|
+
Requires-Dist: sphinx_rtd_theme; extra == "docs"
|
|
37
|
+
Requires-Dist: sphinx-autodoc-typehints; extra == "docs"
|
|
38
|
+
Requires-Dist: numpydoc; extra == "docs"
|
|
39
|
+
Requires-Dist: docutils; extra == "docs"
|
|
40
|
+
Provides-Extra: all
|
|
41
|
+
Requires-Dist: empix[docs,examples,tests]; extra == "all"
|
|
42
|
+
Dynamic: license-file
|
|
43
|
+
|
|
44
|
+
# Electron Microscopy Pix (EMPix)
|
|
45
|
+
|
|
46
|
+
[](https://github.com/mrfitzpa/empix/actions/workflows/test_library.yml)
|
|
47
|
+
[](https://github.com/mrfitzpa/empix/actions/workflows/measure_code_coverage.yml)
|
|
48
|
+
[](https://mrfitzpa.github.io/empix)
|
|
49
|
+
[](https://pypi.org/project/empix)
|
|
50
|
+
[](https://anaconda.org/conda-forge/empix)
|
|
51
|
+
[](https://www.gnu.org/licenses/gpl-3.0)
|
|
52
|
+
|
|
53
|
+
`empix` is a Python library that contains tools for analyzing electron
|
|
54
|
+
microscopy data that are not available in
|
|
55
|
+
[`hyperspy`](https://hyperspy.org/hyperspy-doc/current/index.html).
|
|
56
|
+
|
|
57
|
+
Visit the [`empix` website](https://mrfitzpa.github.io/empix) for a web version
|
|
58
|
+
of the installation instructions, the reference guide, and the examples archive.
|
|
59
|
+
|
|
60
|
+
The source code can be found in the [`empix` GitHub
|
|
61
|
+
repository](https://github.com/mrfitzpa/empix).
|
|
62
|
+
|
|
63
|
+
|
|
64
|
+
|
|
65
|
+
## Table of contents
|
|
66
|
+
|
|
67
|
+
- [Instructions for installing and uninstalling
|
|
68
|
+
`empix`](#instructions-for-installing-and-uninstalling-empix)
|
|
69
|
+
- [Installing `empix`](#installing-empix)
|
|
70
|
+
- [Installing `empix` using
|
|
71
|
+
`pip`](#installing-empix-using-pip)
|
|
72
|
+
- [Installing `empix` using
|
|
73
|
+
`conda`](#installing-empix-using-conda)
|
|
74
|
+
- [Uninstalling `empix`](#uninstalling-empix)
|
|
75
|
+
- [Learning how to use `empix`](#learning-how-to-use-empix)
|
|
76
|
+
|
|
77
|
+
|
|
78
|
+
|
|
79
|
+
## Instructions for installing and uninstalling `empix`
|
|
80
|
+
|
|
81
|
+
|
|
82
|
+
|
|
83
|
+
### Installing `empix`
|
|
84
|
+
|
|
85
|
+
For all installation scenarios, first open up the appropriate command line
|
|
86
|
+
interface. On Unix-based systems, you could open e.g. a terminal. On Windows
|
|
87
|
+
systems you could open e.g. an Anaconda Prompt as an administrator.
|
|
88
|
+
|
|
89
|
+
|
|
90
|
+
|
|
91
|
+
#### Installing `empix` using `pip`
|
|
92
|
+
|
|
93
|
+
Before installing `empix`, make sure that you have activated the (virtual)
|
|
94
|
+
environment in which you intend to install said package. After which, simply
|
|
95
|
+
change into the root of the repository, and run the following command:
|
|
96
|
+
|
|
97
|
+
pip install empix
|
|
98
|
+
|
|
99
|
+
The above command will install the latest stable version of `empix`.
|
|
100
|
+
|
|
101
|
+
To install the latest development version from the main branch of the [empix
|
|
102
|
+
GitHub repository](https://github.com/mrfitzpa/empix), one must first clone the
|
|
103
|
+
repository by running the following command:
|
|
104
|
+
|
|
105
|
+
git clone https://github.com/mrfitzpa/empix.git
|
|
106
|
+
|
|
107
|
+
Next, change into the root of the cloned repository, and then run the following
|
|
108
|
+
command:
|
|
109
|
+
|
|
110
|
+
pip install .
|
|
111
|
+
|
|
112
|
+
Note that you must include the period as well. The above command executes a
|
|
113
|
+
standard installation of `empix`.
|
|
114
|
+
|
|
115
|
+
Optionally, for additional features in `empix`, one can install additional
|
|
116
|
+
dependencies upon installing `empix`. To install a subset of additional
|
|
117
|
+
dependencies (along with the standard installation), run the following command
|
|
118
|
+
from the root of the repository:
|
|
119
|
+
|
|
120
|
+
pip install .[<selector>]
|
|
121
|
+
|
|
122
|
+
where `<selector>` can be one of the following:
|
|
123
|
+
|
|
124
|
+
* `tests`: to install the dependencies necessary for running unit tests;
|
|
125
|
+
* `examples`: to install the dependencies necessary for executing files stored
|
|
126
|
+
in `<root>/examples`, where `<root>` is the root of the repository;
|
|
127
|
+
* `docs`: to install the dependencies necessary for documentation generation;
|
|
128
|
+
* `all`: to install all of the above optional dependencies.
|
|
129
|
+
|
|
130
|
+
Alternatively, one can run:
|
|
131
|
+
|
|
132
|
+
pip install empix[<selector>]
|
|
133
|
+
|
|
134
|
+
elsewhere in order to install the latest stable version of `empix`, along with
|
|
135
|
+
the subset of additional dependencies specified by `<selector>`.
|
|
136
|
+
|
|
137
|
+
|
|
138
|
+
|
|
139
|
+
#### Installing `empix` using `conda`
|
|
140
|
+
|
|
141
|
+
To install `empix` using the `conda` package manager, run the following command:
|
|
142
|
+
|
|
143
|
+
conda install -c conda-forge empix
|
|
144
|
+
|
|
145
|
+
The above command will install the latest stable version of `empix`.
|
|
146
|
+
|
|
147
|
+
|
|
148
|
+
|
|
149
|
+
### Uninstalling `empix`
|
|
150
|
+
|
|
151
|
+
If `empix` was installed using `pip`, then to uninstall, run the following
|
|
152
|
+
command from the root of the repository:
|
|
153
|
+
|
|
154
|
+
pip uninstall empix
|
|
155
|
+
|
|
156
|
+
If `empix` was installed using `conda`, then to uninstall, run the
|
|
157
|
+
following command from the root of the repository:
|
|
158
|
+
|
|
159
|
+
conda remove empix
|
|
160
|
+
|
|
161
|
+
|
|
162
|
+
|
|
163
|
+
## Learning how to use `empix`
|
|
164
|
+
|
|
165
|
+
For those new to the `empix` library, it is recommended that they take a look at
|
|
166
|
+
the [Examples](https://mrfitzpa.github.io/empix/examples.html) page, which
|
|
167
|
+
contain code examples that show how one can use the `empix` library. While going
|
|
168
|
+
through the examples, readers can consult the [empix reference
|
|
169
|
+
guide](https://mrfitzpa.github.io/empix/_autosummary/empix.html) to understand
|
|
170
|
+
what each line of code is doing.
|
|
@@ -0,0 +1,7 @@
|
|
|
1
|
+
empix/__init__.py,sha256=7Lo1f3w6dIc5ZSzjcrSNr8p9hSriZpYoaeeWdje-NPw,146382
|
|
2
|
+
empix/version.py,sha256=YRV1ohn6CdKEhsUOmFFMmr5UTjMv4Ydw3WJGxF2BHBs,704
|
|
3
|
+
empix-0.0.5.dist-info/licenses/LICENSE,sha256=N0P3pKtRMvfb64jmgJdlerg3TnS0a2QC776AzPsbZIg,35128
|
|
4
|
+
empix-0.0.5.dist-info/METADATA,sha256=yTlsGiAaxNQ6g7hWG0aAB5lVSyBYFBOdrO0hnxcZ0Cs,6585
|
|
5
|
+
empix-0.0.5.dist-info/WHEEL,sha256=_zCd3N1l69ArxyTb8rzEoP9TpbYXkqRFSNOD5OuxnTs,91
|
|
6
|
+
empix-0.0.5.dist-info/top_level.txt,sha256=6tteq_gpCW5Q3p1mBQfWv4h9jSqHMOyUrpe7PEXYdso,6
|
|
7
|
+
empix-0.0.5.dist-info/RECORD,,
|
empix-0.0.4.dist-info/METADATA
DELETED
|
@@ -1,62 +0,0 @@
|
|
|
1
|
-
Metadata-Version: 2.4
|
|
2
|
-
Name: empix
|
|
3
|
-
Version: 0.0.4
|
|
4
|
-
Summary: Contains tools for analyzing electron microscopy data that are not available in ``hyperspy``.
|
|
5
|
-
Author-email: Matthew Fitzpatrick <matthew.rc.fitzpatrick@gmail.com>
|
|
6
|
-
Project-URL: Homepage, https://mrfitzpa.github.io/empix
|
|
7
|
-
Project-URL: Repository, https://github.com/mrfitzpa/empix
|
|
8
|
-
Keywords: hyperspy,microscopy,cropping,downsampling,resampling,azimuthal integration,annular integration
|
|
9
|
-
Classifier: License :: OSI Approved :: GNU General Public License v3 (GPLv3)
|
|
10
|
-
Classifier: Development Status :: 5 - Production/Stable
|
|
11
|
-
Classifier: Intended Audience :: Science/Research
|
|
12
|
-
Classifier: Programming Language :: Python
|
|
13
|
-
Classifier: Programming Language :: Python :: 3
|
|
14
|
-
Classifier: Programming Language :: Python :: 3.8
|
|
15
|
-
Classifier: Programming Language :: Python :: 3.9
|
|
16
|
-
Classifier: Programming Language :: Python :: 3.10
|
|
17
|
-
Classifier: Programming Language :: Python :: 3.11
|
|
18
|
-
Classifier: Programming Language :: Python :: 3.12
|
|
19
|
-
Classifier: Operating System :: OS Independent
|
|
20
|
-
Classifier: Natural Language :: English
|
|
21
|
-
Requires-Python: >=3.8
|
|
22
|
-
Description-Content-Type: text/markdown
|
|
23
|
-
License-File: LICENSE
|
|
24
|
-
Requires-Dist: czekitout
|
|
25
|
-
Requires-Dist: fancytypes>=1.0.0
|
|
26
|
-
Requires-Dist: hyperspy
|
|
27
|
-
Requires-Dist: pyFAI
|
|
28
|
-
Provides-Extra: tests
|
|
29
|
-
Requires-Dist: pytest-cov; extra == "tests"
|
|
30
|
-
Provides-Extra: examples
|
|
31
|
-
Requires-Dist: jupyter; extra == "examples"
|
|
32
|
-
Requires-Dist: ipympl; extra == "examples"
|
|
33
|
-
Provides-Extra: docs
|
|
34
|
-
Requires-Dist: sphinx<7; extra == "docs"
|
|
35
|
-
Requires-Dist: sphinx_rtd_theme; extra == "docs"
|
|
36
|
-
Requires-Dist: sphinx-autodoc-typehints; extra == "docs"
|
|
37
|
-
Requires-Dist: numpydoc; extra == "docs"
|
|
38
|
-
Requires-Dist: docutils; extra == "docs"
|
|
39
|
-
Provides-Extra: all
|
|
40
|
-
Requires-Dist: empix[docs,examples,tests]; extra == "all"
|
|
41
|
-
Dynamic: license-file
|
|
42
|
-
|
|
43
|
-
# empix
|
|
44
|
-
|
|
45
|
-
[](https://github.com/mrfitzpa/empix/actions/workflows/test_library.yml)
|
|
46
|
-
[](https://github.com/mrfitzpa/empix/actions/workflows/measure_code_coverage.yml)
|
|
47
|
-
[](https://mrfitzpa.github.io/empix)
|
|
48
|
-
[](https://pypi.org/project/empix)
|
|
49
|
-
[](https://anaconda.org/conda-forge/empix)
|
|
50
|
-
[](https://www.gnu.org/licenses/gpl-3.0)
|
|
51
|
-
|
|
52
|
-
`empix` is a Python library that contains tools for analyzing electron
|
|
53
|
-
microscopy data that are not available in
|
|
54
|
-
[`hyperspy`](https://hyperspy.org/hyperspy-doc/current/index.html).
|
|
55
|
-
|
|
56
|
-
Visit the `empix` [website](https://mrfitzpa.github.io/empix) for a web version
|
|
57
|
-
of the installation instructions, the reference guide, and the examples archive.
|
|
58
|
-
|
|
59
|
-
<!--
|
|
60
|
-
For those reading raw .rst files, see file `docs/INSTALL.rst` for instructions
|
|
61
|
-
on installing the `empix` library.
|
|
62
|
-
-->
|
empix-0.0.4.dist-info/RECORD
DELETED
|
@@ -1,7 +0,0 @@
|
|
|
1
|
-
empix/__init__.py,sha256=7Lo1f3w6dIc5ZSzjcrSNr8p9hSriZpYoaeeWdje-NPw,146382
|
|
2
|
-
empix/version.py,sha256=EY1c6JeG6uVHQoQcoxYAagjmJgQQxJk7iQ23gAoevU4,511
|
|
3
|
-
empix-0.0.4.dist-info/licenses/LICENSE,sha256=N0P3pKtRMvfb64jmgJdlerg3TnS0a2QC776AzPsbZIg,35128
|
|
4
|
-
empix-0.0.4.dist-info/METADATA,sha256=gJlmw2qU8hNKNjjjm_rhmzsfvUejn1x1bOQ4jgEDKaQ,3079
|
|
5
|
-
empix-0.0.4.dist-info/WHEEL,sha256=_zCd3N1l69ArxyTb8rzEoP9TpbYXkqRFSNOD5OuxnTs,91
|
|
6
|
-
empix-0.0.4.dist-info/top_level.txt,sha256=6tteq_gpCW5Q3p1mBQfWv4h9jSqHMOyUrpe7PEXYdso,6
|
|
7
|
-
empix-0.0.4.dist-info/RECORD,,
|
|
File without changes
|
|
File without changes
|
|
File without changes
|