Set Up Virtual Environments

[jdkleiner]

Set Up Virtual Environments

1. Open a Windows PowerShell
   • Navigate to your home directory PS C:\Users\nrf46657>
2. Install the python package virtualenv
   • PS C:\Users\nrf46657> py -m pip install --user virtualenv
3. Confirm install was successful
   • PS C:\Users\nrf46657> pip show virtualenv

   Name: virtualenv
   Version: 20.17.1
   Summary: Virtual Python Environment builder
   Home-page: https://virtualenv.pypa.io/
   Author: Bernat Gabor
   Author-email: gaborjbernat@gmail.com
   License: MIT
   Location: c:\users\nrf46657\appdata\roaming\python\python310\site-packages
   Requires: distlib, filelock, platformdirs
   Required-by:
   

4. Create a virtual environment
   • navigate to your project folder
     • PS C:\Users\nrf46657> chdir .\Desktop\GitHub\virtualenv-test-project\
   • create a virtual environment named "virtualenv4"
     • PS C:\Users\nrf46657\Desktop\GitHub\virtualenv-test-project> python -m virtualenv virtualenv4

   created virtual environment CPython3.10.5.final.0-64 in 2672ms
     creator CPython3Windows(dest=C:\Users\nrf46657\Desktop\GitHub\virtualenv-test-project\virtualenv4, clear=False, no_vcs_ignore=False, global=False)
     seeder FromAppData(download=False, pip=bundle, setuptools=bundle, wheel=bundle, via=copy, app_data_dir=C:\Users\nrf46657\AppData\Local\pypa\virtualenv)
       added seed packages: pip==22.3.1, setuptools==65.6.3, wheel==0.38.4
     activators BashActivator,BatchActivator,FishActivator,NushellActivator,PowerShellActivator,PythonActivator
   

   • You can also be explicit in which python install youre using when creating the virtual environment
     • PS C:\Users\nrf46657\Desktop\GitHub\virtualenv-test-project> C:\Users\nrf46657\AppData\Local\Programs\Python\Python310\python.exe -m virtualenv venvName
     • Sidenote, venv vs virtualenv?
       • The following will both work
         • python -m virtualenv virtualenv4
         • python -m venv virtualenv4
       • virtualenv library offers more features than the venv module
5. Activate the virtual environment (in Command Prompt, permissions issue prevents us from being able to activate virtual environments from windows PowerShell, otherwise you could use PS C:\Users\nrf46657\Desktop\GitHub\virtualenv-test-project> virtualenv4\Scripts\activate)

   R:\>cd /d C:\Users\nrf46657\Desktop\GitHub\virtualenv-test-project
   C:\Users\nrf46657\Desktop\GitHub\virtualenv-test-project>virtualenv4\Scripts\activate
   (virtualenv4) C:\Users\nrf46657\Desktop\GitHub\virtualenv-test-project>
   

   • You will now be using the virtual environment untill you:
     1. Close the terminal, or
     2. Use the deactivate command
        • (virtualenv4) C:\Users\nrf46657\Desktop\GitHub\virtualenv-test-project>deactivate
6. Packages in the virtual environment
   • check the pre-installed packages on the virtual environment

   (virtualenv4) C:\Users\nrf46657\Desktop\GitHub\virtualenv-test-project> pip list
   Package    Version
   ---------- -------
   pip        22.3.1
   setuptools 65.6.3
   wheel      0.38.4
   
   (virtualenv4) C:\Users\nrf46657\Desktop\GitHub\virtualenv-test-project>pip install --upgrade pip
   Requirement already satisfied: pip in c:\users\nrf46657\desktop\github\virtualenv-test-project\virtualenv4\lib\site-packages (22.3.1)
   

   • install packages into the environment

   (virtualenv4) C:\Users\nrf46657\Desktop\GitHub\virtualenv-test-project>python -m pip install pandas
   Collecting pandas
     Downloading pandas-1.5.2-cp310-cp310-win_amd64.whl (10.4 MB)
        ---------------------------------------- 10.4/10.4 MB 37.2 kB/s eta 0:00:00
   Collecting pytz>=2020.1
     Downloading pytz-2022.7-py2.py3-none-any.whl (499 kB)
        ---------------------------------------- 499.4/499.4 kB 82.2 kB/s eta 0:00:00
   Collecting numpy>=1.21.0
     Downloading numpy-1.24.1-cp310-cp310-win_amd64.whl (14.8 MB)
        ---------------------------------------- 14.8/14.8 MB 113.1 kB/s eta 0:00:00
   Collecting python-dateutil>=2.8.1
     Using cached python_dateutil-2.8.2-py2.py3-none-any.whl (247 kB)
   Collecting six>=1.5
     Using cached six-1.16.0-py2.py3-none-any.whl (11 kB)
   Installing collected packages: pytz, six, numpy, python-dateutil, pandas
   Successfully installed numpy-1.24.1 pandas-1.5.2 python-dateutil-2.8.2 pytz-2022.7 six-1.16.0
   
   (virtualenv4) C:\Users\nrf46657\Desktop\GitHub\virtualenv-test-project>pip list
   Package         Version
   --------------- -------
   numpy           1.24.1
   pandas          1.5.2
   pip             22.3.1
   python-dateutil 2.8.2
   pytz            2022.7
   setuptools      65.6.3
   six             1.16.0
   wheel           0.38.4
   

[jdkleiner]

TL;DR This method is preferred for running HSP2 on windows because it keeps hsp2 and all of its dependencies installed in a virtual environment using its own python version and package versions. This method is also preferred because it prevents the user from having to make any tweaks to the file HSPsquared/HSP2/environment.yml in order to run hsp2.

