1. biGENIUS-X Help Center
  2. Discovery Companion application

Install the Discovery Companion application

The Discovery Companion is a Python package. It is available here

Prerequisites

To be able to install and use the Discovery Companion, please have Python installed (Minimal version: 3.8 - Maximal version: 3.10).

To execute the commands with Powershell, you need to use at least Powershell version 7 provided by Microsoft. If you would like to install the latest version, please check here.

Check Python version

If Python is already installed, check the version:

  • Open Windows Powershell (or equivalent)
  • Execute the following command:
python --version
  • The result should be >= to 3.8 and <=3.10. For example, here we have version 3.10.9 installed:

Continue to the next section if you need to install Python; otherwise, skip ahead to the following section.

Install Python

  • Open the official Python website in your web browser
  • Navigate to the Downloads tab for Windows (or another operation system)
  •  Download the latest 64bit version  
  • Launch the installer
  • Check the Install launcher for all user's checkboxes. You may check the Add Python X.X to path check box to include the interpreter in the execution path
  •  Select Customize installation 
  •  Choose the optional features by checking the following checkboxes: 
  •  Click Next, then Install
  •  Check that the path has been added to the PATH in the Environment variables:
     
  • Check the installation by executing the following command:
python --version
  • The result should display the Python version that you just installed

Install the Discovery Companion application

  • Open Windows Powershell (or equivalent)
  • Execute the following command:
pip install bgdiscovery
  • You should have the following result at the end:
  • You can check the package version by executing the following command:
pip show bgdiscovery
  • You should have the following effect:

You can now start using the Discovery Companion.

Update

If you have already installed the Discovery Companion and want to update to the last available version, execute the following command:

pip install --upgrade bgdiscovery

Demonstration video