You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: CHANGELOG.rst
+79
Original file line number
Diff line number
Diff line change
@@ -4,6 +4,85 @@ Release Notes
4
4
5
5
.. current developments
6
6
7
+
3.6.0
8
+
=====
9
+
10
+
**Added:**
11
+
12
+
* unit tests for initializing DiffractionObject with empty array in xarray and yarray
13
+
* function to return the index of the closest value to the specified value in an array.
14
+
* functions to convert between d and q
15
+
* catch division by zero warning messages in tests
16
+
* functionality to raise useful warning and error messages during angular conversion between two theta and q
17
+
* Improved API documentation in `DiffractionObject` methods and properties using the NumPy docstring format and PEP 256
18
+
* validate xtype belongs to XQUANTITIES during DiffractionObject init
19
+
* Group's Pytest practices for using @pytest.mark.parametrize in test_diffraction_objects.py
20
+
* unit tests for __add__ operation for DiffractionObject
21
+
* Better wording on the capture user info functionality
22
+
* Spelling check via Codespell in pre-commit
23
+
* prettier pre-commit hook for automatic linting of .yml, .json, and .md files
24
+
* Function that can be used to compute muD (absorption coefficient) from a file containing an absorption profile
25
+
from a line-scan through the sample
26
+
* sbillinge username as the authorized admin for GitHub release workflow in `build-wheel-release-upload.yml`
27
+
* function to compute x-ray attenuation coefficient (mu) using XrayDB
28
+
* class docstring for `DiffractionObject`
29
+
* docforamtter in pre-commit for automatic formatting of docstrings to PEP 257
30
+
* Function nsinterp for automatic interpolation onto the Nyquist-Shannon grid.
31
+
* functionality to return the 2D array based on the specified xtype
32
+
* functionality in dump to allow writing data on dspace
33
+
* addition, multiplication, subtraction, and division operators between two DiffractionObject instances or a scalar value with another DiffractionObject for modifying yarray (intensity) values.
34
+
* functionality to rescale diffraction objects, placing one on top of another at a specified point
35
+
* new feature in `scale_to()`: default scaling is based on the max q-value in each diffraction object.
36
+
* functions to convert between d and tth
37
+
* unit test for expected warning when no wavelength is provided for DiffractionObject init
38
+
* copy() method for DiffractionObject instance
39
+
* docstrings for `on_q`, `on_tth`, `on_d`, and `dump` in `diffraction_objects.py`.
40
+
* prevent direct modification of `all_arrays` using `@property`
41
+
* Information on how to update the default user information
42
+
* Example docs for basic DiffractionObject usage
43
+
* deploy github pages documentation on pre-release
44
+
* Gettable `id` property to `DiffractionObject`
45
+
46
+
**Changed:**
47
+
48
+
* Refactor get_user_info to separate the tasks of getting the info from config files
49
+
and creating config files when they are missing.
50
+
* test comment format with compact style without extra line for each comment
51
+
* Rename `input_scattering_quantity` to `input_data` in `DiffractionObject` init
52
+
* refactor `q_to_tth()` and `tth_to_q()` into `diffpy.utils.transforms` to make them available outside
53
+
DiffractionObject
54
+
* Moved resampler out of parsers, new path is diffpy.utils.resampler
55
+
* Rename the `isfloat` function to `is_number`, and move it to the `diffpy/utils/utilsvalidators.py` directory
56
+
* arrays and attributes now can be inserted when a DiffractionObject is instantiated
57
+
* data are now stored as a (len(x),4) numpy array with intensity in column 0, the q, then tth, then d
58
+
* `DiffractionObject.on_q`, `...on_tth` and `...on_d` are now methods and called as `DiffractionObject.on_q()` etc.`
59
+
* \tests directory tree to match \src
60
+
* DiffractionObject's "id" property renamed to "uuid"
61
+
* `DiffractionObject` requires 3 input parameters of `xarray`, `yarray`, `xtype`, to be instantiated. It can be instantiated with empty arrays.
62
+
* Paths in our documentation reflect changes made in code.
63
+
* Enumerated list for the different ways to set user information
64
+
65
+
**Deprecated:**
66
+
67
+
* `resample` function in resampler. Replaced with `wsinterp` with better functionality.
68
+
* Diffraction_object class, renamed to DiffractionObject
69
+
70
+
**Fixed:**
71
+
72
+
* additional information to users to relieve frustration in finding how to update global config
73
+
* Unittest to Pytest migration for test_loaddata.py
74
+
* file paths of the test files according to new \tests directory tree
75
+
* Typo for get_package_info example
76
+
* return type of `get_array_index` method in `DiffractionObject` to return integer instead of list
77
+
78
+
**Removed:**
79
+
80
+
* scattering_objects layer in importing diffraction_objects
81
+
* `user_config.py`. Replaced by `_load_config` and `check_and_build_global_config` in `tools.py`.
82
+
* Relative imports in parser's __init__.py
83
+
* `set_angles_from_list`, `set_angles_from`, `set_qs_from_range` methods in `DiffractionObject`
0 commit comments