empix 0.0.9__tar.gz → 0.0.10__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 (38) hide show
  1. {empix-0.0.9 → empix-0.0.10}/PKG-INFO +2 -1
  2. {empix-0.0.9 → empix-0.0.10}/docs/build_docs.py +18 -6
  3. {empix-0.0.9 → empix-0.0.10}/docs/conf.py +33 -12
  4. {empix-0.0.9 → empix-0.0.10}/docs/index.rst +5 -0
  5. {empix-0.0.9 → empix-0.0.10}/empix/version.py +3 -3
  6. {empix-0.0.9 → empix-0.0.10}/empix.egg-info/PKG-INFO +2 -1
  7. {empix-0.0.9 → empix-0.0.10}/empix.egg-info/requires.txt +1 -0
  8. {empix-0.0.9 → empix-0.0.10}/examples/basic_usage.ipynb +4 -4
  9. {empix-0.0.9 → empix-0.0.10}/examples/helpers_for_basic_usage.py +1 -1
  10. {empix-0.0.9 → empix-0.0.10}/pyproject.toml +2 -1
  11. {empix-0.0.9 → empix-0.0.10}/.coveragerc +0 -0
  12. {empix-0.0.9 → empix-0.0.10}/.github/workflows/measure_code_coverage.yml +0 -0
  13. {empix-0.0.9 → empix-0.0.10}/.github/workflows/publish_documentation_website.yml +0 -0
  14. {empix-0.0.9 → empix-0.0.10}/.github/workflows/publish_release_to_pypi.yml +0 -0
  15. {empix-0.0.9 → empix-0.0.10}/.github/workflows/test_library.yml +0 -0
  16. {empix-0.0.9 → empix-0.0.10}/.gitignore +0 -0
  17. {empix-0.0.9 → empix-0.0.10}/LICENSE +0 -0
  18. {empix-0.0.9 → empix-0.0.10}/README.md +0 -0
  19. {empix-0.0.9 → empix-0.0.10}/docs/INSTALL.rst +0 -0
  20. {empix-0.0.9 → empix-0.0.10}/docs/Makefile +0 -0
  21. {empix-0.0.9 → empix-0.0.10}/docs/_static/readthedocs_custom.css +0 -0
  22. {empix-0.0.9 → empix-0.0.10}/docs/_templates/custom_class_template.rst +0 -0
  23. {empix-0.0.9 → empix-0.0.10}/docs/_templates/custom_module_template.rst +0 -0
  24. {empix-0.0.9 → empix-0.0.10}/docs/_templates/versions.html +0 -0
  25. {empix-0.0.9 → empix-0.0.10}/docs/api.rst +0 -0
  26. {empix-0.0.9 → empix-0.0.10}/docs/examples.rst +0 -0
  27. {empix-0.0.9 → empix-0.0.10}/docs/license.rst +0 -0
  28. {empix-0.0.9 → empix-0.0.10}/docs/make.bat +0 -0
  29. {empix-0.0.9 → empix-0.0.10}/docs/private_members_to_publish_to_docs.rst +0 -0
  30. {empix-0.0.9 → empix-0.0.10}/empix/__init__.py +0 -0
  31. {empix-0.0.9 → empix-0.0.10}/empix.egg-info/SOURCES.txt +0 -0
  32. {empix-0.0.9 → empix-0.0.10}/empix.egg-info/dependency_links.txt +0 -0
  33. {empix-0.0.9 → empix-0.0.10}/empix.egg-info/top_level.txt +0 -0
  34. {empix-0.0.9 → empix-0.0.10}/run_tests.sh +0 -0
  35. {empix-0.0.9 → empix-0.0.10}/setup.cfg +0 -0
  36. {empix-0.0.9 → empix-0.0.10}/setup.py +0 -0
  37. {empix-0.0.9 → empix-0.0.10}/tests/test_root.py +0 -0
  38. {empix-0.0.9 → empix-0.0.10}/tox.ini +0 -0
@@ -1,6 +1,6 @@
1
1
  Metadata-Version: 2.4
2
2
  Name: empix
3
- Version: 0.0.9
3
+ Version: 0.0.10
4
4
  Summary: Contains tools for analyzing electron microscopy data that are not available in ``hyperspy``.
5
5
  Author-email: Matthew Fitzpatrick <matthew.rc.fitzpatrick@gmail.com>
6
6
  Project-URL: Homepage, https://mrfitzpa.github.io/empix
@@ -26,6 +26,7 @@ Requires-Dist: fancytypes>=1.0.0
26
26
  Requires-Dist: hyperspy
27
27
  Requires-Dist: pyFAI
28
28
  Requires-Dist: numba
29
+ Requires-Dist: scikit-image
29
30
  Provides-Extra: tests
30
31
  Requires-Dist: pytest-cov; extra == "tests"
