1.1.11. install

The install tool can

  • check the installation status of the software,

  • return the location of the installation instructions, and

  • install the fox CLI in a local virtual Python environment as a package.

1.1.11.1. Usage

The install command has two sets of options that each provide specific functionalities.

Usage: fox.py install [OPTIONS]

  Installation information and instructions

  This command allows to check whether the required software for using and
  developing foxBMS is installed. It further enables to install the 'fox CLI'
  on the host, to make the tools available without having to rely on a foxBMS
  project.

Options:
  --check / --no-check  Check if the required software is installed.
  --local / --no-local  Install this version of the 'fox CLI' on the host.
  -v, --verbose         Verbose information.
  -h, --help            Show this message and exit.

The default options for each set are --no-check and --no-local. If a different functionality is intended, the corresponding option must be specified as described below.

  • Get the location of the installation instructions:

    .\fox.ps1 install

  • Check the installation status of the software:

    Attention

    If --check is specified as an option, the install tool will only check the installation status and ignore any other options.

    .\fox.ps1 install --check

  • Install the fox CLI package in a local virtual Python environment:

    Note

    See fox CLI package for information on the fox CLI package. Instead of activating the virtual Python environment as indicated there, open the terminal with the shortcut created by the install tool.

    .\fox.ps1 install --local

    Running this command creates a virtual Python environment in the directory C:\foxbms\envs\local\<foxbms-version-number> (/opt/foxbms/envs/local/<foxbms-version-number> for Linux). Additionally, two shortcuts are created in the directory foxbms-2 in the Start Menu, named fox CLI - <foxbms-version-number> and fox CLI GUI - <foxbms-version-number>. The former opens a terminal with the virtual Python environment already activated, and the latter opens the GUI.