Skip to content

Releases: rhouhou/prCARS

Release list

v0.1.0-alpha

v0.1.0-alpha Pre-release
Pre-release

Choose a tag to compare

@rhouhou rhouhou released this 06 Jul 15:25

Initial alpha release of prCARS.

prCARS is a Python toolkit for phase retrieval, non-resonant-background correction, preprocessing, and Raman-like signal reconstruction from CARS/BCARS spectra.

Added

  • Kramers-Kronig phase retrieval workflow

  • Maximum Entropy Method retrieval workflow

  • Optional neural-network retrieval interface

  • Background estimation utilities:

    • ALS
    • polynomial fitting
    • SNIP
    • rolling-ball
  • Background correction modes:

    • subtract
    • divide
    • square-root divide
  • Denoising utilities:

    • Savitzky-Golay
    • Wiener
    • wavelet-based denoising
  • Synthetic CARS/BCARS example generation

  • Benchmark utilities for retrieval comparison

  • Reusable pipeline object for reproducible workflows

  • Tests for retrieval, preprocessing, and pipeline behavior

  • GitHub Actions CI for linting and tests

  • Citation metadata with CITATION.cff

  • Improved README with installation, quickstart, methods, limitations, and roadmap

Fixed

  • Fixed Kramers-Kronig direct phase retrieval method call
  • Updated optional neural-network tests to skip when PyTorch or TensorFlow is not installed
  • Tuned Ruff configuration for the current alpha-stage scientific codebase
  • Cleaned repository hygiene and ignored local system/generated files

Notes

  • Neural-network retrieval is experimental and requires optional backend dependencies.
  • Generated data and large outputs are not included in the repository.
  • This is an alpha-stage research and portfolio project.
  • This project is not intended for clinical diagnosis, medical decision-making, or deployment in real healthcare settings.