dnv-solarfarmer 0.2.0rc1__tar.gz

dnv_solarfarmer-0.2.0rc1/LICENSE

@@ -0,0 +1,13 @@
+Copyright [2026] [DNV AS]
+
+Licensed under the Apache License, Version 2.0 (the "License");
+you may not use this file except in compliance with the License.
+You may obtain a copy of the License at
+
+    http://www.apache.org/licenses/LICENSE-2.0
+
+Unless required by applicable law or agreed to in writing, software
+distributed under the License is distributed on an "AS IS" BASIS,
+WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+See the License for the specific language governing permissions and
+limitations under the License.

dnv_solarfarmer-0.2.0rc1/MANIFEST.in

@@ -0,0 +1,5 @@
+include LICENSE
+include README.md
+include mkdocs.yml
+recursive-include docs *.md
+recursive-include examples *.py

dnv_solarfarmer-0.2.0rc1/PKG-INFO

@@ -0,0 +1,176 @@
+Metadata-Version: 2.4
+Name: dnv-solarfarmer
+Version: 0.2.0rc1
+Summary: SDK for SolarFarmer software, bankable solar PV calculation engine developed by DNV.
+Author-email: "DNV Green Power Monitor, Green Data Products" <solarfarmer@dnv.com>
+Maintainer-email: Green Data Products <solarfarmer@dnv.com>
+License: Apache-2.0
+Project-URL: Homepage, https://www.dnv.com/software/services/solarfarmer/
+Project-URL: Repository, https://github.com/dnv-opensource/solarfarmer-python-sdk
+Project-URL: Issues, https://github.com/dnv-opensource/solarfarmer-python-sdk/issues
+Keywords: sdk,api,solarfarmer,dnv,python
+Classifier: Intended Audience :: Information Technology
+Classifier: Programming Language :: Python :: 3
+Classifier: Programming Language :: Python :: 3 :: Only
+Classifier: Programming Language :: Python :: 3.10
+Classifier: Programming Language :: Python :: 3.11
+Classifier: Programming Language :: Python :: 3.12
+Classifier: Programming Language :: Python :: 3.13
+Classifier: License :: OSI Approved :: Apache Software License
+Classifier: Operating System :: OS Independent
+Classifier: Topic :: Internet
+Classifier: Topic :: Software Development :: Libraries :: Python Modules
+Classifier: Topic :: Software Development :: Libraries
+Classifier: Topic :: Software Development
+Classifier: Topic :: Scientific/Engineering
+Requires-Python: >=3.10
+Description-Content-Type: text/markdown
+License-File: LICENSE
+Requires-Dist: pydantic>=2.0
+Requires-Dist: requests>=2.28
+Requires-Dist: tabulate>=0.9.0
+Provides-Extra: docs
+Requires-Dist: zensical>=0.0.20; extra == "docs"
+Requires-Dist: mkdocstrings[python]>=0.26.1; extra == "docs"
+Requires-Dist: mkdocs-jupyter>=0.24; extra == "docs"
+Provides-Extra: test
+Requires-Dist: pytest>=7.0; extra == "test"
+Provides-Extra: dev
+Requires-Dist: dnv-solarfarmer[test]; extra == "dev"
+Requires-Dist: pre-commit>=3.0; extra == "dev"
+Requires-Dist: ruff>=0.5; extra == "dev"
+Provides-Extra: notebooks
+Requires-Dist: ipykernel<8,>=6.29; extra == "notebooks"
+Requires-Dist: jupyterlab<6,>=4.0; extra == "notebooks"
+Requires-Dist: notebook<9,>=7.0; extra == "notebooks"
+Provides-Extra: all
+Requires-Dist: dnv-solarfarmer[dev,docs,notebooks]; extra == "all"
+Requires-Dist: pandas>=2.0; extra == "all"
+Requires-Dist: matplotlib>=3.5; extra == "all"
+Dynamic: license-file
+
+# SolarFarmer Python SDK
+
+[![PyPI version](https://img.shields.io/pypi/v/dnv-solarfarmer)](https://pypi.org/project/dnv-solarfarmer/)
+[![Python versions](https://img.shields.io/pypi/pyversions/dnv-solarfarmer)](https://pypi.org/project/dnv-solarfarmer/)
+[![License](https://img.shields.io/badge/license-Apache%202.0-blue)](LICENSE)
+[![CI](https://github.com/dnv-opensource/solarfarmer-python-sdk/actions/workflows/test.yml/badge.svg)](https://github.com/dnv-opensource/solarfarmer-python-sdk/actions/workflows/test.yml)
+[![Documentation](https://img.shields.io/badge/docs-online-teal)](https://dnv-opensource.github.io/solarfarmer-python-sdk/)
+
+The official Python SDK for [DNV SolarFarmer](https://www.dnv.com/software/services/solarfarmer/), a bankable solar PV calculation engine. Use it to build validated API payloads, run cloud-based 2D and 3D energy calculations, and analyse simulation results — all from Python.
+
+## Key Features
+
+- **API-faithful data models** that closely mirror the SolarFarmer API schema, with serialization conveniences (snake_case Python fields serialized to the correct camelCase JSON automatically) to reduce integration friction
+- **Two plant-building approaches:** a bottom-up route using `EnergyCalculationInputs`, `PVPlant`, and component classes (`Inverter`, `Layout`, `Transformer`, etc.) for full control over the plant topology; and a `PVSystem` convenience class that accepts high-level parameters (capacity, tilt, GCR, equipment files) and constructs the payload automatically, suited to indicative simulations where exhaustive detail is not required
+- **`CalculationResults` encapsulation** — the API response is wrapped in a `CalculationResults` object that provides structured access to annual and monthly energy metrics, loss trees, PVsyst-format time-series, and detailed time-series output without manual JSON parsing
+- **ModelChain and ModelChainAsync endpoint support** — the SDK dispatches to the synchronous `ModelChain` endpoint or the asynchronous `ModelChainAsync` endpoint as appropriate, and handles polling automatically for long-running jobs
+- **Async job management** — poll, monitor, and terminate async calculations via `terminate_calculation()`
+
+## Requirements
+
+- Python >= 3.10 (tested on 3.10, 3.11, 3.12, 3.13)
+- A SolarFarmer API key (commercial licence required) — see [API Key](#api-key)
+
+## Installation
+
+Install from PyPI:
+
+```bash
+pip install dnv-solarfarmer
+```
+
+The package is imported as `solarfarmer` regardless of the distribution name:
+
+```python
+import solarfarmer as sf
+```
+
+Install with optional extras:
+
+```bash
+pip install "dnv-solarfarmer[notebooks]"  # JupyterLab and notebook support
+pip install "dnv-solarfarmer[all]"         # full installation including pandas and matplotlib
+pip install "dnv-solarfarmer[dev]"         # linting and testing tools (for contributors)
+```
+
+Install from source:
+
+```bash
+git clone https://github.com/dnv-opensource/solarfarmer-python-sdk
+cd solarfarmer-python-sdk
+pip install -e .
+```
+
+## API Key
+
+A SolarFarmer API key is required to run energy calculations. Obtain one from the [SolarFarmer portal](https://solarfarmer.dnv.com/). For setup instructions, see the [API key documentation](https://mysoftware.dnv.com/download/public/renewables/solarfarmer/manuals/latest/WebApi/Introduction/ApiKey.html).
+
+Set your key as an environment variable (recommended):
+
+```bash
+export SF_API_KEY="your_api_key_here"
+```
+
+Alternatively, pass it directly as the `api_key` parameter to any function that calls the API.
+
+## Configuration
+
+| Environment Variable | Default | Description |
+|---|---|---|
+| `SF_API_KEY` | *(none — required for calculations)* | API authentication token |
+| `SF_API_URL` | `https://solarfarmer.dnv.com/latest/api` | Override the base API URL for custom deployments |
+
+## Getting Started
+
+The SDK is built around three workflows suited to different use cases:
+
+| Workflow | Best for | Primary entry point |
+|---|---|---|
+| 1. Load existing files | Users with pre-built API payloads from the SolarFarmer desktop app or a previous export | `sf.run_energy_calculation(inputs_folder_path=...)` |
+| 2. PVSystem builder | Solar engineers designing new plants programmatically with automatic payload generation | `sf.PVSystem(...)` then `plant.run_energy_calculation()` |
+| 3. Custom integration | Developers mapping internal databases or proprietary formats to the SolarFarmer API | `sf.EnergyCalculationInputs(location=..., pv_plant=..., ...)` |
+
+See the [Getting Started guide](https://dnv-opensource.github.io/solarfarmer-python-sdk/getting-started/) for full per-workflow walkthroughs, and the [example notebooks](https://dnv-opensource.github.io/solarfarmer-python-sdk/notebooks/Example_EnergyCalculations/) for runnable end-to-end examples.
+
+## Documentation
+
+Full documentation including API reference, workflow guides, and notebook tutorials:
+
+**https://dnv-opensource.github.io/solarfarmer-python-sdk/**
+
+To build and serve the documentation locally:
+
+```bash
+pip install "dnv-solarfarmer[docs]"
+zensical serve -o                          # build, serve, and open in browser (port 8000)
+zensical serve -o -a localhost:8080        # use a different port
+```
+
+`zensical serve` builds the docs and starts a local server in one step. The `-o` flag opens the page automatically in your default browser.
+
+## Contributing
+
+Fork the repository, create a branch, and submit a pull request to `main`. To set up a development environment:
+
+```bash
+git clone https://github.com/dnv-opensource/solarfarmer-python-sdk
+cd solarfarmer-python-sdk
+pip install -e ".[dev]"
+```
+
+- **Linting and formatting:** `ruff check solarfarmer/ tests/` and `ruff format solarfarmer/ tests/`
+- **Tests:** `pytest tests/ -v`
+
+All contributions should include tests for new functionality. For feature proposals or questions, contact [solarfarmer@dnv.com](mailto:solarfarmer@dnv.com). See [CONTRIBUTING.md](CONTRIBUTING.md) for full guidelines.
+
+## Getting Technical Support
+
+- **SDK documentation:** https://dnv-opensource.github.io/solarfarmer-python-sdk/
+- **SolarFarmer API documentation:** https://mysoftware.dnv.com/download/public/renewables/solarfarmer/manuals/latest/WebApi/Introduction/introduction.html
+- **Issue tracker:** https://github.com/dnv-opensource/solarfarmer-python-sdk/issues
+- **Email:** [solarfarmer@dnv.com](mailto:solarfarmer@dnv.com)
+
+## License
+
+Apache License, Version 2.0 — see [LICENSE](LICENSE).

dnv_solarfarmer-0.2.0rc1/README.md

@@ -0,0 +1,125 @@
+# SolarFarmer Python SDK
+
+[![PyPI version](https://img.shields.io/pypi/v/dnv-solarfarmer)](https://pypi.org/project/dnv-solarfarmer/)
+[![Python versions](https://img.shields.io/pypi/pyversions/dnv-solarfarmer)](https://pypi.org/project/dnv-solarfarmer/)
+[![License](https://img.shields.io/badge/license-Apache%202.0-blue)](LICENSE)
+[![CI](https://github.com/dnv-opensource/solarfarmer-python-sdk/actions/workflows/test.yml/badge.svg)](https://github.com/dnv-opensource/solarfarmer-python-sdk/actions/workflows/test.yml)
+[![Documentation](https://img.shields.io/badge/docs-online-teal)](https://dnv-opensource.github.io/solarfarmer-python-sdk/)
+
+The official Python SDK for [DNV SolarFarmer](https://www.dnv.com/software/services/solarfarmer/), a bankable solar PV calculation engine. Use it to build validated API payloads, run cloud-based 2D and 3D energy calculations, and analyse simulation results — all from Python.
+
+## Key Features
+
+- **API-faithful data models** that closely mirror the SolarFarmer API schema, with serialization conveniences (snake_case Python fields serialized to the correct camelCase JSON automatically) to reduce integration friction
+- **Two plant-building approaches:** a bottom-up route using `EnergyCalculationInputs`, `PVPlant`, and component classes (`Inverter`, `Layout`, `Transformer`, etc.) for full control over the plant topology; and a `PVSystem` convenience class that accepts high-level parameters (capacity, tilt, GCR, equipment files) and constructs the payload automatically, suited to indicative simulations where exhaustive detail is not required
+- **`CalculationResults` encapsulation** — the API response is wrapped in a `CalculationResults` object that provides structured access to annual and monthly energy metrics, loss trees, PVsyst-format time-series, and detailed time-series output without manual JSON parsing
+- **ModelChain and ModelChainAsync endpoint support** — the SDK dispatches to the synchronous `ModelChain` endpoint or the asynchronous `ModelChainAsync` endpoint as appropriate, and handles polling automatically for long-running jobs
+- **Async job management** — poll, monitor, and terminate async calculations via `terminate_calculation()`
+
+## Requirements
+
+- Python >= 3.10 (tested on 3.10, 3.11, 3.12, 3.13)
+- A SolarFarmer API key (commercial licence required) — see [API Key](#api-key)
+
+## Installation
+
+Install from PyPI:
+
+```bash
+pip install dnv-solarfarmer
+```
+
+The package is imported as `solarfarmer` regardless of the distribution name:
+
+```python
+import solarfarmer as sf
+```
+
+Install with optional extras:
+
+```bash
+pip install "dnv-solarfarmer[notebooks]"  # JupyterLab and notebook support
+pip install "dnv-solarfarmer[all]"         # full installation including pandas and matplotlib
+pip install "dnv-solarfarmer[dev]"         # linting and testing tools (for contributors)
+```
+
+Install from source:
+
+```bash
+git clone https://github.com/dnv-opensource/solarfarmer-python-sdk
+cd solarfarmer-python-sdk
+pip install -e .
+```
+
+## API Key
+
+A SolarFarmer API key is required to run energy calculations. Obtain one from the [SolarFarmer portal](https://solarfarmer.dnv.com/). For setup instructions, see the [API key documentation](https://mysoftware.dnv.com/download/public/renewables/solarfarmer/manuals/latest/WebApi/Introduction/ApiKey.html).
+
+Set your key as an environment variable (recommended):
+
+```bash
+export SF_API_KEY="your_api_key_here"
+```
+
+Alternatively, pass it directly as the `api_key` parameter to any function that calls the API.
+
+## Configuration
+
+| Environment Variable | Default | Description |
+|---|---|---|
+| `SF_API_KEY` | *(none — required for calculations)* | API authentication token |
+| `SF_API_URL` | `https://solarfarmer.dnv.com/latest/api` | Override the base API URL for custom deployments |
+
+## Getting Started
+
+The SDK is built around three workflows suited to different use cases:
+
+| Workflow | Best for | Primary entry point |
+|---|---|---|
+| 1. Load existing files | Users with pre-built API payloads from the SolarFarmer desktop app or a previous export | `sf.run_energy_calculation(inputs_folder_path=...)` |
+| 2. PVSystem builder | Solar engineers designing new plants programmatically with automatic payload generation | `sf.PVSystem(...)` then `plant.run_energy_calculation()` |
+| 3. Custom integration | Developers mapping internal databases or proprietary formats to the SolarFarmer API | `sf.EnergyCalculationInputs(location=..., pv_plant=..., ...)` |
+
+See the [Getting Started guide](https://dnv-opensource.github.io/solarfarmer-python-sdk/getting-started/) for full per-workflow walkthroughs, and the [example notebooks](https://dnv-opensource.github.io/solarfarmer-python-sdk/notebooks/Example_EnergyCalculations/) for runnable end-to-end examples.
+
+## Documentation
+
+Full documentation including API reference, workflow guides, and notebook tutorials:
+
+**https://dnv-opensource.github.io/solarfarmer-python-sdk/**
+
+To build and serve the documentation locally:
+
+```bash
+pip install "dnv-solarfarmer[docs]"
+zensical serve -o                          # build, serve, and open in browser (port 8000)
+zensical serve -o -a localhost:8080        # use a different port
+```
+
+`zensical serve` builds the docs and starts a local server in one step. The `-o` flag opens the page automatically in your default browser.
+
+## Contributing
+
+Fork the repository, create a branch, and submit a pull request to `main`. To set up a development environment:
+
+```bash
+git clone https://github.com/dnv-opensource/solarfarmer-python-sdk
+cd solarfarmer-python-sdk
+pip install -e ".[dev]"
+```
+
+- **Linting and formatting:** `ruff check solarfarmer/ tests/` and `ruff format solarfarmer/ tests/`
+- **Tests:** `pytest tests/ -v`
+
+All contributions should include tests for new functionality. For feature proposals or questions, contact [solarfarmer@dnv.com](mailto:solarfarmer@dnv.com). See [CONTRIBUTING.md](CONTRIBUTING.md) for full guidelines.
+
+## Getting Technical Support
+
+- **SDK documentation:** https://dnv-opensource.github.io/solarfarmer-python-sdk/
+- **SolarFarmer API documentation:** https://mysoftware.dnv.com/download/public/renewables/solarfarmer/manuals/latest/WebApi/Introduction/introduction.html
+- **Issue tracker:** https://github.com/dnv-opensource/solarfarmer-python-sdk/issues
+- **Email:** [solarfarmer@dnv.com](mailto:solarfarmer@dnv.com)
+
+## License
+
+Apache License, Version 2.0 — see [LICENSE](LICENSE).

dnv_solarfarmer-0.2.0rc1/dnv_solarfarmer.egg-info/PKG-INFO

@@ -0,0 +1,176 @@
+Metadata-Version: 2.4
+Name: dnv-solarfarmer
+Version: 0.2.0rc1
+Summary: SDK for SolarFarmer software, bankable solar PV calculation engine developed by DNV.
+Author-email: "DNV Green Power Monitor, Green Data Products" <solarfarmer@dnv.com>
+Maintainer-email: Green Data Products <solarfarmer@dnv.com>
+License: Apache-2.0
+Project-URL: Homepage, https://www.dnv.com/software/services/solarfarmer/
+Project-URL: Repository, https://github.com/dnv-opensource/solarfarmer-python-sdk
+Project-URL: Issues, https://github.com/dnv-opensource/solarfarmer-python-sdk/issues
+Keywords: sdk,api,solarfarmer,dnv,python
+Classifier: Intended Audience :: Information Technology
+Classifier: Programming Language :: Python :: 3
+Classifier: Programming Language :: Python :: 3 :: Only
+Classifier: Programming Language :: Python :: 3.10
+Classifier: Programming Language :: Python :: 3.11
+Classifier: Programming Language :: Python :: 3.12
+Classifier: Programming Language :: Python :: 3.13
+Classifier: License :: OSI Approved :: Apache Software License
+Classifier: Operating System :: OS Independent
+Classifier: Topic :: Internet
+Classifier: Topic :: Software Development :: Libraries :: Python Modules
+Classifier: Topic :: Software Development :: Libraries
+Classifier: Topic :: Software Development
+Classifier: Topic :: Scientific/Engineering
+Requires-Python: >=3.10
+Description-Content-Type: text/markdown
+License-File: LICENSE
+Requires-Dist: pydantic>=2.0
+Requires-Dist: requests>=2.28
+Requires-Dist: tabulate>=0.9.0
+Provides-Extra: docs
+Requires-Dist: zensical>=0.0.20; extra == "docs"
+Requires-Dist: mkdocstrings[python]>=0.26.1; extra == "docs"
+Requires-Dist: mkdocs-jupyter>=0.24; extra == "docs"
+Provides-Extra: test
+Requires-Dist: pytest>=7.0; extra == "test"
+Provides-Extra: dev
+Requires-Dist: dnv-solarfarmer[test]; extra == "dev"
+Requires-Dist: pre-commit>=3.0; extra == "dev"
+Requires-Dist: ruff>=0.5; extra == "dev"
+Provides-Extra: notebooks
+Requires-Dist: ipykernel<8,>=6.29; extra == "notebooks"
+Requires-Dist: jupyterlab<6,>=4.0; extra == "notebooks"
+Requires-Dist: notebook<9,>=7.0; extra == "notebooks"
+Provides-Extra: all
+Requires-Dist: dnv-solarfarmer[dev,docs,notebooks]; extra == "all"
+Requires-Dist: pandas>=2.0; extra == "all"
+Requires-Dist: matplotlib>=3.5; extra == "all"
+Dynamic: license-file
+
+# SolarFarmer Python SDK
+
+[![PyPI version](https://img.shields.io/pypi/v/dnv-solarfarmer)](https://pypi.org/project/dnv-solarfarmer/)
+[![Python versions](https://img.shields.io/pypi/pyversions/dnv-solarfarmer)](https://pypi.org/project/dnv-solarfarmer/)
+[![License](https://img.shields.io/badge/license-Apache%202.0-blue)](LICENSE)
+[![CI](https://github.com/dnv-opensource/solarfarmer-python-sdk/actions/workflows/test.yml/badge.svg)](https://github.com/dnv-opensource/solarfarmer-python-sdk/actions/workflows/test.yml)
+[![Documentation](https://img.shields.io/badge/docs-online-teal)](https://dnv-opensource.github.io/solarfarmer-python-sdk/)
+
+The official Python SDK for [DNV SolarFarmer](https://www.dnv.com/software/services/solarfarmer/), a bankable solar PV calculation engine. Use it to build validated API payloads, run cloud-based 2D and 3D energy calculations, and analyse simulation results — all from Python.
+
+## Key Features
+
+- **API-faithful data models** that closely mirror the SolarFarmer API schema, with serialization conveniences (snake_case Python fields serialized to the correct camelCase JSON automatically) to reduce integration friction
+- **Two plant-building approaches:** a bottom-up route using `EnergyCalculationInputs`, `PVPlant`, and component classes (`Inverter`, `Layout`, `Transformer`, etc.) for full control over the plant topology; and a `PVSystem` convenience class that accepts high-level parameters (capacity, tilt, GCR, equipment files) and constructs the payload automatically, suited to indicative simulations where exhaustive detail is not required
+- **`CalculationResults` encapsulation** — the API response is wrapped in a `CalculationResults` object that provides structured access to annual and monthly energy metrics, loss trees, PVsyst-format time-series, and detailed time-series output without manual JSON parsing
+- **ModelChain and ModelChainAsync endpoint support** — the SDK dispatches to the synchronous `ModelChain` endpoint or the asynchronous `ModelChainAsync` endpoint as appropriate, and handles polling automatically for long-running jobs
+- **Async job management** — poll, monitor, and terminate async calculations via `terminate_calculation()`
+
+## Requirements
+
+- Python >= 3.10 (tested on 3.10, 3.11, 3.12, 3.13)
+- A SolarFarmer API key (commercial licence required) — see [API Key](#api-key)
+
+## Installation
+
+Install from PyPI:
+
+```bash
+pip install dnv-solarfarmer
+```
+
+The package is imported as `solarfarmer` regardless of the distribution name:
+
+```python
+import solarfarmer as sf
+```
+
+Install with optional extras:
+
+```bash
+pip install "dnv-solarfarmer[notebooks]"  # JupyterLab and notebook support
+pip install "dnv-solarfarmer[all]"         # full installation including pandas and matplotlib
+pip install "dnv-solarfarmer[dev]"         # linting and testing tools (for contributors)
+```
+
+Install from source:
+
+```bash
+git clone https://github.com/dnv-opensource/solarfarmer-python-sdk
+cd solarfarmer-python-sdk
+pip install -e .
+```
+
+## API Key
+
+A SolarFarmer API key is required to run energy calculations. Obtain one from the [SolarFarmer portal](https://solarfarmer.dnv.com/). For setup instructions, see the [API key documentation](https://mysoftware.dnv.com/download/public/renewables/solarfarmer/manuals/latest/WebApi/Introduction/ApiKey.html).
+
+Set your key as an environment variable (recommended):
+
+```bash
+export SF_API_KEY="your_api_key_here"
+```
+
+Alternatively, pass it directly as the `api_key` parameter to any function that calls the API.
+
+## Configuration
+
+| Environment Variable | Default | Description |
+|---|---|---|
+| `SF_API_KEY` | *(none — required for calculations)* | API authentication token |
+| `SF_API_URL` | `https://solarfarmer.dnv.com/latest/api` | Override the base API URL for custom deployments |
+
+## Getting Started
+
+The SDK is built around three workflows suited to different use cases:
+
+| Workflow | Best for | Primary entry point |
+|---|---|---|
+| 1. Load existing files | Users with pre-built API payloads from the SolarFarmer desktop app or a previous export | `sf.run_energy_calculation(inputs_folder_path=...)` |
+| 2. PVSystem builder | Solar engineers designing new plants programmatically with automatic payload generation | `sf.PVSystem(...)` then `plant.run_energy_calculation()` |
+| 3. Custom integration | Developers mapping internal databases or proprietary formats to the SolarFarmer API | `sf.EnergyCalculationInputs(location=..., pv_plant=..., ...)` |
+
+See the [Getting Started guide](https://dnv-opensource.github.io/solarfarmer-python-sdk/getting-started/) for full per-workflow walkthroughs, and the [example notebooks](https://dnv-opensource.github.io/solarfarmer-python-sdk/notebooks/Example_EnergyCalculations/) for runnable end-to-end examples.
+
+## Documentation
+
+Full documentation including API reference, workflow guides, and notebook tutorials:
+
+**https://dnv-opensource.github.io/solarfarmer-python-sdk/**
+
+To build and serve the documentation locally:
+
+```bash
+pip install "dnv-solarfarmer[docs]"
+zensical serve -o                          # build, serve, and open in browser (port 8000)
+zensical serve -o -a localhost:8080        # use a different port
+```
+
+`zensical serve` builds the docs and starts a local server in one step. The `-o` flag opens the page automatically in your default browser.
+
+## Contributing
+
+Fork the repository, create a branch, and submit a pull request to `main`. To set up a development environment:
+
+```bash
+git clone https://github.com/dnv-opensource/solarfarmer-python-sdk
+cd solarfarmer-python-sdk
+pip install -e ".[dev]"
+```
+
+- **Linting and formatting:** `ruff check solarfarmer/ tests/` and `ruff format solarfarmer/ tests/`
+- **Tests:** `pytest tests/ -v`
+
+All contributions should include tests for new functionality. For feature proposals or questions, contact [solarfarmer@dnv.com](mailto:solarfarmer@dnv.com). See [CONTRIBUTING.md](CONTRIBUTING.md) for full guidelines.
+
+## Getting Technical Support
+
+- **SDK documentation:** https://dnv-opensource.github.io/solarfarmer-python-sdk/
+- **SolarFarmer API documentation:** https://mysoftware.dnv.com/download/public/renewables/solarfarmer/manuals/latest/WebApi/Introduction/introduction.html
+- **Issue tracker:** https://github.com/dnv-opensource/solarfarmer-python-sdk/issues
+- **Email:** [solarfarmer@dnv.com](mailto:solarfarmer@dnv.com)
+
+## License
+
+Apache License, Version 2.0 — see [LICENSE](LICENSE).

dnv_solarfarmer-0.2.0rc1/dnv_solarfarmer.egg-info/SOURCES.txt

@@ -0,0 +1,69 @@
+LICENSE
+MANIFEST.in
+README.md
+mkdocs.yml
+pyproject.toml
+dnv_solarfarmer.egg-info/PKG-INFO
+dnv_solarfarmer.egg-info/SOURCES.txt
+dnv_solarfarmer.egg-info/dependency_links.txt
+dnv_solarfarmer.egg-info/requires.txt
+dnv_solarfarmer.egg-info/top_level.txt
+docs/404.md
+docs/api.md
+docs/faq.md
+docs/index.md
+docs/license.md
+docs/getting-started/end-to-end-examples.md
+docs/getting-started/index.md
+docs/getting-started/quick-start-examples.md
+docs/getting-started/workflow-1-existing-api-files.md
+docs/getting-started/workflow-2-pvplant-builder.md
+docs/getting-started/workflow-3-plantbuilder-advanced.md
+solarfarmer/__init__.py
+solarfarmer/__version__.py
+solarfarmer/api.py
+solarfarmer/config.py
+solarfarmer/endpoint_about.py
+solarfarmer/endpoint_modelchains.py
+solarfarmer/endpoint_modelchains_utils.py
+solarfarmer/endpoint_service.py
+solarfarmer/endpoint_terminate_async.py
+solarfarmer/logging.py
+solarfarmer/models/__init__.py
+solarfarmer/models/_base.py
+solarfarmer/models/auxiliary_losses.py
+solarfarmer/models/energy_calculation_inputs.py
+solarfarmer/models/energy_calculation_options.py
+solarfarmer/models/energy_calculation_results.py
+solarfarmer/models/enums.py
+solarfarmer/models/inverter.py
+solarfarmer/models/layout.py
+solarfarmer/models/location.py
+solarfarmer/models/model_chain_response.py
+solarfarmer/models/monthly_albedo.py
+solarfarmer/models/mounting_type_specification.py
+solarfarmer/models/ond_supplements.py
+solarfarmer/models/pan_supplements.py
+solarfarmer/models/pv_plant.py
+solarfarmer/models/tracker_system.py
+solarfarmer/models/transformer.py
+solarfarmer/models/transformer_specification.py
+solarfarmer/models/pvsystem/__init__.py
+solarfarmer/models/pvsystem/plant_defaults.py
+solarfarmer/models/pvsystem/plant_utils.py
+solarfarmer/models/pvsystem/pvsystem.py
+solarfarmer/models/pvsystem/validation.py
+tests/test_api.py
+tests/test_construct_plant.py
+tests/test_endpoint_about.py
+tests/test_endpoint_modelchain.py
+tests/test_endpoint_modelchains_utils.py
+tests/test_endpoint_service.py
+tests/test_endpoint_terminate_async.py
+tests/test_energy_calculation_results.py
+tests/test_logging.py
+tests/test_model_chain_response.py
+tests/test_plant_utils.py
+tests/test_pvsystem.py
+tests/test_validation_message.py
+tests/test_version.py

dnv_solarfarmer-0.2.0rc1/dnv_solarfarmer.egg-info/dependency_links.txt

@@ -0,0 +1 @@
+

dnv_solarfarmer-0.2.0rc1/dnv_solarfarmer.egg-info/requires.txt

@@ -0,0 +1,26 @@
+pydantic>=2.0
+requests>=2.28
+tabulate>=0.9.0
+
+[all]
+dnv-solarfarmer[dev,docs,notebooks]
+pandas>=2.0
+matplotlib>=3.5
+
+[dev]
+dnv-solarfarmer[test]
+pre-commit>=3.0
+ruff>=0.5
+
+[docs]
+zensical>=0.0.20
+mkdocstrings[python]>=0.26.1
+mkdocs-jupyter>=0.24
+
+[notebooks]
+ipykernel<8,>=6.29
+jupyterlab<6,>=4.0
+notebook<9,>=7.0
+
+[test]
+pytest>=7.0

dnv_solarfarmer-0.2.0rc1/dnv_solarfarmer.egg-info/top_level.txt

@@ -0,0 +1 @@
+solarfarmer

dnv_solarfarmer-0.2.0rc1/docs/404.md

@@ -0,0 +1,36 @@
+# 404 - Page Not Found
+
+The page you're looking for cannot be found.
+
+## Quick Links
+
+**[← Back to Home](index.md)** | **[Getting Started](getting-started/index.md)** | **[API Reference](api.md)**
+
+## Find What You Need
+
+### Popular Pages
+
+- [Quick Start Examples](getting-started/quick-start-examples.md)
+- [Workflow 1: Load Existing API Files](getting-started/workflow-1-existing-api-files.md)
+- [Workflow 2: Design Plants with PVSystem](getting-started/workflow-2-pvplant-builder.md)
+- [Workflow 3: Advanced Integration](getting-started/workflow-3-plantbuilder-advanced.md)
+- [End-to-End Examples](getting-started/end-to-end-examples.md)
+
+### Example Notebooks
+
+Browse our [Jupyter notebook examples](getting-started/index.md) for hands-on tutorials covering:
+
+- Using the About and Service Endpoints
+- Running 2D and 3D Calculations
+- Creating Plants with PVSystem
+- Terminating Asynchronous Calculations
+
+## Need Help?
+
+**Search** - Use the search bar above to find documentation
+
+**Report Issues** - [GitHub Issues](https://github.com/dnv-opensource/solarfarmer-api-python-sdk/issues)
+
+**Contact** - [solarfarmer@dnv.com](mailto:solarfarmer@dnv.com)
+
+**Community** - Follow on [LinkedIn](https://www.linkedin.com/feed/hashtag/solarfarmer/)