docs: the rc.167 changelog says what changed, once each
Build Packages / build:windows:nocuda (push) Successful in 16m40s
Build Packages / build:windows:cuda (push) Successful in 22m0s
Build Packages / build:rugnux:windows (push) Successful in 16m26s
Build Packages / build:rugnux:aarch64 (cross) (push) Successful in 8m55s
Build Packages / build:rugnux-tgz (x86_64) (push) Successful in 14m28s
Build Packages / build:viewer-tgz:cpu (push) Successful in 16m5s
Build Packages / build:viewer-tgz:cuda (push) Successful in 18m2s
Build Packages / build:rpm (rocky9_nocuda) (push) Successful in 19m34s
Build Packages / build:rpm (rocky8_nocuda) (push) Successful in 23m40s
Build Packages / build:rpm (ubuntu2204_nocuda) (push) Successful in 24m35s
Build Packages / build:rpm (ubuntu2404_nocuda) (push) Successful in 19m51s
Build Packages / build:rpm (rocky9_sls9) (push) Successful in 22m7s
Build Packages / build:rpm (rocky8_sls9) (push) Successful in 25m35s
Build Packages / build:rpm (rocky9) (push) Successful in 20m3s
Build Packages / build:rpm (rocky8) (push) Successful in 24m59s
Build Packages / XDS test (durin plugin) (push) Successful in 10m0s
Build Packages / Generate python client (push) Successful in 36s
Build Packages / Build documentation (push) Successful in 1m1s
Build Packages / Create release (push) Skipped
Build Packages / build:rpm (ubuntu2404) (push) Successful in 19m41s
Build Packages / build:rpm (ubuntu2204) (push) Successful in 22m9s
Build Packages / XDS test (JFJoch plugin) (push) Successful in 10m45s
Build Packages / XDS test (neggia plugin) (push) Successful in 9m50s
Build Packages / DIALS test (push) Successful in 18m59s
Build Packages / Unit tests (push) Successful in 1h28m11s
Build Packages / build:windows:nocuda (push) Successful in 16m40s
Build Packages / build:windows:cuda (push) Successful in 22m0s
Build Packages / build:rugnux:windows (push) Successful in 16m26s
Build Packages / build:rugnux:aarch64 (cross) (push) Successful in 8m55s
Build Packages / build:rugnux-tgz (x86_64) (push) Successful in 14m28s
Build Packages / build:viewer-tgz:cpu (push) Successful in 16m5s
Build Packages / build:viewer-tgz:cuda (push) Successful in 18m2s
Build Packages / build:rpm (rocky9_nocuda) (push) Successful in 19m34s
Build Packages / build:rpm (rocky8_nocuda) (push) Successful in 23m40s
Build Packages / build:rpm (ubuntu2204_nocuda) (push) Successful in 24m35s
Build Packages / build:rpm (ubuntu2404_nocuda) (push) Successful in 19m51s
Build Packages / build:rpm (rocky9_sls9) (push) Successful in 22m7s
Build Packages / build:rpm (rocky8_sls9) (push) Successful in 25m35s
Build Packages / build:rpm (rocky9) (push) Successful in 20m3s
Build Packages / build:rpm (rocky8) (push) Successful in 24m59s
Build Packages / XDS test (durin plugin) (push) Successful in 10m0s
Build Packages / Generate python client (push) Successful in 36s
Build Packages / Build documentation (push) Successful in 1m1s
Build Packages / Create release (push) Skipped
Build Packages / build:rpm (ubuntu2404) (push) Successful in 19m41s
Build Packages / build:rpm (ubuntu2204) (push) Successful in 22m9s
Build Packages / XDS test (JFJoch plugin) (push) Successful in 10m45s
Build Packages / XDS test (neggia plugin) (push) Successful in 9m50s
Build Packages / DIALS test (push) Successful in 18m59s
Build Packages / Unit tests (push) Successful in 1h28m11s
Thirty-seven entries for one release candidate, several of them a second line about a feature the previous line had already introduced. Consolidated to fifteen, grouped the way a reader meets the change rather than the way it was built: the analysis mode and its vocabulary in one place, what a grid scan reports and what governs it in one place, the space-group search's absence handling in one place. No change is dropped - every flag, key and dataset the long version named is still named. What goes is the repetition and the second sentences that explained why. Co-Authored-By: Claude Opus 5 <noreply@anthropic.com> Claude-Session: https://claude.ai/code/session_01EFEJG6WBQv8th4UJFNe53N
This commit is contained in:
1 parent
94ed864dbe
commit
9962dce94c
1 file changed
+15
-37
+15
-37
@@ -3,43 +3,21 @@
|
||||
|
||||
### 1.0.0-rc.167
|
||||
|
||||
* Every image carries two detection scores from 0 to 1, `protein_score` and `ice_score`, in the CBOR stream, the HDF5 file as `/entry/MX/proteinScore` and `/entry/MX/iceScore`, `GET /result/scan`, the broker plots and jfjoch_viewer.
|
||||
* jfjoch_broker takes an explicit analysis mode - `MXStills` (the default), `Azint`, `Grid`, `PowderCalibration` or `None` - through `/config/analysis`, the `analysis` block of the configuration file and the Analysis panel of the web frontend.
|
||||
* The analysis mode takes precedence over `dataset_settings.spot_finding` and `spot_finding_settings.enable`, which are deprecated.
|
||||
* Rotation MX analysis is not available in jfjoch_broker, and is processed with rugnux.
|
||||
* Each analysis method has its own settings endpoint, `/config/grid_scan_analysis` and `/config/calibration_settings`; `/config/analysis` carries the mode alone.
|
||||
* `PowderCalibration` computes the azimuthal profile on the CPU with a sector count of its own.
|
||||
* A grid scan indexes each raster cell by default; turn it off with `indexing` in `/config/grid_scan_analysis`.
|
||||
* The crystals a grid scan found reach the CBOR end message as `grid_crystals`, the HDF5 master as `/entry/MX/crystals` and `GET /result/scan`, which also carries a powder-calibration result.
|
||||
* jfjoch_viewer draws a grid scan as one map - protein in orange, ice in cyan, mixed where both are present, over the shape of the loop - with a frame around each crystal found.
|
||||
* The stream and the written file record which analysis produced them, as `analysis_mode` in the CBOR start message and `/entry/MX/analysis_mode` in the HDF5 master.
|
||||
* `rugnux --mode` accepts `mx_rotation` and `mx_stills` beside `mx`.
|
||||
* `rugnux --mode raster` reports the crystals in a stored grid scan - grid position, nearest image, measured size and orientation, score, ice score and resolution - as `<prefix>_raster_report.txt` and `<prefix>_raster.json`.
|
||||
* Where neither `--beam-size` nor the file's `incident_beam_size` states a beam, a grid scan reports the grid step in its place rather than zero, and `BEAM_SIZE_SOURCE` in the raster report says which was used.
|
||||
* `rugnux --mode raster` takes `--beam-size`, `--raster-protein-threshold`, `--raster-grow-score`, `--raster-min-cells`, `--raster-decisive-score` and `--raster-max-crystals`.
|
||||
* The per-image ice ring measure is renamed `ice_ring_ratio` (`/entry/MX/iceRingRatio`, plot type `ice_ring_ratio`); the former `ice_ring_score` spelling is still read from older files and streams and still accepted by the API.
|
||||
* `rugnux --model` reports CC(model, data) - the correlation of the merged intensities with the placed, scaled model - by resolution shell, on the same shells as CC1/2, with the reflection count and a significance for each.
|
||||
* `rugnux --model` fits the model's scale, anisotropic B and bulk-solvent parameters on the working reflections only, so the R-free it reports is measured against a model no free reflection helped scale.
|
||||
* The bulk-solvent parameters of `rugnux --model` are searched over their physically meaningful range instead of being fitted without bounds, so a model is never scaled with a solvent term that has silently switched itself off.
|
||||
* The rigid-body placement of `rugnux --model` uses the same bounded bulk solvent as the reported fit, so a model is no longer placed against a target carrying a solvent term with no physical meaning.
|
||||
* `rugnux --model` puts the model into the data's own description of the lattice before placing it, so a model whose cell is written on other axes - I-centred where the run indexed C-centred, a different unique axis, a permuted orthorhombic cell - is placed rather than scored where it was read; `MODEL_CHANGE_OF_BASIS=` and `MODEL_SETTING_AS_READ=` report it when it happens.
|
||||
* The rugnux results report opens with a summary - `VERDICT=` (`OK`, `WARNINGS`, `UNUSABLE`, `FAILED`), `VERDICT_TEXT=`, `PATHOLOGY_FLAGS=` with one closed-vocabulary code per condition that warned, and the `WARNING:` lines, which used to close the file - and the sections after it are renumbered 1-5 with no gaps.
|
||||
* `rugnux --developer` writes the full results report - the pipeline-internal keys and the long explanations the default report now leaves out - and `--finalist-ledger` adds the evidence for every space group the search considered, not only the one it adopted.
|
||||
* The results report warns when the merged data carry no usable signal and when too little of reciprocal space was measured inside the fitted resolution, and omits `FITTED_RESOLUTION` where the CC1/2 curve it is fitted on never falls off.
|
||||
* rugnux detects translational pseudo-symmetry and reports it under the `PSEUDO_TRANSLATION` flag as `TNCS_DETECTED=` and the `TNCS_*` keys - a translation the merged data are exactly invariant under is reported as `UNDECLARED_LATTICE_TRANSLATION=` under `LATTICE_TRANSLATION` instead - and a detected pseudo-translation can no longer buy a false screw axis in the space-group search or hide a twin from the L-test (`L_TEST_VS_TNCS=`).
|
||||
* The space-group search determines glide planes from zonal systematic absences, so a non-Sohncke space group such as P 2_1/c or Pbca is named where the run previously stopped at its Sohncke subgroup; `SOHNCKE_SPACE_GROUP=` carries the best Sohncke group beside it on every run that searched, and a centre of symmetry is never claimed.
|
||||
* Where the cell metric carries more rotational symmetry than the Bravais class the indexer named, the extra rotations are put to the intensities and the space-group search is asked again on the metric's own cell - adopted only where the intensities confirm the higher symmetry - so a lattice that is nearly but not exactly hexagonal, or whose reduction landed in a sub-cell, still reaches its true point group.
|
||||
* Systematic-absence calls rest on the evidence rather than on counts: a screw axis whose absent class the data show extinct is no longer refused because a handful of reflections in it read as present, and `SPACE_GROUP_ALTERNATIVES=` no longer drops a candidate that differs only on a zone the sweep never measured.
|
||||
* A reference correlation measured on too few reflections is refused instead of scored zero, so a run given a reference MTZ is no longer reindexed on an operator that mapped almost everything outside the reference's coverage.
|
||||
* A frame counts as indexed from 6 spots on its lattice rather than 9, so a weakly diffracting crystal whose frames cannot carry 9 is no longer refused the lattice it fits; `--min-indexed-spots` overrides it.
|
||||
* `-C` accepts a known cell in any equivalent description - conventional or primitive, centred or not - instead of only the reduced primitive form, so a centred cell given the way it is published no longer makes the run report that it found no lattice.
|
||||
* Each reflection is corrected for the sensor's quantum efficiency at the angle it meets the detector (attenuation lengths from the NIST tables, which also fixes the spot-width parallax term on CdTe) and for the attenuation of the flight path between the sample and its pixel; `--flight-path air|helium|vacuum` declares the medium - default air, since no file states it - and the report says what was assumed and what it was worth. The unmerged MTZ records the factors in new `QE` and `FLIGHT` columns beside `LP`, so raw counts are `I / LP * QE * FLIGHT`, and `_process.h5` in new optional `qe` and `flight` datasets.
|
||||
* Rotation geometry post-refinement fits the crystal and the detector at once, against the observed spot positions and the observed rocking angles together, so the refined distance depends far less on how wrong the file's distance was.
|
||||
* A coarsely sliced sweep integrates correctly: partials are joined into one rocking event by angle rather than by frame count, so two crossings of the Ewald sphere are no longer summed into one full, and at 0.5 degrees per image or coarser the per-frame geometry refinement accepts a spot whose miss the exposure's own rotation accounts for.
|
||||
* `rugnux --mode scale` reports the detector tilt and direct beam of the geometry it re-scaled at, instead of zeros that read as a flat detector, and no longer warns that no image was indexed on a run whose lattice came from its input file.
|
||||
* Every rotation run that determined a space group and merged reports what the mounting cost: `SPINDLE_LOST_UNIQUE_FRACTION=` is the fraction (0-1) of unique reflections the mounting made unmeasurable under the measured point group, also written to the master as `/entry/MX/spindleLostUniqueFraction` and what the mounting warning fires on; `SPINDLE_SYMMETRY_AXIS_ANGLE_DEG=` / `SPINDLE_SYMMETRY_AXIS_ORDER=` describe the mounting in the `--developer` report.
|
||||
* Stills and grid scans carry a per-image `spindle_blind_fraction` - how much of a rotation sweep's blind cone this orientation would make unrecoverable, 0.5 and above calling for a second orientation - through the CBOR stream, HDF5 (`/entry/MX/spindleBlindFraction`), the plot and scan-result APIs, and the viewer and frontend plots; an absent value means the frame could not be assessed and is not a 0.
|
||||
* The results report's `REPORT_VERSION` is 7.
|
||||
* Every image carries two detection scores from 0 to 1, `protein_score` and `ice_score` - whether there is crystal diffraction, and whether there is ice - through the CBOR stream, HDF5 (`/entry/MX/proteinScore`, `/entry/MX/iceScore`), `GET /result/scan`, the broker plots and jfjoch_viewer.
|
||||
* jfjoch_broker takes an explicit analysis mode - `MXStills` (the default), `Azint`, `Grid`, `PowderCalibration` or `None` - through `/config/analysis`, the `analysis` block of the configuration file or the web frontend; it decides what runs, takes precedence over the now-deprecated `dataset_settings.spot_finding` and `spot_finding_settings.enable`,, and is recorded in the stream and the written file as `analysis_mode`; `rugnux --mode` accepts the same `mx_rotation` and `mx_stills` beside `mx`, which still chooses between them from the goniometer.
|
||||
* Rotation MX analysis is not available in jfjoch_broker and is processed with rugnux; every other method carries its own settings on its own endpoint, `/config/grid_scan_analysis` and `/config/calibration_settings`, and `PowderCalibration` computes the azimuthal profile on the CPU with a sector count of its own.
|
||||
* A grid scan finds the crystals in the finished map and reports them - grid position, nearest image, measured size and orientation, score, ice score and resolution - through the CBOR end message (`grid_crystals`), the HDF5 master (`/entry/MX/crystals`) and `GET /result/scan`; `/config/grid_scan_analysis` governs what counts as one - the protein-score threshold, the grow threshold, the minimum cells per crystal, the decisive single-cell score, the crystal cap, and whether each cell is indexed, which it is by default.
|
||||
* jfjoch_viewer draws a grid scan as one map - protein in orange, ice in cyan, mixed where both are present, over the shape of the loop - with a frame around each crystal found, at its own orientation.
|
||||
* `rugnux --mode raster` runs the same analysis over a stored grid scan and writes `<prefix>_raster_report.txt` and `<prefix>_raster.json`; `--beam-size` states the beam the reported sizes still contain, and where neither it nor the file says, the grid step is reported in its place rather than zero.
|
||||
* The per-image ice ring measure is renamed `ice_ring_ratio` (`/entry/MX/iceRingRatio`, plot type `ice_ring_ratio`); the retired `ice_ring_score` spelling is still read from older files and streams, and still accepted by the API.
|
||||
* `rugnux --model` reports CC(model, data) by resolution shell on the same shells as CC1/2, with the reflection count and a significance for each, and fits the model's scale, anisotropic B and bulk solvent on the working reflections only, so the R-free is measured against a model no free reflection helped scale.
|
||||
* The bulk solvent of `rugnux --model` is searched over its physically meaningful range, in the reported fit and in the rigid-body placement alike, and the model is put into the data's own description of the lattice before it is placed - so a model whose cell is written on other axes is placed rather than scored where it was read, which `MODEL_CHANGE_OF_BASIS=` and `MODEL_SETTING_AS_READ=` report.
|
||||
* The rugnux results report opens with a summary - `VERDICT=`, `VERDICT_TEXT=`, `PATHOLOGY_FLAGS=` and the `WARNING:` lines that used to close the file - with the sections after it renumbered 1-5, new warnings where the merged data carry no usable signal or too little of reciprocal space was measured, and `REPORT_VERSION=` 7; `--developer` writes the full report and `--finalist-ledger` the evidence for every space group the search considered.
|
||||
* The space-group search determines glide planes from zonal systematic absences, so a non-Sohncke group such as P 2_1/c or Pbca is named where the run previously stopped at its Sohncke subgroup, with `SOHNCKE_SPACE_GROUP=` beside it and a centre of symmetry never claimed; absence calls rest on the evidence rather than on counts, rotational symmetry the cell metric carries beyond the named Bravais class is put to the intensities and adopted where they confirm it, and translational pseudo-symmetry is detected and reported (`PSEUDO_TRANSLATION`, `TNCS_*`) so that it can no longer buy a false screw axis.
|
||||
* `-C` accepts a known cell in any equivalent description rather than only the reduced primitive form, a frame counts as indexed from 6 spots on its lattice rather than 9 (`--min-indexed-spots` overrides), and a reference correlation measured on too few reflections is refused instead of scored zero.
|
||||
* Each reflection is corrected for the sensor's quantum efficiency at the angle it meets the detector and for the attenuation of the flight path between sample and pixel; `--flight-path air|helium|vacuum` declares the medium, default air.
|
||||
* Rotation geometry post-refinement fits the crystal and the detector together against spot positions and rocking angles, a coarsely sliced sweep integrates correctly with partials joined into one rocking event by angle rather than by frame count, and `rugnux --mode scale` reports the geometry it re-scaled at instead of zeros that read as a flat detector.
|
||||
* Every rotation run that merged reports what the mounting cost as `SPINDLE_LOST_UNIQUE_FRACTION=` (also `/entry/MX/spindleLostUniqueFraction`), and stills and grid scans carry a per-image `spindle_blind_fraction` through the CBOR stream, HDF5, the plot and scan-result APIs, and the viewer and frontend plots.
|
||||
|
||||
### 1.0.0-rc.166
|
||||
|
||||
|
||||
Reference in new issue
Block a user