v0.21.0 – 2024-04-26

Summary

This is a pretty large release with lots of changes, new features and a couple of API breaking changes, see below.

The headline feature is that through a lot of work, the ImPACT reconstructor works again.

For the full changelog, see https://ctapipe.readthedocs.io/en/stable/changelog.html#ctapipe-v0-21-0-2024-04-26, for contributors and list of merged PRs, see below.

Contributors

@Hckjs, @LukasBeiske, @LukasNickel, @StFroese, @Tobychev, @aknierim, @ccossou, @dependabot, @dependabot[bot], @gschwefer, @kosack, @maxnoe, @morcuended and @nbiederbeck

What has changed since v0.20.0

Pull-requests containing changes of multiple nature are repeated.

• Prepare changelog for 0.21.0 (#2550) @maxnoe
• Update to bokeh 3 (#2549) @maxnoe
• Compute deconvolution parameters in FlashCamExtractor only as needed (#2545) @maxnoe
• Fix possible out of bounds error in FlashCamExtractor (#2544) @maxnoe
• Fix CI (#2547) @maxnoe
• Add function to get point on shower axis in altaz (#2537) @maxnoe
• Update ImPACT code to work again (#2305) @Tobychev
• Bump JamesIves/github-pages-deploy-action from 4.5.0 to 4.6.0 (#2538) @dependabot
• Interpolate pointing in TableLoader and HDF5EventSource (#2409) @maxnoe
• add SonarQube badges & remove codecov (#2531) @kosack
• Overburden-to-height conversion functions (#2422) @gschwefer
• Add a trait for astropy quantities (#2524) @LukasBeiske
• Add configuration for using CTAO sonarqube to check code (#2463) @maxnoe
• Add a note to CameraGeometry docs about from_name() (#2485) @kosack
• Fix entry point specification (#2516) @maxnoe
• Use signal_fraction for training particle classifier (#2465) @LukasBeiske
• fix some documentation bugs (#2514) @kosack
• Test on python 3.12 (#2486) @maxnoe
• Bump pre-commit/action from 3.0.0 to 3.0.1 (#2510) @dependabot
• Bump codecov/codecov-action from 3 to 4 (#2509) @dependabot
• Bump release-drafter/release-drafter from 5 to 6 (#2508) @dependabot
• Bump andstor/file-existence-action from 2 to 3 (#2506) @dependabot
• Improve logging colorization, fixes #2504 (#2505) @maxnoe
• Fix wrong branch name in README (#2502) @maxnoe
• Fix pydata sphinx theme is not safe for parallel writing warning (#2500) @maxnoe
• Bump actions/cache from 3 to 4 (#2498) @dependabot
• Load constant pointing in TableLoader (#2481) @maxnoe
• Accept CEP 002 (#2400) @kosack
• Bump actions/checkout from 3 to 4 (#2492) @dependabot
• Bump JamesIves/github-pages-deploy-action from 3.7.1 to 4.5.0 (#2494) @dependabot
• Bump actions/upload-artifact from 3 to 4 (#2493) @dependabot
• Bump actions/setup-python from 4 to 5 (#2495) @dependabot
• Update citation year and add link (#2487) @maxnoe
• Write out cross-validation results immediately (#2483) @LukasBeiske
• Update and add missing docstrings related to ML functionalities (#2456) @LukasBeiske
• Let the DispReconstructor also compute a score for the sign prediction (#2479) @maxnoe
• Allow passing of ax to Subarray.peek, do not always call tight_layout (#2369) @maxnoe
• Change how DataWriter writes simulation pointing (#2438) @maxnoe
• Add missing cache=True to numba compilation (#2477) @maxnoe
• Docs: Fix Headings in Docs [Closes #2472] (#2474) @aknierim
• Allow setting n_jobs on tool invocation (#2430) @LukasNickel
• Update citation (#2470) @maxnoe
• Make ML config files more readable and add comments. (#2455) @LukasBeiske
• Remove python warnings (#2421) @LukasNickel
• Enable str/Path as input to get_hdf5_datalevels (#2451) @maxnoe
• Add true_impact_distance to cross validation output (#2468) @LukasBeiske
• Chunked loading of training data (#2423) @LukasBeiske
• Rename single changelog file (#2435) @StFroese
• Removed stray : from ctapipe.io page (#2448) @Tobychev
• Bump setuptools and setuptools scm versions (#2447) @morcuended
• Propose CEP 3: remove image parameters in camera frame (#2405) @maxnoe
• run test only if labels don't contain 'documentation' (#2227) @nbiederbeck
• Fix unwanted default columns in disp output (#2440) @maxnoe
• Add docstring for ctapipe-train-disp-reconstructor (#2420) @LukasBeiske
• Check pointing coordinate frame in DispReconstructor (#2431) @LukasBeiske
• Check if tel_id exists when looking up TelescopeParameters (#2429) @maxnoe
• Fix broken urls in README (#2408) @aknierim
• Fix h_max definition (#2403) @kosack
• Do not use hidden attribute reconstructor._models in ctapipe-apply-models (#2418) @LukasBeiske
• Changed some numpy calls following the numpy 2.0 migration guide (#2406) @Tobychev
• Include example config for ctapipe-train-disp-reconstructor in quickstart tool (#2414) @LukasBeiske
• Fix empty reference location (#2402) @kosack

New features

• Change R1- and DL0-waveforms shape to (n_channels, n_pixels, n_samples) (#2529) @Hckjs
• Change ImageCleaner API (#2511) @Hckjs
• Use intmin for invalid pixel positions, allow empty arguments (#2397) @maxnoe
• Add option to override obs_id in SimTelEventSource (#2411) @maxnoe

API Changes

• Change ImageCleaner API (#2511) @Hckjs
• Refactor/rename datawriter options (redux) (#2520) @kosack
• Move TableLoader traits to read_...-methods (#2482) @Hckjs

Data Model Changes

• Change R1- and DL0-waveforms shape to (n_channels, n_pixels, n_samples) (#2529) @Hckjs
• Change definition of leakage_pixel_{1,2} (#2432) @maxnoe
• Improve column names for disp (#2443) @LukasBeiske
• Add option to override obs_id in SimTelEventSource (#2411) @maxnoe

Bug Fixes

• Properly transform between camera and telescope frame in muon fitter (#2464) @maxnoe

Refactoring and Optimization

• Prevent import of ctapipe.image at import time of ctapipe.io (#2488) @maxnoe

Maintenance

• Use macos 14 (apple arm) in CI (#2534) @maxnoe
• Fix docs build, use sphinxcontrib-bibtex for bibliography (#2536) @maxnoe
• Drop python 3.9 (#2526) @maxnoe
• Fix sonar complaining about statements in notebooks (#2527) @maxnoe
• Update sonar key (#2525) @maxnoe
• Update python version in deploy config (#2523) @maxnoe
• Use ruff for linting (#2416) @maxnoe
• Move options from setup.cfg to pyproject.toml (#2512) @maxnoe
• Switch to src based repository structure (#2459) @maxnoe
• pin scikit-learn to < 1.4, breaks with astropy tables (#2496) @maxnoe
• Add config to let dependabot update github actions (#2490) @maxnoe
• Fix some minor issues found by sonarqube (#2466) @maxnoe
• Move TableLoader traits to read_...-methods (#2482) @Hckjs
• Fix docstring of EventSource (#2419) @maxnoe
• Support for astropy 6 (#2475) @maxnoe
• Fix indentation in docs resulting in wrong rendering (#2462) @maxnoe
• Fix CI after pytest-xdist update (#2469) @maxnoe
• Use editable install to fix coverage (#2460) @maxnoe
• Fix coverage report not being found by codecov (#2458) @maxnoe
• Add more nitpick ignores to fix docs build after traitlets update (#2412) @maxnoe
• Fix docs by adding more traitlets nitpick ignores (#2399) @maxnoe