31
32
  Provides-Extra: examples
@@ -98,16 +98,28 @@ _mvdir("./_build/html/", "./pages/")
98
98
 
99
99
  cmd_output_as_bytes = subprocess.check_output("git tag", shell=True)
100
100
  cmd_output = cmd_output_as_bytes.decode("utf-8")
101
- tags = cmd_output.rstrip("\n").split("\n")
101
+ tag_set = cmd_output.rstrip("\n").split("\n")
102
102
 
103
103
  pattern = r"v[0-9]+\.[0-9]+\.[0-9]+"
104
- release_tags = tuple(tag for tag in tags if re.fullmatch(pattern, tag))
104
+ release_tag_set = tuple(tag for tag in tag_set if re.fullmatch(pattern, tag))
105
105
 
106
- for tag in release_tags:
106
+ version_subset = dict()
107
+ for tag in release_tag_set:
107
108
  version = tag[1:]
108
- language = "en"
109
- _build_doc(version, language, tag)
110
- _mvdir("./_build/html/", "./pages/"+version+"/"+language+"/")
109
+ major, minor, patch = [int(int_as_str) for int_as_str in version.split(".")]
110
+ version_subset.setdefault(major, dict())
111
+ version_subset[major].setdefault(minor, 0)
112
+ version_subset[major][minor] = max(version_subset[major][minor], patch)
113
+
114
+ for major in sorted(version_subset.keys()):
115
+ for minor in sorted(version_subset[major].keys()):
116
+ patch = version_subset[major][minor]
117
+ version = "{}.{}.{}".format(major, minor, patch)
118
+ tag = "v"+version
119
+ major_minor = "{}.{}".format(major, minor)
120
+ language = "en"
121
+ _build_doc(version, language, tag)
122
+ _mvdir("./_build/html/", "./pages/"+major_minor+"/"+language+"/")
111
123
 
112
124
  subprocess.run("cd ..; pip install .; cd docs", shell=True)
113
125
  _mvdir("./pages/", "../pages/")
@@ -163,33 +163,54 @@ build_all_docs = os.environ.get("build_all_docs", None)
163
163
  pages_root = os.environ.get("pages_root", "")
164
164
 
165
165
  if build_all_docs is not None:
166
- current_language = os.environ.get("current_language")
166
+ current_language = os.environ.get("current_language")
167
167
  current_version = os.environ.get("current_version")
168
168
 
169
+ major, minor, patch = ((None, None, None)
170
+ if (current_version == "latest")
171
+ else current_version.split("."))
172
+ current_major_minor = ("latest"
173
+ if (major is None)
174
+ else "{}.{}".format(major, minor))
175
+
169
176
  html_context = {"current_language" : current_language,
170
177
  "languages" : [],
171
- "current_version" : current_version,
178
+ "current_version" : current_major_minor,
172
179
  "versions" : []}
173
180
 
174
- if (current_version == "latest"):
181
+ if current_version == "latest":
175
182
  html_context["languages"].append(["en", pages_root])
176
183
 
177
- if (current_language == "en"):
184
+ if current_language == "en":
178
185
  html_context["versions"].append(["latest", pages_root])
179
186
 
180
187
  cmd_output_as_bytes = subprocess.check_output("git tag", shell=True)
181
188
  cmd_output = cmd_output_as_bytes.decode("utf-8")
182
- tags = cmd_output.rstrip("\n").split("\n")
189
+ tag_set = cmd_output.rstrip("\n").split("\n")
183
190
 
184
191
  pattern = r"v[0-9]+\.[0-9]+\.[0-9]+"
185
- release_tags = tuple(tag for tag in tags if re.fullmatch(pattern, tag))
192
+ release_tag_set = tuple(tag
193
+ for tag
194
+ in tag_set
195
+ if re.fullmatch(pattern, tag))
186
196
 
187
- if (current_version != "latest"):
197
+ version_subset = dict()
198
+ for tag in release_tag_set:
199
+ version = tag[1:]
200
+ major, minor, patch = [int(int_as_str)
201
+ for int_as_str
202
+ in version.split(".")]
203
+ version_subset.setdefault(major, dict())
204
+ version_subset[major].setdefault(minor, 0)
205
+ version_subset[major][minor] = max(version_subset[major][minor], patch)
206
+
207
+ if current_version != "latest":
188
208
  language = "en"
189
- path = pages_root+"/"+current_version+"/"+language
209
+ path = pages_root+"/"+current_major_minor+"/"+language
190
210
  html_context["languages"].append([language, path])
191
211
 
