Increase required pydigitalwavetools to 1.2

[csantosb]

Details

New behavior

Provided that pydigitalwavetools 1.2 is already 3 years old, would it be possible to relax the constraint on release 1.1 ?

Motivation

My question relates to packaging and distributing hls4ml under Guix, which includes pydigitalwavetools in its latest release, 1.2.

Parts of hls4ml being affected

I'm referring here to the dependencies array in pyproject.toml file.

Tests

I have run the following tests to check that upgrading to 1.2 doesn’t break things.

First, create a disposable, isolated shell container with all dependencies

guix shell -CNP -m manifest.scm

Inside the shell:

export SSL_CERT_FILE=$GUIX_ENVIRONMENT/etc/ssl/certs/ca-certificates.crt

# install missing deps, not yet packaged in guix
pip3 install qonnx
pip3 install qkeras
pip3 install hgq

Install latest revision, with pydigitalwavetools==1.2, and run the tests

pip3 install .

Finally, the manifest.scm file with all available dependencies

(specifications->manifest
 (list
  "python-ipython"
  "python-bitstring"
  "python-pydigitalwavetools"
  "python-h5py"
  "python-sympy"
  "python-pyyaml"
  "python-pip"
  "python-pytorch"
  "python-coloredlogs"
  "python-humanfriendly"
  "python-toposort"
  "python-pytest"
  "python-keras"
  "python-tensorflow"
  "python-pandas"
  "python-scikit-learn"
  "python-seaborn"
  "onnx"
  "python-bitstring"
  "python-protobuf"
  "nss-certs"
  "git"))

[vloncar]

We're using pyDigitalWaveTools' VcdParser to parse the generated waveform. Does that still work with the new change? It should, given the change between 1.1 and 1.2 is small and doesn't break the API, but we should test to be sure.

Also, why do you want to distribute hls4ml under Guix?

[Magnolia2423]

Thanks for the response.

Regarding VcdParser: it continues to work correctly with pyDigitalWaveTools 1.2. I tested hls4ml with pyDigitalWaveTools==1.2 in an isolated Guix shell environment and ran the full test suite without observing any regressions. The VcdParser API and behavior appear unchanged between versions 1.1 and 1.2.

Regarding Guix: the motivation is to package and distribute hls4ml within the GNU Guix ecosystem, which focuses on reproducible, declarative, system-level package management. Guix currently provides pyDigitalWaveTools 1.2, and the strict version constraint in pyproject.toml makes packaging more difficult without carrying downstream patches. Relaxing the constraint would allow cleaner integration while remaining compatible with existing pip-based workflows.

I’d be happy to open a PR to relax the dependency constraint or add a small test covering the VcdParser use case, if that would be helpful.

[bo3z]

Thanks for the suggestion and, yes, adding a PR which relaxes the constraint and adds a test would be helpful.

[Magnolia2423]

Thanks for the suggestion! I checked again and it looks like the dependency constraint is already aligned with upstream main, so there’s no diff to submit at the moment. I’ll keep an eye out for a related issue or follow up if a change is needed, and I can add a PR with a test if required.