Skip to content

Release: merge develop into master #156

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.

Sign up for GitHub

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
AndrewSazonov merged 3 commits into from
Apr 14, 2026
Merged

Release: merge develop into master #156

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
559f3f3
Backmerge: master (v0.13.0) into develop [skip ci]
Apr 13, 2026
b3011a6
Improve reporting and plotting, switch default minimizer to LMFIT, an…
AndrewSazonov Apr 14, 2026
aaa9927
Fix data access to external resources (#155)
AndrewSazonov Apr 14, 2026
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
138 changes: 81 additions & 57 deletions docs/architecture/ROADMAP.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -18,9 +18,9 @@ Legend:

---

# 1. Sample Model
# 1. Structure Model

## 1.1 Crystal Structure Parameters
## 1.1 Crystal Structure

### Space Group

Expand Down Expand Up @@ -48,35 +48,51 @@ Legend:
| Occupancy | ✅ | ✅ |
| Symmetry _wyckoff_letter_ | ✅ | ✅ |

### Atomic Displacement Parameters (ADP)
### Atomic Displacement (ADP)

| Feature | LIB | APP |
| ----------------------------------------------- | --- | --- |
| Isotropic Biso | ✅ | 🗓 |
| Isotropic Uiso | 🚧 | ✅ |
| Anisotropic Bani _B11, B22, B33, B12, B13, B23_ | 🚧 | 🗓 |
| Anisotropic Uani _U11, U22, U33, U12, U13, U23_ | 🚧 | 🗓 |
| Feature | LIB | APP |
| --------------------------------------------------- | --- | --- |
| Isotropic _Biso_ | ✅ | 🗓 |
| Isotropic _Uiso_ | 🚧 | ✅ |
| Anisotropic _Bani_ (_B11, B22, B33, B12, B13, B23_) | 🚧 | 🗓 |
| Anisotropic _Uani_ (_U11, U22, U33, U12, U13, U23_) | 🚧 | 🗓 |

---

## 1.2 Magnetic Structure Parameters
## 1.2 Magnetic Structure - EPIC

| Feature | LIB | APP |
| ------------------------------------------------------- | --- | --- |
| EPIC (Magnetic space groups, unpolarized and polarized) | 🗓 | 🗓 |
| Feature | LIB | APP |
| ----------------------------------------------------- | --- | --- |
| Magnetic Space Groups | 🗓 | 🗓 |
| Irreducible representations | 🗓 | 🗓 |
| Magnetic propagation vector (_kx, ky, kz_) | 🗓 | 🗓 |
| Magnetic moments (_mx, my, mz_) | 🗓 | 🗓 |
| Local Susceptibility (_𝜒11, 𝜒22, 𝜒33, 𝜒12, 𝜒13, 𝜒23_) | 🗓 | 🗓 |

---

# 2. Experiment Model

## 2.1 Powder Diffraction

### Fitting Methods

| Feature | LIB | APP |
| ------------------------------------- | --- | --- |
| Rietveld refinement (full pattern) | ✅ | ✅ |
| Le Bail refinement (profile matching) | 🗓 | 🗓 |
| Techniques | LIB | APP |
| ---------------------------------------------------- | ----- | ----- |
| 2.1. Powder Diffraction | ✅/🗓 | ✅/🗓 |
| 2.1.1. Common features | ✅/🗓 | ✅/🗓 |
| 2.1.2. Standard Bragg diffraction (CWL) | ✅/🗓 | ✅/🗓 |
| 2.1.2. Standard Bragg diffraction (TOF) | ✅/🗓 | ✅/🗓 |
| 2.1.3. Total Scattering (Pair-Distribution Function) | ✅/🗓 | 🗓 |
| 2.2. Single-Crystal Diffraction (CWL) | ✅/🗓 | ✅/🗓 |
| 2.2. Single-Crystal Diffraction (TOF) | ✅/🗓 | ✅/🗓 |
| 2.3. Polarized Powder Diffraction | 🗓 | 🗓 |
| 2.3.1. Flipping-rathio method (TOF) | 🗓 | 🗓 |
| 2.3.1. Flipping-rathio method (CWL) | 🗓 | 🗓 |
| 2.4. Polarized Single-Crystal Diffraction | 🗓 | 🗓 |
| 2.4.1. Flipping-rathio method (CWL) | 🗓 | 🗓 |
| 2.4.2. Flipping-rathio method (TOF) | 🗓 | 🗓 |
| 2.4.3. Spherical neutron polarimetry | 🗓 | 🗓 |

## 2.1. Powder Diffraction

## 2.1.1 Common features

### Linked Phases

Expand All @@ -90,7 +106,14 @@ Legend:
| ----------------------------------------- | --- | --- |
| Multiple regions<br>_start/end positions_ | ✅ | 🗓 |

---
## 2.1.1 Standard Bragg diffraction

### Fitting Methods

| Feature | LIB | APP |
| ------------------------------------- | --- | --- |
| Rietveld refinement (full pattern) | ✅ | ✅ |
| Le Bail refinement (profile matching) | 🗓 | 🗓 |

### Background

Expand Down Expand Up @@ -130,20 +153,12 @@ Legend:

### Peak Profile — Time-of-Flight

CrysPy peak_shape options:

- "Gauss": Jorgensen (back-to-back exponentials ⊗ Gaussian)
- "pseudo-Voigt": Jorgensen-Von Dreele (back-to-back exponentials ⊗
pseudo-Voigt)
- "type0m": Double back-to-back exponentials ⊗ pseudo-Voigt (Z-Rietveld
type 0m)

| Feature | LIB | APP |
| ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --- | --- |
| Jorgensen (back-to-back exponentials ⊗ Gaussian)<br>_Gaussian broadening σ₀, σ₁, σ₂<br>Back-to-back exponential rise α₀, α₁. Back-to-back exponential decay β₀, β₁_<br>(CrysPy) | ✅ | ✅ |
| Jorgensen-Von Dreele (back-to-back exponentials ⊗ pseudo-Voigt)<br>_Gaussian broadening σ₀, σ₁, σ₂. Lorentzian broadening γ₀, γ₁, γ₂<br>Back-to-back exponential rise α₀, α₁. Back-to-back exponential decay β₀, β₁_<br>(CrysPy) | ✅ | ✅ |
| Double back-to-back exponentials ⊗ pseudo-Voigt [Z-Rietveld type0m]<br>_Gaussian broadening σ₀, σ₁, σ₂. Lorentzian broadening γ₀, γ₁, γ₂<br>Rise α₁, α₂. Fast decay β₀₀, β₀₁. Slow decay β₁₀. Switching r₀₁, r₀₂, r₀₃_<br>(CrysPy) | ✅ | 🗓 |
| Ikeda-Carpenter ⊗ pseudo-Voigt<br>_Moderator pulse α₀, α₁, β₀, κ<br>Gaussian broadening σ². Lorentzian broadening γ_<br>(CrysFML) | 🗓 | 🗓 |
| Feature | LIB | APP |
| ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --- | --- |
| Jorgensen (back-to-back exponentials ⊗ Gaussian)<br>_Gaussian broadening σ₀, σ₁, σ₂<br>Back-to-back exponential rise α₀, α₁. Back-to-back exponential decay β₀, β₁_<br>(CrysPy "Gauss") | ✅ | ✅ |
| Jorgensen-Von Dreele (back-to-back exponentials ⊗ pseudo-Voigt)<br>_Gaussian broadening σ₀, σ₁, σ₂. Lorentzian broadening γ₀, γ₁, γ₂<br>Back-to-back exponential rise α₀, α₁. Back-to-back exponential decay β₀, β₁_<br>(CrysPy "pseudo-Voigt") | ✅ | ✅ |
| Double back-to-back exponentials ⊗ pseudo-Voigt [Z-Rietveld type0m]<br>_Gaussian broadening σ₀, σ₁, σ₂. Lorentzian broadening γ₀, γ₁, γ₂<br>Rise α₁, α₂. Fast decay β₀₀, β₀₁. Slow decay β₁₀. Switching r₀₁, r₀₂, r₀₃_<br>(CrysPy "type0m") | ✅ | 🗓 |
| Ikeda-Carpenter ⊗ pseudo-Voigt<br>_Moderator pulse α₀, α₁, β₀, κ<br>Gaussian broadening σ². Lorentzian broadening γ_<br>(CrysFML) | 🗓 | 🗓 |

| TOF profile | TOF source | Performance |
| ------------------------------------------------------------------- | ----------------------------------------------------------------- | ----------- |
Expand All @@ -154,13 +169,13 @@ CrysPy peak_shape options:

---

## 2.1.2 Total Scattering (Pair Distribution Function)
## 2.1.3 Total Scattering (Pair Distribution Function)

### Peak Profile

| Feature | LIB | APP |
| ------------------------------------------------------------------------------------------------------ | --- | --- |
| GaussianDampedSinc type<br>_cutoff q. broadening q. sharpening δ₁, δ₂<br>damping q, particle diameter_ | ✅ | 🗓 |
| Feature | LIB | APP |
| ------------------------------------------------------------------------------------------------------------------------ | --- | --- |
| Gaussian-damped sinc termination function<br>_cutoff q. broadening q. sharpening δ₁, δ₂<br>damping q, particle diameter_ | ✅ | 🗓 |

---

Expand Down Expand Up @@ -196,11 +211,20 @@ Gauss or Lorentz mosaicity distribution
| ------------------------------------ | --- | --- |
| Individual wavelength per reflection | ✅ | 🗓 |

## 2.3. Polarized Neutron Diffraction
## 2.3. Polarized Neutron Powder Diffraction - EPIC

| Feature | LIB | APP |
| ---------------------------------------------- | --- | --- |
| EPIC (powders and single crystals, FR and SNP) | 🗓 | 🗓 |
| Feature | LIB | APP |
| ---------------------------- | --- | --- |
| Flipping-rathio method (TOF) | 🗓 | 🗓 |
| Flipping-rathio method (CWL) | 🗓 | 🗓 |

## 2.3. Polarized Neutron Single Crystal Diffraction - EPIC

| Feature | LIB | APP |
| ----------------------------- | --- | --- |
| Flipping-rathio method (TOF) | 🗓 | 🗓 |
| Flipping-rathio method (CWL) | 🗓 | 🗓 |
| Spherical neutron polarimetry | 🗓 | 🗓 |

---

Expand All @@ -215,19 +239,21 @@ Gauss or Lorentz mosaicity distribution

# 4. Analysis (Fitting)

### Refinement Algorithms
### Refinement Algorithms (numerical derivatives)

| Feature | LIB | APP |
| --------------------------------------------------------------- | --- | --- |
| Levenberg–Marquardt (numerical derivatives)<br>LMFIT minimizer | ✅ | ✅ |
| Levenberg–Marquardt (analytical derivatives)<br>LMFIT minimizer | 🗓 | 🗓 |
| Derivative-free minimization<br>DFO-LS minimizer | ✅ | ✅ |
| Bayesian analysis<br>BUMPS minimizer | 🗓 | 🗓 |
| Feature | LIB | APP |
| ---------------------------------------------------- | --- | --- |
| Levenberg–Marquardt<br>LMFIT minimizer | ✅ | ✅ |
| Levenberg–Marquardt<br>LMFIT minimizer (scipy-based) | ✅ | ✅ |
| Levenberg–Marquardt<br>BUMPS minimizer | 🚧 | 🗓 |
| Derivative-free minimization<br>DFO-LS minimizer | ✅ | ✅ |
| Bayesian analysis<br>BUMPS minimizer | 🗓 | 🗓 |

### Fit Strategies

| Feature | LIB | APP |
| ---------------------------------------------------------------------------------------------------- | --- | --- |
| Single fit of one experimental data block to one/multiple structural data block | ✅ | ✅ |
| Sequential fit of experimental data blocks | ✅ | 🗓 |
| Joint fit of experimental data blocks within the same calculation engine | ✅ | 🗓 |
| Joint fit of experimental data blocks using different calculation engines<br>(e.g. CrysPy + Pdffit2) | ✅ | 🗓 |
Expand Down Expand Up @@ -292,8 +318,8 @@ Gauss or Lorentz mosaicity distribution

| Feature | LIB | APP | CLI |
| --------------------------------- | --- | --- | --- |
| List available tutorial notebooks | — | — | ✅ |
| Download tutorial notebooks | — | — | ✅ |
| List available tutorial notebooks | ✅ | — | ✅ |
| Download tutorial notebooks | ✅ | — | ✅ |

---

Expand Down Expand Up @@ -371,12 +397,10 @@ Gauss or Lorentz mosaicity distribution

---

# 10. Future Topics

Here, we list features that are not sorted into the above categories,
but are still on our radar for future development.
# 10. Unsorted features

- Restrains (soft constraints, e.g. bond lengths, angles)
- Refinement using analytical derivatives
- Global optimization algorithms (e.g. simulated annealing)
- Incommensurate structures
- 2D Rietveld refinement
Loading
Loading