Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Fix zspmv_openmp.cpp missing in srcdist #1449

Merged
merged 1 commit into from
Feb 22, 2021
Merged

Fix zspmv_openmp.cpp missing in srcdist #1449

merged 1 commit into from
Feb 22, 2021

Conversation

cgohlke
Copy link
Contributor

@cgohlke cgohlke commented Feb 20, 2021

QuTiP 4.5.3 fails to build from source distribution on PyPI, e.g. on Windows:

c1xx: fatal error C1083: Cannot open source file: 'qutip/cy/openmp/src/zspmv_openmp.cpp': No such file or directory

Checklist
Thank you for contributing to QuTiP! Please make sure you have finished the following tasks before opening the PR.

  • Please read Contributing to QuTiP Development
  • Contributions to qutip should follow the pep8 style.
    You can use pycodestyle to check your code automatically
  • Please add tests to cover your changes if applicable.
  • If the behavior of the code has changed or new feature has been added, please also update the documentation and the notebook. Feel free to ask if you are not sure.

Delete this checklist after you have completed all the tasks. If you have not finished them all, you can also open a Draft Pull Request to let the others know this on-going work and keep this checklist in the PR description.

Description
Describe here the proposed change.

Related issues or PRs
Please mention the related issues or PRs here. If the PR fixes an issue, use the keyword fix/fixes/fixed followed by the issue id, e.g. fix #1184

Changelog
Give a short description of the PR in a few words. This will be shown in the QuTiP change log after the PR gets merged.
For example:
Fixed error checking for null matrix in essolve.
Added option for specifying resolution in Bloch.save function.

@coveralls
Copy link

Coverage Status

Coverage remained the same at 63.189% when pulling 8645164 on cgohlke:patch-1 into 469b18c on qutip:master.

@jakelishman
Copy link
Member

jakelishman commented Feb 20, 2021

Can you fully show your build process, and did this work with a previous version of QuTiP? It builds fine for me from pip sdist on all major platforms with a simple

pip install qutip

and the sdist of 4.5.2 seems to be missing the same file.

Officially we don't support building with OpenMP from pip sdist (only git), but to be fair, it should have worked. In the interests of better semantics, can you change the new line in MANIFEST.in to

graft qutip/**/src

Technically there's only the one file that doesn't get tagged in (I hope), but logically the principle is that anything in a src directory should be distributed in the sdist.

@cgohlke
Copy link
Contributor Author

cgohlke commented Feb 20, 2021

You are right, I forgot to mention that my build is not using pip and explicitly enables --with-openmp. Same for version 4.5.2 but I didn't report until now.

@jakelishman
Copy link
Member

Ah ok, that makes it easier to understand what happened - the MANIFEST.in file got added at some point before the 4.5.2 release, but its mere presence overrides the content of setuptools' package_data option, in which we do add the requisite files.

If it's not desperately urgent, are you able to build from the git branch at 4.5.3 instead temporarily? I can merge this PR, but we're hoping to put out 4.6.0 in about two weeks' time (which I'll make sure has this patch), and our release process is still very manual - I'd rather not have to repeat it another time if I can avoid it!

Sorry this file got lost when MANIFEST.in turned up.

@cgohlke
Copy link
Contributor Author

cgohlke commented Feb 20, 2021

Sure. It's not urgent at all.

@jakelishman jakelishman merged commit 7779bf5 into qutip:master Feb 22, 2021
@jakelishman jakelishman added this to the QuTiP 4.6 milestone Jun 24, 2021
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

More detailed information for GSoC 2020 project
3 participants