Merge pull request #12 from ericpre/rename_datasets_to_data

Rename `holospy.datasets` to `holospy.data`
hyperspy · Nov 10, 2023 · f8745f9 · f8745f9
2 parents 113c773 + a391a84
commit f8745f9
Show file tree

Hide file tree

Showing 7 changed files with 8 additions and 9 deletions.
diff --git a/holospy/__init__.py b/holospy/__init__.py
@@ -1,8 +1,8 @@
-from . import datasets, release_info, signals, reconstruct, tools
+from . import data, release_info, signals, reconstruct, tools
 
 __all__ = [
     "__version__",
-    "datasets",
+    "data",
     "signals",
     "reconstruct",
     "tools",

diff --git a/...atasets/00_ref_Vbp_130V_0V_bin2_crop.hdf5 → ...py/data/00_ref_Vbp_130V_0V_bin2_crop.hdf5 b/...atasets/00_ref_Vbp_130V_0V_bin2_crop.hdf5 → ...py/data/00_ref_Vbp_130V_0V_bin2_crop.hdf5
diff --git a/...tasets/01_holo_Vbp_130V_0V_bin2_crop.hdf5 → ...y/data/01_holo_Vbp_130V_0V_bin2_crop.hdf5 b/...tasets/01_holo_Vbp_130V_0V_bin2_crop.hdf5 → ...y/data/01_holo_Vbp_130V_0V_bin2_crop.hdf5
diff --git a/holospy/datasets/__init__.py → holospy/data/__init__.py b/holospy/datasets/__init__.py → holospy/data/__init__.py
diff --git a/holospy/signals/hologram_image.py b/holospy/signals/hologram_image.py
@@ -227,7 +227,7 @@ def estimate_sideband_position(
         Examples
         --------
         >>> import holospy as holo
-        >>> s = holo.datasets.Fe_needle_hologram()
+        >>> s = holo.data.Fe_needle_hologram()
         >>> sb_position = s.estimate_sideband_position()
         >>> sb_position.data
 
@@ -290,7 +290,7 @@ def estimate_sideband_size(
         Examples
         --------
         >>> import holospy as holo
-        >>> s = holo.datasets.Fe_needle_hologram()
+        >>> s = holo.data.Fe_needle_hologram()
         >>> sb_position = s.estimate_sideband_position()
         >>> sb_size = s.estimate_sideband_size(sb_position)
         >>> sb_size.data
@@ -392,7 +392,7 @@ def reconstruct_phase(
         Examples
         --------
         >>> import holospy as holo
-        >>> s = holo.datasets.Fe_needle_hologram()
+        >>> s = holo.data.Fe_needle_hologram()
         >>> sb_position = s.estimate_sideband_position()
         >>> sb_size = s.estimate_sideband_size(sb_position)
         >>> wave = s.reconstruct_phase(sb_position=sb_position, sb_size=sb_size)
@@ -782,7 +782,7 @@ def statistics(
         Examples
         --------
         >>> import holospy as holo
-        >>> s = holo.datasets.Fe_needle_reference_hologram()
+        >>> s = holo.data.Fe_needle_reference_hologram()
         >>> sb_position = s.estimate_sideband_position(high_cf=True)
         >>> s.statistics(sb_position=sb_position)
         {'Fringe spacing (nm)': 3.4860442674236256,

diff --git a/holospy/tests/signals/test_hologram_image_statistics.py b/holospy/tests/signals/test_hologram_image_statistics.py
@@ -45,7 +45,7 @@
 class TestStatistics:
     def setup_method(self, method):
         # Set the stack
-        s = holo.datasets.Fe_needle_reference_hologram()
+        s = holo.data.Fe_needle_reference_hologram()
         self.ref_holo = hs.stack([s] * 2)
         self.ref_holo = hs.stack([self.ref_holo] * 3)
 

diff --git a/setup.py b/setup.py
@@ -83,8 +83,7 @@
     package_data={
         "": ["LICENSE", "README.rst"],
         "holospy": [
-            "datasets/01_holo_Vbp_130V_0V_bin2_crop.hdf5",
-            "datasets/00_ref_Vbp_130V_0V_bin2_crop.hdf5",
+            "data/*.hdf5",
             "hyperspy_extension.yaml",
         ],
     },