192
- for tag in release_tags:
193
- version = tag[1:]
194
- path = pages_root+"/"+version+"/"+current_language
195
- html_context["versions"].append([version, path])
212
+ for major in sorted(version_subset.keys()):
213
+ for minor in sorted(version_subset[major].keys()):
214
+ major_minor = "{}.{}".format(major, minor)
215
+ path = pages_root+"/"+major_minor+"/"+current_language
216
+ html_context["versions"].append([major_minor, path])
@@ -1,3 +1,8 @@
1
+ .. meta::
2
+ :google-site-verification: kxE4d_wW0ikuxlKuVCgIxNZT81VDOxKWJ7R9mbTnvKA
3
+
4
+
5
+
1
6
  Electron Microscopy Pix (EMPix)
2
7
  ===============================
3
8
 
@@ -28,7 +28,7 @@ version_tuple: VERSION_TUPLE
28
28
  commit_id: COMMIT_ID
29
29
  __commit_id__: COMMIT_ID
30
30
 
31
- __version__ = version = '0.0.9'
32
- __version_tuple__ = version_tuple = (0, 0, 9)
31
+ __version__ = version = '0.0.10'
32
+ __version_tuple__ = version_tuple = (0, 0, 10)
33
33
 
34
- __commit_id__ = commit_id = 'g28d6964b8'
34
+ __commit_id__ = commit_id = 'gdc5580860'
@@ -1,6 +1,6 @@
1
1
  Metadata-Version: 2.4
2
2
  Name: empix
3
- Version: 0.0.9
3
+ Version: 0.0.10
4
4
  Summary: Contains tools for analyzing electron microscopy data that are not available in ``hyperspy``.
5
5
  Author-email: Matthew Fitzpatrick <matthew.rc.fitzpatrick@gmail.com>
6
6
  Project-URL: Homepage, https://mrfitzpa.github.io/empix
@@ -26,6 +26,7 @@ Requires-Dist: fancytypes>=1.0.0
26
26
  Requires-Dist: hyperspy
27
27
  Requires-Dist: pyFAI
28
28
  Requires-Dist: numba
29
+ Requires-Dist: scikit-image
29
30
  Provides-Extra: tests
30
31
  Requires-Dist: pytest-cov; extra == "tests"
31
32
  Provides-Extra: examples
@@ -3,6 +3,7 @@ fancytypes>=1.0.0
3
3
  hyperspy
4
4
  pyFAI
5
5
  numba
6
+ scikit-image
6
7
 
7
8
  [all]
8
9
  empix[docs,examples,tests]
@@ -131,13 +131,13 @@
131
131
  "\n",
132
132
  " conda install -y empix jupyter ipympl -c conda-forge\n",
133
133
  "\n",
134
- "You can find the documentation for the emicroml library\n",
134
+ "You can find the documentation for the ``empix`` library\n",
135
135
  "[here](https://mrfitzpa.github.io/empix/_autosummary/empix.html). It is\n",
136
136
  "recommended that you consult the documentation of this library as you explore\n",
137
137
  "the notebook. Moreover, users should execute the cells in the order that they\n",
138
138
  "appear, i.e. from top to bottom, as some cells reference variables that are set\n",
139
- "in other cells above them. **Users should make sure to navigate the documentation\n",
140
- "for the version of emicroml that they are currently using.**\n",
139
+ "in other cells above them. **Users should make sure to navigate the\n",
140
+ "documentation for the version of ``empix`` that they are currently using.**\n",
141
141
  "\n",
142
142
  "The last module that we imported above (i.e. the module with the alias helpers)\n",
143
143
  "contains helper functions that are used throughout the remainder of the\n",
@@ -145,7 +145,7 @@
145
145
  "not essential that users know the implementation details of these helper\n",
146
146
  "functions in order to follow the logic of each cell in the remainder of this\n",
147
147
  "notebook. Moreover, users need not import this module for their own applications\n",
148
- "of emicroml. That being said, if any users are interested in the implementation\n",
148
+ "of ``empix``. That being said, if any users are interested in the implementation\n",
149
149
  "details, they can find them in the file\n",
150
150
  "`<root>/examples/helpers_for_basic_usage.py`."
151
151
  ]
@@ -23,7 +23,7 @@
23
23
  ## Load libraries/packages/modules ##
24
24
  #####################################
25
25
 
26
- # For general array handling and constructing random number generators.
26
+ # For general array handling.
27
27
  import numpy as np
28
28
 
29
29
  # For creating hyperspy signals.
@@ -41,7 +41,8 @@ dependencies = [
41
41
  "fancytypes>=1.0.0",
42
42
  "hyperspy",
43
43
  "pyFAI",
44
- "numba"
44
+ "numba",
45
+ "scikit-image"
45
46
  ]
46
47
  requires-python = ">=3.8"
47
48
 
File without changes
File without changes
File without changes
File without changes
File without changes
File without changes
File without changes
File without changes
File without changes
File without changes
File without changes
File without changes
File without changes
File without changes
File without changes
File without changes
File without changes