Updated installation guide with steps for windows#78
Updated installation guide with steps for windows#78Rohan-cod wants to merge 1 commit intoelimuinformatics:masterfrom
Conversation
Updated the installation guide with steps on how to install vcf2fhir on windows.
| Install and add [Ubuntu WSL](https://www.microsoft.com/en-in/p/ubuntu-1804-lts/9n9tngvndl3q?rtc=1&activetab=pivot:overviewtab) to the [windows terminal](https://www.microsoft.com/en-in/p/windows-terminal/9n0dx20hk701?activetab=pivot:overviewtab). (Only for windows users!) | ||
|
|
There was a problem hiding this comment.
Pre-requisite
Windows
- vcf2fhir is supported only on Unix and Linux systems. To run it on windows install Ubuntu WSL.
vcf2hfir
There was a problem hiding this comment.
Do we need: add to the windows terminal in the document? Are there special steps required to add it to the terminal? If yes, we should list that instead of just a statement.
There was a problem hiding this comment.
I also wanted to investigate why does user needs to install pip install cython wheel, but I never got enough time. Can you help look at this too?
I think we are missing something in our build process. cython and wheel should only be needed for running from the source. If people are downloading from pip they should get the compiled binary.
There was a problem hiding this comment.
Hi @srgothi92,
Do we need: add to the windows terminal in the document? Are there special steps required to add it to the terminal? If yes, we should list that instead of just a statement.
Should I add this link for the steps to add Ubuntu WSL to the windows terminal?
why does user needs to install pip install cython wheel
I checked this one, and I think it is a requirement for pyrle. When I tried installing vcf2fhir in a virtual environment without installing cython wheel I received the following error:
There was a problem hiding this comment.
Should I add this link for the steps to add Ubuntu WSL to the windows terminal?
Without these steps, you can't use WSL?
I checked this one, and I think it is a requirement for pyrle.
That's strange. What happens if you try to pip install pyranges do we get the same error? If not, then it's strange that we get this error. If we do get an errr, we should check with pyranges developer.
There was a problem hiding this comment.
Can we open an issue on pyranges and see what the maintainer has to say.
I just looked at the open issues in pyranges and they seem to be working on this one(here). In that issue, there is a mention of this pull request in sorted_nearest. That pull request adds the build-time requirements for the package. Should we similarly add setuptools, Cython, and Wheel as build-time requirements for vcf2fhir or wait for pyranges to be updated?
There was a problem hiding this comment.
That pull request adds the build-time requirements for the package. Should we similarly add setuptools, Cython, and Wheel as build-time requirements for vcf2fhir or wait for pyranges to be updated?
Sure, you can try that if it works and open an issue in our repository to fix it later when it is addressed upstream.
There was a problem hiding this comment.
Okay I was finally able to find some time and install vcf2fhir on my windows machine using WSL. However, with this issue I was looking to install vcf2fhir natively on windows. I tried pysam and it install fine on windows with conda packaging. May be we should try conda package on windows instead of suggesting WSL path.
There was a problem hiding this comment.
May be we should try conda package on windows instead of suggesting WSL path.
Sure, I will try installing vcf2fhir via conda once it gets deployed on the bioconda channel. :)
There was a problem hiding this comment.
Sure, I will try installing vcf2fhir via conda once it gets deployed on the bioconda channel. :)
Before publishing to biconda channel we should first test with our personal channel similar to what we do with test pypi.
2 participants
Description
Updated the installation guide in
README.mdandQUIKSTART.rstwith steps on how to installvcf2fhironwindows.Fixes #70
How Has This Been Tested?
The code has been tested by running all the unit tests using the command
python -m unittestand validated the PEP 8 formatting usingpycodestyle.