deprecate Profile.loadParsedData

Author: cadenmyers13

docs/examples/coreshellnp.py

@@ -44,7 +44,7 @@ def makeRecipe(stru1, stru2, datname):
     # Load data and add it to the profile
     parser = PDFParser()
     parser.parseFile(datname)
-    profile.loadParsedData(parser)
+    profile.load_parsed_data(parser)
     profile.setCalculationRange(xmin=1.5, xmax=45, dx=0.1)
 
     # The ProfileGenerator

docs/examples/crystalpdf.py

@@ -55,7 +55,7 @@ def makeRecipe(ciffile, datname):
     # configuration steps.
     parser = PDFParser()
     parser.parseFile(datname)
-    profile.loadParsedData(parser)
+    profile.load_parsed_data(parser)
     profile.setCalculationRange(xmax=20)
 
     # The ProfileGenerator

docs/examples/crystalpdfall.py

@@ -39,7 +39,7 @@ def makeProfile(datafile):
     profile = Profile()
     parser = PDFParser()
     parser.parseFile(datafile)
-    profile.loadParsedData(parser)
+    profile.load_parsed_data(parser)
     profile.setCalculationRange(xmax=20)
     return profile
 

docs/examples/crystalpdfobjcryst.py

@@ -48,7 +48,7 @@ def makeRecipe(ciffile, datname):
     # structure being refined.
     parser = PDFParser()
     parser.parseFile(datname)
-    profile.loadParsedData(parser)
+    profile.load_parsed_data(parser)
     profile.setCalculationRange(xmax=20)
 
     # The ProfileGenerator

docs/examples/crystalpdftwodata.py

@@ -48,12 +48,12 @@ def makeRecipe(ciffile, xdatname, ndatname):
     # Load data and add it to the proper Profile.
     parser = PDFParser()
     parser.parseFile(xdatname)
-    xprofile.loadParsedData(parser)
+    xprofile.load_parsed_data(parser)
     xprofile.setCalculationRange(xmax=20)
 
     parser = PDFParser()
     parser.parseFile(ndatname)
-    nprofile.loadParsedData(parser)
+    nprofile.load_parsed_data(parser)
     nprofile.setCalculationRange(xmax=20)
 
     # The ProfileGenerators

docs/examples/crystalpdftwophase.py

@@ -45,7 +45,7 @@ def makeRecipe(niciffile, siciffile, datname):
     # Load data and add it to the profile
     parser = PDFParser()
     parser.parseFile(datname)
-    profile.loadParsedData(parser)
+    profile.load_parsed_data(parser)
     profile.setCalculationRange(xmax=20)
 
     # The ProfileGenerator

docs/examples/ellipsoidsas.py

@@ -39,7 +39,7 @@ def makeRecipe(datname):
     # properly and pass the metadata along.
     parser = SASParser()
     parser.parseFile(datname)
-    profile.loadParsedData(parser)
+    profile.load_parsed_data(parser)
 
     # The ProfileGenerator
     # The SASGenerator is for configuring and calculating a SAS profile. We use

docs/examples/nppdfcrystal.py

@@ -44,7 +44,7 @@ def makeRecipe(ciffile, grdata):
 
     pdfparser = PDFParser()
     pdfparser.parseFile(grdata)
-    pdfprofile.loadParsedData(pdfparser)
+    pdfprofile.load_parsed_data(pdfparser)
     pdfprofile.setCalculationRange(xmin=0.1, xmax=20)
 
     pdfcontribution = FitContribution("pdf")

docs/examples/nppdfsas.py

@@ -48,7 +48,7 @@ def makeRecipe(ciffile, grdata, iqdata):
     pdfprofile = Profile()
     pdfparser = PDFParser()
     pdfparser.parseFile(grdata)
-    pdfprofile.loadParsedData(pdfparser)
+    pdfprofile.load_parsed_data(pdfparser)
     pdfprofile.setCalculationRange(xmin=0.1, xmax=20)
 
     pdfcontribution = FitContribution("pdf")
@@ -66,7 +66,7 @@ def makeRecipe(ciffile, grdata, iqdata):
     sasprofile = Profile()
     sasparser = SASParser()
     sasparser.parseFile(iqdata)
-    sasprofile.loadParsedData(sasparser)
+    sasprofile.load_parsed_data(sasparser)
     if all(sasprofile.dy == 0):
         sasprofile.dy[:] = 1
 

src/diffpy/srfit/fitbase/profile.py

@@ -29,9 +29,19 @@
 from diffpy.srfit.fitbase.parameter import Parameter
 from diffpy.srfit.fitbase.validatable import Validatable
 from diffpy.srfit.util.observable import Observable
+from diffpy.utils._deprecator import build_deprecation_message, deprecated
 
 # This is the roundoff tolerance for selecting bounds on arrays.
 epsilon = 1e-8
+base = "diffpy.srfit.fitbase.profile.Profile"
+removal_version = "4.0.0"
+
+loadParsedData_dep_msg = build_deprecation_message(
+    base,
+    "loadParsedData",
+    "load_parsed_data",
+    removal_version,
+)
 
 
 class Profile(Observable, Validatable):
@@ -125,7 +135,7 @@ def __init__(self):
     yobs = property(lambda self: self._yobs)
     dyobs = property(lambda self: self._dyobs)
 
-    def loadParsedData(self, parser):
+    def load_parsed_data(self, parser):
         """Load parsed data from a ProfileParser.
 
         This sets the xobs, yobs, dyobs arrays as well as the metadata.
@@ -135,6 +145,17 @@ def loadParsedData(self, parser):
         self.setObservedProfile(x, y, dy)
         return
 
+    @deprecated(loadParsedData_dep_msg)
+    def loadParsedData(self, parser):
+        """This function has been deprecated and will be removed in version
+        4.0.0.
+
+        Please use diffpy.srfit.fitbase.profile.Profile.load_parsed_data
+        instead.
+        """
+        self.load_parsed_data(parser)
+        return
+
     def setObservedProfile(self, xobs, yobs, dyobs=None):
         """Set the observed profile.