Note: I'm still annotating some of the steps, but its actually pretty straightforward once you dive in

0. install python version of interest
   • installation executables of previous versions of python can be found here: https://www.python.org/ftp/python/3.8.9/
   • I installed version 3.8.9 as HSP2 requires python =3.8*
     • For the installer, use python-3.8.9-amd64.exe
1. create a local folder for housing virtual environments, I went with: "C:\Users\nrf46657\virtualenvs"
2. open a PS terminal within that directory
   PS C:\Users\nrf46657\virtualenvs>
3. create a virtual environment, utilizing a specific install of python (i.e. the 3.8 version installed above)

   PS C:\Users\nrf46657\virtualenvs> C:\Users\nrf46657\AppData\Local\Programs\Python\Python38\python.exe -m virtualenv hsp2dev_venv
   created virtual environment CPython3.8.9.final.0-64 in 1125ms
     creator CPython3Windows(dest=C:\Users\nrf46657\virtualenvs\hsp2dev_venv, clear=False, no_vcs_ignore=False, global=False)
     seeder FromAppData(download=False, pip=bundle, setuptools=bundle, wheel=bundle, via=copy, app_data_dir=C:\Users\nrf46657\AppData\Local\pypa\virtualenv)
       added seed packages: pip==22.3.1, setuptools==65.6.3, wheel==0.38.4
     activators BashActivator,BatchActivator,FishActivator,NushellActivator,PowerShellActivator,PythonActivator
   

   • Take a look at the packages in the virtual environment

   PS C:\Users\nrf46657\virtualenvs> ls hsp2dev_venv\Lib\site-packages
       Directory: C:\Users\nrf46657\virtualenvs\hsp2dev_venv\Lib\site-packages
   
   
   Mode                 LastWriteTime         Length Name
   ----                 -------------         ------ ----
   d-----         1/10/2023   4:04 PM                pip
   d-----         1/10/2023   4:04 PM                pip-22.3.1.dist-info
   d-----         1/10/2023   4:04 PM                pkg_resources
   d-----         1/10/2023   4:04 PM                setuptools
   d-----         1/10/2023   4:04 PM                setuptools-65.6.3.dist-info
   d-----         1/10/2023   4:04 PM                wheel
   d-----         1/10/2023   4:04 PM                wheel-0.38.4.dist-info
   d-----         1/10/2023   4:04 PM                _distutils_hack
   -a----         1/10/2023   4:04 PM            151 distutils-precedence.pth
   -a----         1/10/2023   4:04 PM              0 pip-22.3.1.virtualenv
   -a----         1/10/2023   4:04 PM              0 setuptools-65.6.3.virtualenv
   -a----         1/10/2023   4:04 PM              0 wheel-0.38.4.virtualenv
   -a----         1/10/2023   4:04 PM             18 _virtualenv.pth
   -a----         1/10/2023   4:04 PM           5770 _virtualenv.py
   

4. Activate a virtual environment
   • First open a Command Prompt cmd
   • Navigate to directory housing your virtual environments

   R:\>cd /d C:\Users\nrf46657\virtualenvs
   C:\Users\nrf46657\virtualenvs>
   

   • hsp2dev_venv\Scripts\activate

   C:\Users\nrf46657\virtualenvs>hsp2dev_venv\Scripts\activate
   
   (hsp2dev_venv) C:\Users\nrf46657\virtualenvs>
   

   • You can verify the version of Python being used in the virtual environment

   (hsp2dev_venv) C:\Users\nrf46657\Desktop\GitHub\HSPsquared>python -V
   Python 3.8.9
   

5. install hsp2 within that virtual environment
   • still within cmd: change directory to HSPsquared

   (hsp2dev_venv) C:\Users\nrf46657\virtualenvs>cd 
   C:\Users\nrf46657\Desktop\GitHub\HSPsquared
   
   (hsp2dev_venv) C:\Users\nrf46657\Desktop\GitHub\HSPsquared>
   

   • install hsp2

   (hsp2dev_venv) C:\Users\nrf46657\Desktop\GitHub\HSPsquared>pip install .
   Processing c:\users\nrf46657\desktop\github\hspsquared
     Preparing metadata (setup.py) ... done
   Collecting scipy
     Using cached scipy-1.10.0-cp38-cp38-win_amd64.whl (42.2 MB)
   Collecting pandas==1.2.*
     Using cached pandas-1.2.5-cp38-cp38-win_amd64.whl (9.3 MB)
   Collecting numba==0.53.1
     Using cached numba-0.53.1-cp38-cp38-win_amd64.whl (2.3 MB)
   Collecting numpy==1.20.*
     Using cached numpy-1.20.3-cp38-cp38-win_amd64.whl (13.7 MB)
   ...
   

   • This is super powerful because a) hsp2 gets installed within the virtual environment you created AND b) all of its hsp2 and all of its dependencies with the correct versions get installed within the virtual environment as well (i.e. all of the packages in the environment.yml get installed)
6. Verify success in PowerShell
   • Just as before, take a look at the packages in the virtual environment (there should now be many more packages listed, including HSP2)
     • PS C:\Users\nrf46657\virtualenvs> ls hsp2dev_venv\Lib\site-packages
7. Verify you can now run hsp2 (This is best done from within VS Code)

   PS C:\Users\nrf46657\Desktop\GitHub\HSPsquared\tests\testcbp\HSP2results>
   

   • To activate your virtual environment, you must select the python executable
     • F1 -> Python: Select Interpreter -> Enter Interpreter Path... -> "C:\Users\nrf46657\virtualenvs\hsp2dev_venv\Scripts\python.exe"
     • **I need to finished fleshing out these notes

[jdkleiner]

pip list