Skip to content

Remove scattering_objects folder for importing DiffractionObjects #189

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 4 commits into from
Dec 3, 2024
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
17 changes: 17 additions & 0 deletions doc/source/api/diffpy.utils.rst
Original file line number Diff line number Diff line change
Expand Up @@ -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:
28 changes: 0 additions & 28 deletions doc/source/api/diffpy.utils.scattering_objects.rst

This file was deleted.

4 changes: 2 additions & 2 deletions doc/source/examples/diffractionobjectsexample.rst
Original file line number Diff line number Diff line change
Expand Up @@ -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),
Expand All @@ -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()

Expand Down
2 changes: 1 addition & 1 deletion doc/source/utilities/diffractionobjectsutility.rst
Original file line number Diff line number Diff line change
Expand Up @@ -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.

Expand Down
23 changes: 23 additions & 0 deletions news/scattering_obt.rst
Original file line number Diff line number Diff line change
@@ -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>
19 changes: 0 additions & 19 deletions src/diffpy/utils/scattering_objects/__init__.py

This file was deleted.

Original file line number Diff line number Diff line change
Expand Up @@ -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 = [
Expand Down
Loading