Releases: CHESSComputing/ChessAnalysisPipeline
v2026.04.28
What's Changed
Fixed Pydantic sphinx autodoc issues on Github deployment
Removed all Python pipeline item (processor, reader and writer) classes imports except for those required by the Pydantic sphinx autodoc bot from all (sub)package level __init__.py files. This benefits the overall setup speed of running any workflow, but does result in a change in how processors, readers and writers are called from the pipeline.yaml. Previously, they could be called from the packet level, going forward they should be called from the module level. For example:
⋮
- common.YAMLReader:
filename: energy_calibration_result.yaml
schema: edd.models.MCAEnergyCalibrationConfig
- edd.MCATthCalibrationProcessor:
⋮
- common.YAMLWriter:
filename: tth_calibration_result.yaml
force_overwrite: true
Should be modified to:
⋮
- common.reader.YAMLReader:
filename: energy_calibration_result.yaml
schema: edd.models.MCAEnergyCalibrationConfig
- edd.processor.MCATthCalibrationProcessor:
⋮
- common.writer.YAMLWriter:
filename: tth_calibration_result.yaml
force_overwrite: true
Note that for now the code will stay backward compatible with the old style pipeline.yaml files. However, it may become deprecated at a future time, so it is strongly suggested to update pipeline.yaml files to the new style going forward.
Pull request log
- Merge pull request #274 from CHESSComputing/dev by @rolfverberg in #275
- Merge main back into docs by @rolfverberg in #276
- perf: try removing imports from init's by @rolfverberg in #280
- build: add a manual pages deployment workflow by @rolfverberg in #281
- Docs: Fixing Pydantic sphinx issues on Github deployment by @rolfverberg in #282
- Merge pull request #275 from CHESSComputing/main by @rolfverberg in #283
Full Changelog: v2026.04.24...v2026.04.28
v2026.04.24
What's Changed
EDD
- Changed the default minimum d-spacing to 0.35 in various EDD configs and processors
- Added HKL and fitted peak info to the NeXus output
- Added HKL based strain results to strain analysis NeXus output
- Added HKL strains object for the unconstrained fit results in the strain analysis NeXus output file
GIWAXS
- Added presample intensity correction
- Implemented wedge correction using native pyFAI methods
SAXSWAXS
- Implemented the full SAXSWAXS workflow in CHAP replacing the former SAXSWAXSWorkflow codebase
Tomo
- Added presample intensity correction
- Split the former combined Tomo workflow processor into individual ones aligned with the workflow steps and conforming with the * CHAP processor/reader/writer conventions
- Updated the tomography test cases with these updated processors
- Modified the tomography center axis finding tool and created a GUI for interactive center finding
- Brought Tomo up to date with FOXDEN and implemented FOXDEN for a test case using simulated raw data
- Tested and created a script based CHAP workflow example for Tomo
Raw data map reader/processor
- Added spec_motor_static, scan_start_time, and scan_step_index options to PointBtPointScanData.data_type
CLI
- Added --regex CLI option for matching sub-pipeline names
- Added --batch CLI option for running sub-pipelines as separate parallel processes
Fitting
- Added Lorentzian and PseudoVoigt models to regular and multipeak fitting
(for use in EDD, but also available for any other workflow)
Documentation
- Added an introduction
- Added installation instructions
- Added instructions to run CHAP workflows CHAP on the CHESS Linux system
- Added pipeline file creation instructions
- Added initial GIWAXS and SAXSWAXS documention and updated the Tomo and EDD documentation
- Updated the Reference Guide docstrings for the entire code base
Pull request log
- Update the workflow docs with the current release and add saxswaxs and introduction by @rolfverberg in #240
- fix: fixed EDD and GIWAXS bugs after test runs with new release by @rolfverberg in #241
- doc: update SAXSWAXS.md by @keara-soloway in #242
- doc: update SAXSWAXS.md (#242) by @keara-soloway in #243
- doc: update SAXSWAXS.md by @keara-soloway in #244
- add: more options for PointByPointScanData.data_type by @keara-soloway in #245
- add: NumpyStackProcessor, NumpySumProcessor, NumpyToNXfieldProcessor by @keara-soloway in #246
- feat: regex for matching subpipeline names on CLI by @keara-soloway in #249
- Add HKL based strains to EDD strain analysis results by @rolfverberg in #250
- feat: --batch CLI option by @keara-soloway in #251
- fix: ZarrWriter argument configuration by @keara-soloway in #252
- fix: fixed per HKL strain errors for EDD for missing peaks by @rolfverberg in #253
- fix: ZarrValuesWriter argument configuration by @keara-soloway in #254
- add: added Lorentzian and PseadoVoigt models to multipeak fitting by @rolfverberg in #255
- fix: fixed errors in fitting with PseudoVoigt by @rolfverberg in #256
- fix: fixed fitting bug due to adding PseadoVoigt by @rolfverberg in #257
- Remove returns from Writers unless desired by @rolfverberg in #258
- fix: fixed bug in return of pipeline.get_pipelinedata_item() by @rolfverberg in #261
- Update Tomo example with FOXDEN use by @rolfverberg in #262
- fix: fixed single plane center finding using scripted tomo recon by @rolfverberg in #265
- Merging docs after updating docstrings and linting all modules. by @rolfverberg in #270
- fix: fixes after testing EDD, GIWAXS, SAXSWAXS, Tomo after merge by @rolfverberg in #272
- Merge main into dev by @rolfverberg in #273
- Merge dev into main by @rolfverberg in #274
Full Changelog: v2026.02.25...v2026.04.24
v2026.02.25
What's Changed
- Saxswaxs by @rolfverberg in #184
- Saxswaxs structural organization by @keara-soloway in #190
- Pick up PipelineData behavior changes by @keara-soloway in #193
- Merge updates to CHAP.common by @keara-soloway in #202
- Update UnstructuredToStructuredProcessor, ZarrToNexusProcessor by @keara-soloway in #207
- fix: live data processing by @keara-soloway in #208
- Optimize outputs for common.ExpressionProcessor, saxswaxs.*CorrectionProcessor by @keara-soloway in #210
- add: saxswaxs.UnstructuredToStructuredProcessor by @keara-soloway in #224
- fix: bug in EDD strain mean data calculation by @rolfverberg in #225
- Fixed MapProcessor and EDD when all independent dims in the map are constant by @rolfverberg in #226
- fix: pydantified common.ImageProcessor by @rolfverberg in #227
- fix: rel_height_cutoff>0 in EDD strain analysis not working with scipy by @rolfverberg in #229
- Saxswaxs: docs and Zarr corrections by @keara-soloway in #230
- merge: pydantic refactor & CHAP.saxswaxs by @keara-soloway in #231
- ROI option for Tomo and fixed issue in init tth for EDD by @rolfverberg in #233
- Saxswaxs 2026-1 by @keara-soloway in #234
- feat: allow MapProcessor to work with no detectors when fill_data is False by @keara-soloway in #235
- 2026-1 by @keara-soloway in #236
- add: raw_data flag for saxswaxs setup / update processors by @keara-soloway in #237
- Minor changes after saxswaxs merge by @rolfverberg in #239
Full Changelog: v1.0.0...v2026.02.25
v1.0.0
What's Changed
- doc: made fixes to issues found during deployment by @rolfverberg in #223
Full Changelog: v0.0.18...v1.0.0
v0.0.18.dev1: Merge pull request #223 from rolfverberg/main
doc: made fixes to issues found during deployment
v0.0.18: Merge pull request #222 from rolfverberg/main
update to newest packages for python 3.10
v0.0.17.dev8: Merge pull request #220 from rolfverberg/main
docs: fixed "make html" error in Sphinx autodoc
v0.0.17.dev7: Merge pull request #219 from rolfverberg/main
docs: add missing docs/environment.yml
v0.0.17.dev6
Update pages-deploy.yml
v0.0.17.dev5: Merge pull request #218 from rolfverberg/main
docs sphinx autodoc with github workflow mamba env