solarfarmer-sdk-examples

Runnable Jupyter notebooks demonstrating end-to-end PV energy yield workflows using the SolarFarmer Python SDK, the Solcast Python SDK, and the DNV Solar Resource Compass API.

Each subfolder corresponds to a specific event or workshop. More are added over time.

---

Contents

Folder	Event	Date
PVPMC2026/	PVPMC USA Workshop, Albuquerque NM	May 2026

---

PVPMC2026

Five notebooks presented at the PVPMC USA 2026 Workshop in Albuquerque, New Mexico. They form a progression from raw resource data retrieval through to multi-year energy yield analysis.

Notebook	Title	What it covers
01_solcast.ipynb	Solcast API	TMY, historic, live and forecast irradiance & weather retrieval via the Solcast SDK
02_solar_resource_compass.ipynb	DNV Solar Resource Compass	Multi-source irradiance comparison, monthly soiling profiles, and ground albedo via the SRC API
03_solarfarmer.ipynb	SolarFarmer API — PVSystem builder	Build a 10 MW tracker plant from scratch, run an energy yield calculation, and sweep GCR for LCOE optimisation
04_operational_SF3d.ipynb	Operational: Live + Forecast → SolarFarmer	Pull Solcast live observations and short-range forecasts, convert to a SolarFarmer weather file, and run a near-real-time energy calculation
05_solcast_solarfarmer_multiyear.ipynb	Multi-year yield variability	Fetch 19 years of Solcast historic data, apply pvlib Kimber soiling, run each year through SolarFarmer in parallel, and analyse P50/P90 exceedance

---

Prerequisites

API keys

All notebooks require at least one API key set as an environment variable before running.

Variable	Where to get it
SOLCAST_API_KEY	toolkit.solcast.com.au/register
SRC_API_KEY	Issued by DNV on request
SF_API_KEY	Retrieved from solarfarmer.dnv.com after being requested

Set them in your shell before launching Jupyter:

# Linux / macOS
export SOLCAST_API_KEY=your-key
export SRC_API_KEY=your-key
export SF_API_KEY=your-key

# Windows (Command Prompt)
set SOLCAST_API_KEY=your-key
set SRC_API_KEY=your-key
set SF_API_KEY=your-key

# Windows (PowerShell)
$env:SOLCAST_API_KEY = "your-key"
$env:SRC_API_KEY     = "your-key"
$env:SF_API_KEY      = "your-key"

---

Setup

Requires Python 3.11+.

Option A — conda (recommended)

cd PVPMC2026
conda env create -f environment.yml
conda activate pvpmc-usa-2026-dnv-apis
jupyter lab

Option B — uv

cd PVPMC2026
uv sync              # reads pyproject.toml and uv.lock
jupyter lab

Option C — pip

cd PVPMC2026
pip install .        # reads pyproject.toml
jupyter lab

---

Repository structure

solarfarmer-sdk-examples/
├── README.md
└── PVPMC2026/
    ├── environment.yml
    ├── pyproject.toml
    ├── uv.lock
    ├── solar_resource_compass.py     # SRC API helper
    ├── 01_solcast.ipynb
    ├── 02_solar_resource_compass.ipynb
    ├── 03_solarfarmer.ipynb
    ├── 04_operational_SF3d.ipynb
    ├── 05_solcast_solarfarmer_multiyear.ipynb
    ├── equipment/                    # PAN / OND files for notebooks 03–05
    └── operational_usecase/          # SolarFarmer Workflow 1 API input files

---

Key dependencies

Package	Purpose
solcast	Solcast TMY, historic, live and forecast endpoints
dnv-solarfarmer	SolarFarmer energy yield API
pvlib	Soiling model (Kimber) and irradiance utilities
pandas, matplotlib	Data manipulation and visualisation

---

Contact

For questions or to request access to API tokens, contact the DNV team at solarfarmer@dnv.com.

---

License

See LICENSE.