Difference between revisions of "Virtual environment on Windows"

From Kraken Wiki
Jump to: navigation, search
(Installing and using the virtual environment)
(Installing dependencies)
Line 57: Line 57:
 
  pip install --upgrade serpenttools
 
  pip install --upgrade serpenttools
 
in the kraken environment.
 
in the kraken environment.
 +
 +
==== Adding folders to the Python path ====
 +
 +
In Windows 10, open
 +
Control Panel\All Control Panel Items\User Accounts
 +
open
 +
Change my environment variables
 +
on the left sidebar, and use
 +
New...
 +
below the
 +
User variables for <my_username>
 +
to add the environment variables for the different solvers. For example, specify
 +
ANTS_EXE_PATH
 +
in the
 +
Variable name:
 +
field and for example
 +
C:\data\src\Ants\vs2015\x64\Debug\Ants.exe
 +
in the
 +
Variable value:
 +
field. Note that if you want to use either debug or release version of the different executables, the paths have to be changed.
 +
 +
Create or add to PYTHONPATH environment variable
 +
C:\data\src\Cerberus
 +
C:\data\src\KrakenTools
 +
or similar depending on the install location (use ; to separate paths if needed), do NOT add
 +
C:\data\src\Cerberus\cereberus
 +
C:\data\src\KrakenTools\krakentools
 +
or similar.

Revision as of 09:52, 30 January 2024

Get Python 3.8 from the Python website (executable installer for Windows). During installation, tick the box for "add Python 3.8 to PATH" and take note of the installation location.

Also choose "Disable path length limit" if prompted.

Check Python path

Open a command prompt and run

python
>>> import sys
>>> print(sys.executable)

and make sure that the location of the Python executable is the same you noted down during the installation.

Installing and using the virtual environment

Open a command prompt and run

python3.8 -m pip install virtualenv
python3.8 -m pip install virtualenvwrapper-win

(Close the command prompt and open a new one.)

mkvirtualenv kraken
python3.8 -m virtualenv kraken

After this the following commands should work

workon kraken
<... do some work in the environment ...>
deactivate

Also see

echo %WORKON_HOME%

to see, where the virtual environments are stored.

The batch file

%WORKON_HOME%\kraken\Scripts\activate.bat

can be edited to add new environment variables at its end:


set "TRACEP5_EXE_PATH=C:\TRACE-V50P5-Exe\Executables\trace-V50p5-windows-msvs2017-ivf-x86-Release.exe"
etc.


Installing dependencies

Dependencies can be installed using

pip install --upgrade numpy
pip install --upgrade scipy
pip install --upgrade matplotlib
pip install --upgrade serpenttools

in the kraken environment.

Adding folders to the Python path

In Windows 10, open

Control Panel\All Control Panel Items\User Accounts

open

Change my environment variables

on the left sidebar, and use

New...

below the

User variables for <my_username>

to add the environment variables for the different solvers. For example, specify

ANTS_EXE_PATH

in the

Variable name:

field and for example

C:\data\src\Ants\vs2015\x64\Debug\Ants.exe

in the

Variable value:

field. Note that if you want to use either debug or release version of the different executables, the paths have to be changed.

Create or add to PYTHONPATH environment variable

C:\data\src\Cerberus
C:\data\src\KrakenTools

or similar depending on the install location (use ; to separate paths if needed), do NOT add

C:\data\src\Cerberus\cereberus
C:\data\src\KrakenTools\krakentools

or similar.