Skip to content

Commit

Permalink
Add section about using WSL on windows to howto/odk-setup.md (#517)
Browse files Browse the repository at this point in the history
* Add section about using WSL on windows

* Fix wrong line breaks made by PyCharm
  • Loading branch information
StroemPhi authored Nov 14, 2024
1 parent 28ca561 commit 5b1f0c3
Showing 1 changed file with 2 additions and 1 deletion.
3 changes: 2 additions & 1 deletion docs/howto/odk-setup.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,8 @@
### For Windows

- Follow the instructions [here](https://hub.docker.com/editions/community/docker-ce-desktop-windows). Note that you should have Windows 10 Professional installed for this to work. We are not sure Docker Desktop works at all with Windows 10 Home, but we have not tried in a while. If you know what you are doing, you could try to configure Docker toolbox, but we have had many issues with it, and do not recommend it unless absolutely necessary.
- If you are unable to install Docker Desktop on your Windows PC (e.g. no admin rights or pohibited by the IT department of your institution) but you have the ability to use the Windows [Hyper-V-Manager](https://adamtheautomator.com/hyper-v-windows-10/) (possible [w/o admin rights](https://www.ibm.com/docs/en/capm?topic=cmhvm-adding-non-administrator-user-in-hyper-v-administrator-users-group)) or another virtualization tool, such as [VirtualBox](https://www.virtualbox.org/), you could set up a Linux virtual machine (VM) to use ODK. We recommend using [Lubuntu](https://lubuntu.me/), as it won't need much computing resources. Although you cannot install Docker Desktop in such a VM, you can [install the Docker Engine](https://docs.docker.com/engine/install/ubuntu/#install-using-the-repository), which suffices to proceed with the next step.
- If you are unable to install Docker Desktop on your Windows PC (e.g. no admin rights or prohibited by the IT department of your institution) but you have the ability to use the Windows [Hyper-V-Manager](https://adamtheautomator.com/hyper-v-windows-10/) (possible [w/o admin rights](https://www.ibm.com/docs/en/capm?topic=cmhvm-adding-non-administrator-user-in-hyper-v-administrator-users-group)) or another virtualization tool, such as [VirtualBox](https://www.virtualbox.org/), you could set up a Linux virtual machine (VM) to use ODK. We recommend using [Lubuntu](https://lubuntu.me/), as it won't need much computing resources. Although you cannot install Docker Desktop in such a VM, you can [install the Docker Engine](https://docs.docker.com/engine/install/ubuntu/#install-using-the-repository), which suffices to proceed with the next step.
- A much more convenient way to use a virtual Linux environment (with admin rights) is via the Windows Linux Subsystem (WSL) in Windows 10 and above. [Installing it](https://learn.microsoft.com/en-us/windows/wsl/install) and the [Docker Engine](https://docs.docker.com/engine/install/ubuntu/#nstall-using-the-repository) will allow you to use ODK in a Linux shell environment, while working with Protégé, GitHub Desktop and other possibly helpful apps like PyCharm, in your regular Windows GUI environment.
- Once installed, you should be able to open your command line and download the ODK.
- Click on your Windows symbol (usually in bottom left corner of screen), type "cmd" and you should be able to see and open the Command Line tool.
- in the command line type, type `docker pull obolibrary/odkfull`. This will download the ODK (will take a few minutes, depending on you internet connection).
Expand Down

0 comments on commit 5b1f0c3

Please sign in to comment.