Skip to main content

Getting Started

This guide helps you set up a development environment and understand the basics.

Prerequisites​

  • Python 3.11+
  • Git
  • Basic knowledge of PV systems and Python

Setup​

# Clone the repository (update remote if needed)
git clone https://git.rooftop.my/FrontOps/PVTools.git
cd PVTools

# Create and activate virtual env
python -m venv env
source env/bin/activate  # Linux/macOS
# or: env\Scripts\activate  # Windows

# Install dependencies
pip install -r requirements.txt

Recommended dev tools:

pip install black isort mypy pytest pytest-cov

VS Code settings:

{
  "python.defaultInterpreterPath": "./env/bin/python",
  "python.formatting.provider": "black",
  "python.linting.enabled": true,
  "python.linting.mypyEnabled": true,
  "python.testing.pytestEnabled": true
}