Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion docs/api.md
Original file line number Diff line number Diff line change
Expand Up @@ -72,7 +72,7 @@ These are the primary functions for interacting with the SolarFarmer API.

The core classes handle the complete workflow from plant design to results analysis:

- [**PVSystem**](#pvsystem): Main class for defining and configuring PV plant designs with all technical specifications
- [**PVSystem**](#pvsystem): Main class for constructing approximated PV plant designs from high-level specifications (location, capacity, equipment). Infers layout geometry and losses using simplified assumptions; results are suitable for screening, not detailed design
- [**EnergyCalculationInputs**](#energycalculationinputs): Root Pydantic model composing all inputs for a calculation run
- [**PVPlant**](#pvplant): Pydantic model describing the PV plant structure (transformers, mounting specs, etc.)
- [**ModelChainResponse**](#modelchainresponse): Container for raw API response data from energy calculations
Expand Down
2 changes: 2 additions & 0 deletions docs/getting-started/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -54,6 +54,8 @@ The SolarFarmer SDK supports three distinct user workflows. Choose the one that
Specify your plant: location (lat/lon), DC and AC capacities, inverter type, mounting configuration.
`PVSystem` handles the payload construction and you run the calculation.

Results from `PVSystem` are approximations based on simplified layout assumptions — see [FAQ](../faq.md) for details.

---

### [Workflow 3: Advanced Integration and Custom Data Models](workflow-3-plantbuilder-advanced.md)
Expand Down
3 changes: 3 additions & 0 deletions docs/getting-started/workflow-2-pvplant-builder.md
Original file line number Diff line number Diff line change
Expand Up @@ -13,6 +13,9 @@ description: Create plant configurations and automatically build API payloads

## Overview

!!! info "Approximated Design"
`PVSystem` constructs a plant layout from high-level inputs (location, capacity, equipment files) using simplified assumptions — including uniform mid-row shading for all strings and inferred string sizing. This is well-suited for early-stage yield screening and scenario comparison. For full design fidelity, use [Workflow 1](workflow-1-existing-api-files.md) with a SolarFarmer Desktop–exported payload or [Workflow 3](workflow-3-plantbuilder-advanced.md) for direct data model mapping.

This workflow involves four steps:

1. **Design** your plant using the `PVSystem` class
Expand Down
8 changes: 8 additions & 0 deletions docs/notebooks/Example_PVSystem.ipynb
Original file line number Diff line number Diff line change
Expand Up @@ -17,6 +17,14 @@
"- [API output results](https://mysoftware.dnv.com/download/public/renewables/solarfarmer/manuals/latest/WebApi/Endpoints/ModelChainEndpoint.html#outputs)"
]
},
{
"cell_type": "markdown",
"id": "f93f9dec",
"metadata": {},
"source": [
"> **Note:** `PVSystem` generates an approximated plant design by inferring layout geometry, string sizing, and losses from high-level inputs. Results are intended for early-stage yield screening and comparative analysis. For full design fidelity, export a detailed payload from SolarFarmer Desktop or use Workflow 3."
]
},
{
"cell_type": "markdown",
"id": "89464306",
Expand Down
6 changes: 6 additions & 0 deletions solarfarmer/models/pvsystem/pvsystem.py
Original file line number Diff line number Diff line change
Expand Up @@ -74,6 +74,12 @@ class PVSystem:
The class is designed to be flexible and user-friendly, with sensible defaults and validation
to ensure that the provided data is consistent and complete for the API calculation.

.. note::
``PVSystem`` generates an approximated plant design from high-level specifications.
It infers layout geometry, string sizing, and loss parameters using simplified
assumptions (e.g., uniform mid-row shading). Results are suitable for early-stage
energy yield screening but do not represent a fully detailed design.

Basic Metadata
--------------
name: str | None
Expand Down
Loading