.. solarspatialtools documentation master file, created by sphinx-quickstart on Mon Jul 15 15:04:14 2024. You can adapt this file completely to your liking, but it should at least contain the root `toctree` directive. SolarSpatialTools documentation =============================== ``solarspatialtools`` is a python package containing implementations of various spatial algorithms for solar energy data. While excellent open source solar energy packages already exist (e.g. `pvlib-python `_ and `pvanalytics `_), the complexity of some high-level analyses found in the academic literature makes them as a poor fit for the scope of existing packages. This package fills that gap by implementing techniques that we hope can facilitate common spatial tasks for solar energy researchers and provide a platform for consistency and efficiency improvements in these calculations. Installation ------------ The package can be most easily installed via `PyPi `_ with the following command:: pip install solarspatialtools Getting Started --------------- The functions in this package likely to be of general interest to the research community are those in the modules :mod:`solarspatialtools.cmv` and :mod:`solarspatialtools.field`. The :mod:`solarspatialtools.cmv` module contains functions for calculating the cloud motion vector from a distributed network of irradiance measurements. The :mod:`solarspatialtools.field` module contains functions for validating the layout of a PV plant or measurement network by calculating the relative delays between each sensor in the network subject to cloud motion. The :mod:`solarspatialtools.synthirrad` package contains functions for downscaling and generation of synthetic irradiance timeseries. The best starting point is to read through the :ref:`cmv-examples` and :ref:`field-examples` sections to see some sample Jupyter notebooks that demonstrate how these functions can be used in practice. Contents -------- .. toctree:: :maxdepth: 1 :caption: API Reference cmv field synthirrad othermods .. toctree:: :maxdepth: 2 :caption: Examples examples