Installation#

To install PyProBE you must be running Python 3.11 or later. It is recommended to use a virtual environment to install PyProBE, for example venv or conda.

If you are completely new to Python

Recommended software

The easiest way to get started with data processing in Python is to use Anaconda for package management and Visual Studio Code for code editing. You will need Git installed to clone the repository. If you are new to Git version control, the GitHub Desktop is a good place to start.

In order to follow the installation instructions below, on Windows you can work in Anaconda Prompt. On Mac or Linux you can use Terminal directly.

Using PyProBE after installation

Jupyter Notebooks are a popular format for Python data processing. VSCode has support for writing and running these, which you can open from the dropdown menu:

../_images/VSCode_open_file.png

You should then select the Anaconda environment that you will create from the list of available Python environments:

../_images/VSCode_select_kernel.png

You should have two separate directories:

  • one for the PyProBE repository

  • one for your processing script

The steps to install PyProBE are as follows:

  1. Enter a directory in which you wish to install PyProBE:

    cd /path/to/installation/directory

  2. Clone the repository to your local machine. This creates a directory called PyProBE.

    git clone https://github.com/ImperialCollegeLondon/PyProBE.git
cd PyProBE

    It is recommended to used the tagged releases for a stable version of the code. You can list the available tags with the following command:

    git tag

    You can then checkout the desired tag with the following command:

    git checkout <tag name>

    For example:

    git checkout v0.1.0

    To update your installation you can run:

    git fetch --tags
git tag
git checkout <tag name>

  3. Create and activate a virtual environment.

In your working directory:

python -m venv venv
source .venv/bin/activate

  1. Install PyProBE’s dependencies:

    cd /path/to/your/directory/PyProBE
pip install -r requirements.txt

  2. Install PyProBE as a package into your virtual environment:

    pip install .

  3. In a second directory you can create a new python script or jupyter notebook to process your data. You can import PyProBE into your script as follows:

    import pyprobe

  4. Before being able to launch the dashboard you will need to initialise streamlit. Do this by running the streamlit Hello app from your command line:

    streamlit hello
Show Source