Installation¶

Biosigpy is currently installed from the repository source tree.

Clone the repository¶

git clone https://github.com/BSICoS/biosigpy.git
cd biosigpy

Create a virtual environment¶

python -m venv .venv
source .venv/bin/activate
python -m pip install --upgrade pip

On Windows PowerShell, activate the environment with:

.venv\Scripts\Activate.ps1
python -m pip install --upgrade pip

Install optional dependency groups¶

Install the examples extra when you want to run the executable examples:

python -m pip install -e ".[examples]"

Install the development extra when you want to run tests:

python -m pip install -e ".[dev]"

Install the documentation extra when you want to build or serve the docs:

python -m pip install -e ".[docs]"

Build or serve the documentation¶

mkdocs build --strict
mkdocs serve