Merge pull request #189 from bobleesj/remove-scattering

Remove scattering_objects folder for importing DiffractionObjects

Author: sbillinge

doc/source/api/diffpy.utils.rst

@@ -36,3 +36,20 @@ diffpy.utils.resampler module
     :members:
     :undoc-members:
     :show-inheritance:
+
+
+diffpy.utils.user_config module
+^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
+
+.. automodule:: diffpy.utils.user_config
+    :members:
+    :undoc-members:
+    :show-inheritance:
+
+diffpy.utils.diffraction_objects module
+^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
+
+.. automodule:: diffpy.utils.diffraction_objects
+    :members:
+    :undoc-members:
+    :show-inheritance:

doc/source/api/diffpy.utils.scattering_objects.rst

@@ -6,7 +6,7 @@ Diffraction Objects Example
 ###########################
 
 This example will demonstrate how to use the ``DiffractionObject`` class in the
-``diffpy.utils.scattering_objects.diffraction_objects`` module to process and analyze diffraction data.
+``diffpy.utils.diffraction_objects`` module to process and analyze diffraction data.
 
 1) Assuming we have created a ``DiffractionObject`` called my_diffraction_pattern from a measured diffraction pattern,
    and we have specified the wavelength (see Section ??, to be added),
@@ -20,7 +20,7 @@ This example will demonstrate how to use the ``DiffractionObject`` class in the
    To load the converted array, you can either call ``test.q_to_tth()`` or ``test.on_q[0]``. ::
 
     # Example: convert tth to q
-    from diffpy.utils.scattering_objects.diffraction_objects import DiffractionObject
+    from diffpy.utils.diffraction_objects import DiffractionObject
     my_diffraction_pattern.on_tth = [[0, 30, 60, 90, 120, 180], [1, 2, 3, 4, 5, 6]]
     my_diffraction_pattern.tth_to_q()
 

doc/source/examples/diffractionobjectsexample.rst

@@ -3,7 +3,7 @@
 Diffraction Objects Utility
 ===========================
 
-The ``diffpy.utils.scattering_objects.diffraction_objects`` module provides functions
+The ``diffpy.utils.diffraction_objects`` module provides functions
 for managing and analyzing diffraction data, including angle-space conversions
 and interactions between diffraction data.
 

doc/source/utilities/diffractionobjectsutility.rst

@@ -0,0 +1,23 @@
+**Added:**
+
+* <news item>
+
+**Changed:**
+
+* <news item>
+
+**Deprecated:**
+
+* <news item>
+
+**Removed:**
+
+* scattering_objects layer in importing diffraction_objects
+
+**Fixed:**
+
+* <news item>
+
+**Security:**
+
+* <news item>

news/scattering_obt.rst

@@ -4,7 +4,7 @@
 import pytest
 from freezegun import freeze_time
 
-from diffpy.utils.scattering_objects.diffraction_objects import DiffractionObject
+from diffpy.utils.diffraction_objects import DiffractionObject
 from diffpy.utils.transforms import wavelength_warning_emsg
 
 params = [