`cyvcf2 = 0.30.11` leads to `ValueError: numpy.dtype size changed`

GeertvanGeest commented 1 month ago

Describe the bug In the script enhance_bcf.py, cyvcf2 v0.30.11 is used. On a mac, this leads to the error:

Traceback (most recent call last):
  File "/vp-analysis/V-pipe/workflow/rules/../scripts/enhance_bcf.py", line 6, in <module>
    from cyvcf2 import VCF, Writer
  File "/vp-analysis/work/.snakemake/conda/1fbc2ad6a7160a5db06e7f669646c611_/lib/python3.9/site-packages/cyvcf2/__init__.py", line 1, in <module>
    from .cyvcf2 import (VCF, Variant, Writer, r_ as r_unphased, par_relatedness,
  File "cyvcf2/cyvcf2.pyx", line 1, in init cyvcf2.cyvcf2
ValueError: numpy.dtype size changed, may indicate binary incompatibility. Expected 96 from C header, got 88 from PyObject

To Reproduce

curl -O 'https://raw.githubusercontent.com/cbg-ethz/V-pipe/master/utils/quick_install.sh'
bash quick_install.sh -p vp-analysis -w work

cd vp-analysis/work

# clone a specific branch of the V-pipe repository
# the two lines below can be deleted when this branch is merged into the main branch
rm -rf ../V-pipe
git clone -b gsod-rtd https://github.com/GeertvanGeest/V-pipe.git ../V-pipe

# copy the example data from the repository to your working directory
cp -r ../V-pipe/docs/example_HIV_data/* .
# check what will be run with a dry run
./vpipe -n
# run vpipe on a small HIV test dataset
# this will install all dependencies and run the pipeline
./vpipe --cores 2

Expected behavior cyvcf2 load without errors

Desktop (please complete the following information): MacOS 14.6.1 (23G93)

Possible fix

Change workflow/envs/bcftools.yaml to:

channels:
  - conda-forge
  - bioconda
dependencies:
  - bcftools = 1.13
  - cyvcf2 = 0.31.1

GeertvanGeest commented 1 month ago

Can confirm that updating to cyvcf2 = 0.31.1 fixes the issue.

gordonkoehn commented 1 month ago

Thank you, @GeertvanGeest, for reporting this in detail with a solution on hand!

May I kindly ask you to help me reproduce and understand how you came up with the dependency fix?

I've had some trouble reproducing the exact error. On my machine, I run into:

rule consensus_bcftools:
...

  File "/Users/koehng/Workspace/cyvcf_new/vp-analysis/V-pipe/workflow/rules/../scripts/enhance_bcf.py", line 6, in <module>
    from cyvcf2 import VCF, Writer
ModuleNotFoundError: No module named 'cyvcf2'

(both on arm and intel architecture)

Given your steps and with the modified workflow/envs/bcftools.yaml as you suggested. And even in the current setup with bcftools = 1.20 and cyvcf2 = 0.31.0, this appears to happen.

Do you know why we get different error codes?

Thank you for sharing the GitHub thread; I follow and agree to pin cyvcf2 = 0.31.1 once I can reproduce it.

Yet, how did you figure out how to adjust bcftools = 1.13 to this version ?

GeertvanGeest commented 1 month ago

Whoops! indeed this seems to have been fixed 4 months ago in 5befca4. Should've kept my fork up to date ...

Note sure why you're having the issue with 'module not found'. Possibly the conda env is not loaded properly? I'll retry after merging my fork with master.

GeertvanGeest commented 1 month ago

Can confirm that after merging with cbg-ethz/V-pipe:master this error did not occur for me. So for me it's solved.

gordonkoehn commented 4 weeks ago

It's fantastic to hear it solved itself.

cbg-ethz / V-pipe

`cyvcf2 = 0.30.11` leads to `ValueError: numpy.dtype size changed` #167