Skip to content
Open
Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
30 commits
Select commit Hold shift + click to select a range
87aed74
Create and use load_numeric_block method in io/ascii.py
AndrewSazonov Mar 27, 2026
e50a687
Disable some rules for docs/
AndrewSazonov Mar 27, 2026
9573a56
Initial implementation of the new tutorial
AndrewSazonov Mar 27, 2026
d9e59d3
Add add_from_zip_path to Experiments collection
AndrewSazonov Mar 27, 2026
a7f0a10
Update data index hash
AndrewSazonov Mar 27, 2026
04699af
Use data from web repo
AndrewSazonov Mar 27, 2026
a6ea62f
Use another dataset
AndrewSazonov Mar 27, 2026
0e73369
Save project after every fit
AndrewSazonov Mar 27, 2026
171215f
Clean up
AndrewSazonov Mar 29, 2026
57e0b9f
Initial implementation of plotting parameter evolution
AndrewSazonov Mar 29, 2026
49d1cbe
Replace conditions category with diffrn using CIF naming
AndrewSazonov Mar 29, 2026
67739c0
Simplify extract_metadata API and make data loading explicit
AndrewSazonov Mar 30, 2026
13c6357
Fix fit_results to store snapshot parameters per experiment
AndrewSazonov Mar 30, 2026
8d27965
Clean up tutorial ed-17.py duplicate plot_param calls
AndrewSazonov Mar 30, 2026
323531c
Fix test to use save_as() matching current ProjectInfo.path default
AndrewSazonov Mar 30, 2026
752a12e
Add integer index support to CollectionBase.__getitem__
AndrewSazonov Mar 30, 2026
33d3714
Rename plot_param to plot_param_series with versus descriptor
AndrewSazonov Mar 30, 2026
8927fdf
Clean up tutorial
AndrewSazonov Mar 30, 2026
f31a6ab
Update docs with new notebook
AndrewSazonov Mar 30, 2026
e929afa
Simplify constraints API to single expression string
AndrewSazonov Mar 30, 2026
451c685
Fix docstring lint errors in CollectionBase.__getitem__
AndrewSazonov Mar 30, 2026
45d99f3
New dataset and update tutorials
AndrewSazonov Mar 30, 2026
94f32ec
Update T-scan notebook
AndrewSazonov Mar 30, 2026
7b5193b
Add fit verbosity parameter with full, short and silent modes
AndrewSazonov Mar 30, 2026
8ac94bb
Update notebook
AndrewSazonov Mar 30, 2026
81d1c32
Add project-level verbosity with full, short and silent modes
AndrewSazonov Mar 30, 2026
c529eca
Improve grammar and consistency in ed-17 tutorial
AndrewSazonov Mar 30, 2026
54f4276
Fix docstring lint errors in data loading methods
AndrewSazonov Mar 30, 2026
f7ba4fc
Merge remote-tracking branch 'origin/develop' into fit-verbosity
AndrewSazonov Mar 30, 2026
dadcf5b
Increase notebook cell timeout to 1200s for T-scan tutorial
AndrewSazonov Mar 30, 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
2 changes: 1 addition & 1 deletion .github/workflows/tutorial-tests-colab.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -41,5 +41,5 @@ jobs:

- name: Check if Jupyter Notebooks run without errors
run: >
python -m pytest --nbmake docs/tutorials/ --nbmake-timeout=600 --color=yes
python -m pytest --nbmake docs/tutorials/ --nbmake-timeout=1200 --color=yes
-n=auto
42 changes: 42 additions & 0 deletions docs/architecture/architecture.md
Original file line number Diff line number Diff line change
Expand Up @@ -689,6 +689,7 @@ It owns and coordinates all components:
| `project.analysis` | `Analysis` | Calculator, minimiser, fitting |
| `project.summary` | `Summary` | Report generation |
| `project.plotter` | `Plotter` | Visualisation |
| `project.verbosity` | `str` | Console output level (full/short/silent) |

### 7.1 Data Flow

Expand Down Expand Up @@ -721,6 +722,47 @@ project_dir/
└── hrpt.cif # One file per experiment
```

### 7.3 Verbosity

`Project.verbosity` controls how much console output operations produce.
It is backed by `VerbosityEnum` (in `utils/enums.py`) and accepts three
values:

| Level | Enum member | Behaviour |
| -------- | ---------------------- | -------------------------------------------------- |
| `full` | `VerbosityEnum.FULL` | Multi-line output with headers, tables, and detail |
| `short` | `VerbosityEnum.SHORT` | One-line status message per action |
| `silent` | `VerbosityEnum.SILENT` | No console output |

The default is `'full'`.

```python
project.verbosity = 'short'
```

**Resolution order:** methods that produce console output (e.g.
`analysis.fit()`, `experiments.add_from_data_path()`) accept an optional
`verbosity` keyword argument. When the argument is `None` (the default),
the method reads `project.verbosity`. When a string is passed, it
overrides the project-level setting for that single call.

```python
# Use project-level default for all operations
project.verbosity = 'short'
project.analysis.fit() # → short mode

# Override for a single call
project.analysis.fit(verbosity='silent') # → silent, project stays short
```

**Output styles per level:**

- **Data loading** — `full`: paragraph header + detail line; `short`:
`✅ Data loaded: Experiment 🔬 'name'. N points.`; `silent`: nothing.
- **Fitting** — `full`: per-iteration progress table with improvement
percentages; `short`: one-row-per-experiment summary table; `silent`:
nothing.

---

## 8. User-Facing API Patterns
Expand Down
Loading
Loading