Skip to content

docs: clean up and add a real data XRD example#191

Merged
sbillinge merged 11 commits intodiffpy:mainfrom
john-halloran:docs-tutorial
Mar 11, 2026
Merged

docs: clean up and add a real data XRD example#191
sbillinge merged 11 commits intodiffpy:mainfrom
john-halloran:docs-tutorial

Conversation

@john-halloran
Copy link
Contributor

Closes #128.

@codecov
Copy link

codecov bot commented Mar 9, 2026

Codecov Report

❌ Patch coverage is 0% with 3 lines in your changes missing coverage. Please review.
✅ Project coverage is 57.50%. Comparing base (d7586bc) to head (0407642).
⚠️ Report is 3 commits behind head on main.

Files with missing lines Patch % Lines
tests/test_snmf_optimizer.py 0.00% 3 Missing ⚠️
Additional details and impacted files
@@             Coverage Diff             @@
##             main     #191       +/-   ##
===========================================
- Coverage   77.50%   57.50%   -20.00%     
===========================================
  Files           3        3               
  Lines          40       40               
===========================================
- Hits           31       23        -8     
- Misses          9       17        +8     
Files with missing lines Coverage Δ
tests/test_snmf_optimizer.py 63.63% <0.00%> (-36.37%) ⬇️
🚀 New features to boost your workflow:
  • ❄️ Test Analytics: Detect flaky tests, report on failures, and find test suite problems.

Copy link
Contributor

@sbillinge sbillinge left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This looks great. I am ready to merge. A couple of final cleaning tweaks (see inline).

Also, it may be a feature not a bug, but do we want (a) the dot in the data filenames? Maybe this is ok because it has meaning. (b) the filenames to order alpha-numerically? To do this we want single digits to have leading zeros, so <name>01 , 02 and so on. On balance I would say to leave the dot/point in the names but do the fix to make them sort correctly as this teaches good practice.

and weights) created by the decomposition.
objective_difference : float
n_components_ : int
Learned number of components from initialization.
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

These should all begin with "The" per group standards.

Please could we also document somewhere where it will show up in the API docs the convention (trailing underscore are attributes that are the result of the refinement)? We don't have to describe about private functions in the docs.

instability, should be used only after first selecting the best
value for rho. Suggested adjustment is by powers of 2.
source_matrix : ndarray of shape (signal_length, n_signals)
Source data matrix to decompose.
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

missing "The"'s

@sbillinge sbillinge merged commit d6b2011 into diffpy:main Mar 11, 2026
5 of 7 checks passed
@john-halloran john-halloran deleted the docs-tutorial branch March 11, 2026 06:51
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

Test the package with example data

2 participants