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.

The steps to install PyProBE with developer settings are as follows:

Enter a directory in which you wish to install PyProBE:
```
cd /path/to/your/directory
```
Clone the repository to your local machine. This can be done either from the main PyProBE repository or your own fork. This creates a directory called PyProBE.
```
git clone https://github.com/ImperialCollegeLondon/PyProBE.git
cd PyProBE
```
Create and activate a virtual environment.

In your working directory:

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

In any directory:

conda create -n pyprobe python=3.12
conda activate pyprobe

Install the developer dependencies:

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

Install PyProBE as a package into your virtual environment:
```
pip install -e .
```
The -e flag installs in “editable” mode, which means changes that you make to the code will be automatically reflected in the package inside your virtual environment.
Install the pre-commit hooks:
```
pre-commit install
```