Skip to content

Latest commit

 

History

History
101 lines (57 loc) · 2.83 KB

SETUP-WINDOWS.md

File metadata and controls

101 lines (57 loc) · 2.83 KB

Project Homepage / Setup Instructions (Windows)

Setup Instructions (Windows)

This guide takes you from a fresh install of Windows to having the project running.

The steps involved are:

  1. Installing Python 3.6.7
  2. Installing dependencies

1. Install Python 3.6.7

  1. Install Python 3.6.7 via official installer.

  2. Verify that the install was successful with py -3.6 --version:

    > py -3.6 --version
3.6.7

2. Install Dependencies

There are two options:

  1. Install dependencies globally
  2. Create an environment

If you are not a Python power user, it is recommended not to use a virtual environment (since it is complicated), and use Option 1 — Install dependencies globally.

If you have mutliple Python projects and want to keep the dependencies isolated, you may want to use a virtual environment. Check out the documentation) for more information.

Option 1 — Install dependencies globally

  1. Navigate to the project root directory (...\paper-ecg\) and run:

    py -3.6 -m pip install --upgrade pip
py -3.6 -m pip install -r requirements.txt

Now, running fbs run should build and run the project. If that doesn't work, try py -3.6 -m fbs run.

Option 2 — Create an environment (Optional) and install dependencies

  1. Navigate to the project root directory (...\paper-ecg\) and run

  2. Create a virtual environment for the project.

    py -3.6 -m venv .env

  3. Activate the environment:

    In order to utilize the isolated environment you will need to activate the environment. The activation command varies between operating systems and shells, and the correct command to use is given in the table below:

    Shell Command to activate virtual environment
    cmd.exe C:\> .env\Scripts\activate.bat
    PowerShell PS C:\> .env\Scripts\Activate.ps1
    💡 Pro Tip for VSCode

    Check the "Python > Env > Active Env In Current Terminal" box in the workspace settings or add this setting to .vscode\settings.json:

    "python.terminal.activateEnvInCurrentTerminal": true,

  4. Install dependencies

    pip install --upgrade pip
pip install -r requirements.txt

Now, running fbs run should build and run the project.

Deactivating

After you have finished working on the project, and you want to return to your normal shell, you can deactivate the environment by running deactivate.