diff --git a/doc/source/api/diffpy.utils.rst b/doc/source/api/diffpy.utils.rst index b873c333..2513e821 100644 --- a/doc/source/api/diffpy.utils.rst +++ b/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: diff --git a/doc/source/api/diffpy.utils.scattering_objects.rst b/doc/source/api/diffpy.utils.scattering_objects.rst deleted file mode 100644 index 4607ad98..00000000 --- a/doc/source/api/diffpy.utils.scattering_objects.rst +++ /dev/null @@ -1,28 +0,0 @@ -:tocdepth: -1 - -diffpy.utils.scattering_objects package -======================================= - -.. automodule:: diffpy.utils.scattering_objects - :members: - :undoc-members: - :show-inheritance: - -Submodules ----------- - -diffpy.utils.scattering_objects.diffraction_objects module -^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ - -.. automodule:: diffpy.utils.scattering_objects.diffraction_objects - :members: - :undoc-members: - :show-inheritance: - -diffpy.utils.scattering_objects.user_config module -^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ - -.. automodule:: diffpy.utils.scattering_objects.user_config - :members: - :undoc-members: - :show-inheritance: diff --git a/doc/source/examples/diffractionobjectsexample.rst b/doc/source/examples/diffractionobjectsexample.rst index f3114ab0..48409432 100644 --- a/doc/source/examples/diffractionobjectsexample.rst +++ b/doc/source/examples/diffractionobjectsexample.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() diff --git a/doc/source/utilities/diffractionobjectsutility.rst b/doc/source/utilities/diffractionobjectsutility.rst index d388e856..94cb1308 100644 --- a/doc/source/utilities/diffractionobjectsutility.rst +++ b/doc/source/utilities/diffractionobjectsutility.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. diff --git a/news/scattering_obt.rst b/news/scattering_obt.rst new file mode 100644 index 00000000..0090b88e --- /dev/null +++ b/news/scattering_obt.rst @@ -0,0 +1,23 @@ +**Added:** + +* + +**Changed:** + +* + +**Deprecated:** + +* + +**Removed:** + +* scattering_objects layer in importing diffraction_objects + +**Fixed:** + +* + +**Security:** + +* diff --git a/src/diffpy/utils/scattering_objects/diffraction_objects.py b/src/diffpy/utils/diffraction_objects.py similarity index 100% rename from src/diffpy/utils/scattering_objects/diffraction_objects.py rename to src/diffpy/utils/diffraction_objects.py diff --git a/src/diffpy/utils/scattering_objects/__init__.py b/src/diffpy/utils/scattering_objects/__init__.py deleted file mode 100644 index 08069c20..00000000 --- a/src/diffpy/utils/scattering_objects/__init__.py +++ /dev/null @@ -1,19 +0,0 @@ -#!/usr/bin/env python -############################################################################## -# -# diffpy.utils by DANSE Diffraction group -# Simon J. L. Billinge -# (c) 2010 The Trustees of Columbia University -# in the City of New York. All rights reserved. -# -# File coded by: Simon Billinge -# -# See AUTHORS.txt for a list of people who contributed. -# See LICENSE_DANSE.txt for license information. -# -############################################################################## - -"""Scattering objects -""" - -# End of file diff --git a/src/diffpy/utils/scattering_objects/user_config.py b/src/diffpy/utils/user_config.py similarity index 100% rename from src/diffpy/utils/scattering_objects/user_config.py rename to src/diffpy/utils/user_config.py diff --git a/tests/diffpy/utils/scattering_objects/test_diffraction_objects.py b/tests/diffpy/utils/test_diffraction_objects.py similarity index 98% rename from tests/diffpy/utils/scattering_objects/test_diffraction_objects.py rename to tests/diffpy/utils/test_diffraction_objects.py index ada14ff1..1bc5220e 100644 --- a/tests/diffpy/utils/scattering_objects/test_diffraction_objects.py +++ b/tests/diffpy/utils/test_diffraction_objects.py @@ -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 = [