Move PeakCollection into the correct sub-package

Refs #219
neutrons · Dec 19, 2019 · a5fe3ea · a5fe3ea
1 parent b157dd4
commit a5fe3ea
Show file tree

Hide file tree

Showing 8 changed files with 12 additions and 9 deletions.
diff --git a/pyrs/core/mantid_fit_peak.py b/pyrs/core/mantid_fit_peak.py
@@ -2,7 +2,7 @@
 from pyrs.core import mantid_helper
 from pyrs.utilities import checkdatatypes
 from pyrs.core import peak_fit_engine
-from pyrs.core.peak_collection import PeakCollection
+from pyrs.peaks import PeakCollection
 import numpy as np
 from mantid.api import AnalysisDataService
 from mantid.simpleapi import CreateWorkspace, FitPeaks
@@ -322,7 +322,7 @@ def fit_multiple_peaks(self, sub_run_range, peak_function_name, background_funct
         Returns
         -------
         Dict
-            dictionary of ~pyrs.core.peak_collection.PeakCollection with peak tag as key
+            dictionary of ~pyrs.peaks.PeakCollection with peak tag as key
 
         """
         peak_collection_dict = dict()
@@ -362,7 +362,7 @@ def _set_profile_parameters_values_from_fitting(self, peak_tag, sub_runs, peak_p
 
         Returns
         -------
-        ~pyrs.core.peak_collecton.PeakCollection
+        ~pyrs.peaks.PeakCollection
             Fitted peak's information
 
         """

diff --git a/pyrs/core/peak_fit_engine.py b/pyrs/core/peak_fit_engine.py
@@ -247,7 +247,7 @@ def fit_multiple_peaks(self, sub_run_range, peak_function_name, background_funct
 
         Returns
         -------
-        List of ~pyrs.core.peak_collection.PeakCollection
+        List of ~pyrs.peaks.PeakCollection
 
         """
         raise NotImplementedError('Virtual base class member method fit_multiple_peaks')
@@ -346,7 +346,7 @@ def get_peaks(self, peak_tag):
 
         Returns
         -------
-        pyrs.core.peak_collection.PeakCollection
+        pyrs.peaks.PeakCollection
             Collection of peak information
 
         """

diff --git a/pyrs/core/summary_generator.py b/pyrs/core/summary_generator.py
@@ -97,7 +97,7 @@ def write_csv(self, sample_logs, peak_collections, tolerance=1E-10):
         ----------
         sample_logs: ~pyrs.dataobjects.SampleLogs
         peak_collections: list
-            list of :py:obj:`~pyrs.core.peak_collection.PeakCollection`
+            list of :py:obj:`~pyrs.peaks.PeakCollection`
         tolerance : float
             relative tolerance of variance to treat a sample log as a constant value
             and bring into extended header

diff --git a/pyrs/peaks/__init__.py b/pyrs/peaks/__init__.py
@@ -0,0 +1,3 @@
+from __future__ import (absolute_import, division, print_function)  # python3 compatibility
+
+from .peak_collection import PeakCollection
diff --git a/pyrs/core/peak_collection.py → pyrs/peaks/peak_collection.py b/pyrs/core/peak_collection.py → pyrs/peaks/peak_collection.py
diff --git a/pyrs/utilities/rs_project_file.py b/pyrs/utilities/rs_project_file.py
@@ -6,7 +6,7 @@
 import os
 from pyrs.utilities import checkdatatypes
 from pyrs.core.instrument_geometry import AnglerCameraDetectorGeometry, HidraSetup
-from pyrs.core.peak_collection import PeakCollection
+from pyrs.peaks import PeakCollection
 from pyrs.dataobjects import SampleLogs
 
 

diff --git a/tests/integration/test_peak_fitting.py b/tests/integration/test_peak_fitting.py
@@ -2,7 +2,7 @@
 # Test class and methods implemented for peak fitting
 import numpy
 from pyrs.core import pyrscore
-from pyrs.core.peak_collection import PeakCollection
+from pyrs.peaks import PeakCollection
 from pyrs.core.peak_profile_utility import PeakShape, BackgroundFunction
 from pyrs.core.summary_generator import SummaryGenerator
 from pyrs.dataobjects import SampleLogs

diff --git a/tests/unit/test_hidra_project_file.py b/tests/unit/test_hidra_project_file.py
@@ -6,7 +6,7 @@
 import numpy as np
 import datetime
 from pyrs.core import peak_profile_utility
-from pyrs.core.peak_collection import PeakCollection
+from pyrs.peaks import PeakCollection
 import pytest
Original file line number	Diff line number	Diff line change
		@@ -0,0 +1,3 @@
		from __future__ import (absolute_import, division, print_function) # python3 compatibility

		from .peak_collection import PeakCollection