1.0.0

First stable release following a complete rewrite, because clfd was in danger of becoming legacy code. It is now ready for the Python 3.10+ era. From a CLI app user perspective, the core algorithms remain exactly the same, and the only notable addition is the generation of nice PNG report plots. Most of the work consisted in improving code quality, removing superfluous dependencies, setting up a continuous integration pipeline where each commit is tested in a docker container where PSRCHIVE is available, and substantially improving the test suite. A number of minor bugs were found and fixed as a result.

Added

• CLI app now saves both a report and an associated PNG plot for each archive processed.
• Report plots now show all the data in one figure: feature values, profile mask and time-phase spike mask (if spike removal was performed).

Fixed

• Formula for autocorrelation feature acf has been corrected.
• CLI app now checks whether PSRCHIVE python bindings are installed.
• CLI app now checks that there are no duplicate input archive names when --outdir is specified. Before, there could be name collisions between output files.
• CLI app now validates feature names.

Changed

• Minimum required Python version is now 3.9.
• By default, CLI app now uses as many parallel processes as there are CPU cores.
• CLI app won't crash if there are archives that cannot be processed. Instead, the name of the offending archive is logged with the error traceback. This choice was made because the app uses multiprocessing.
• Reports are now in a custom JSON format. They can be read using Report.load().
• matplotlib is now a required dependency.
• Removed dependencies: pandas, tables, scipy.

Removed

• CLI app argument --fmt. It was pointless considering that the only supported data format is PSRCHIVE.
• CLI app argument -e, --ext. The additional extension given to clean output archives is now always .clfd, which used to be the default choice.