Skip to main content

Tools for performing common tasks on solar PV data signals

Project description



Explore our documentation · Report Issue

Repo Status Project Status: Active – The project has reached a stable, usable state and is being actively developed.
pyOpenSci Peer-Reviewed Project has been peer-reviewed by pyOpenSci.
JOSS Paper DOI badge
Python Versions latest release
Latest Release latest release
License license
Build Status documentation build status Actions build status
Publications DOI
PyPI Downloads PyPI downloads
Conda Downloads conda-forge downloads
Test-Coverage test-coverage

Solar Data Tools is an open-source Python library for analyzing PV power (and irradiance) time-series data. It was developed to enable analysis of unlabeled PV data, i.e. with no model, no meteorological data, and no performance index required, by taking a statistical signal processing approach in the algorithms used in the package’s main data processing pipeline. Solar Data Tools empowers PV system fleet owners or operators to analyze system performance a hundred times faster even when they only have access to the most basic data stream—power output of the system.

Solar Data Tools provides methods for data I/O, cleaning, filtering, plotting, and analysis. These methods are largely automated and require little to no input from the user regardless of system type—from utility tracking systems to multi-pitch rooftop systems. Head over to our Getting Started pages in our documentation for a demo!

As of April 2026, we have a new webinar posted to YouTube! Check it out here:


You can also check the notebooks folder in this repo for more examples.

This work is supported by the U.S. Department of Energy’s Office of Energy Efficiency and Renewable Energy (EERE) under the Solar Energy Technologies Office Award Number 38529.

Install & Setup

Recommended: Install with pip

In a fresh Python virtual environment, simply run:

$ pip install solar-data-tools

or if you would like to use MOSEK, install the optional dependency as well:

$ pip install "solar-data-tools[mosek]"

Install with conda

[!WARNING] solar-data-tools is now available on conda-forge! You can specify the channel using the -c flag as shown in the examples below. The use of the slacgismo channel is deprecated and packages on that channel will not be up-to-date with the latest releases.

Creating the environment and directly installing the package and its dependencies from the appropriate conda channels:

$ conda create -n pvi-user solar-data-tools -c conda-forge

Starting the environment:

$ conda activate pvi-user

Stopping the environment:

$ conda deactivate

Or alternatively install the package in an already existing environment:

$ conda install solar-data-tools -c conda-forge

Solvers

CLARABEL

By default, the CLARABEL solver is used to solve the signal decomposition problems. CLARABEL (as well as other solvers) is compatible with OSD, the modeling language used to solve signal decomposition problems in Solar Data Tools. Both are open source and are dependencies of Solar Data Tools.

MOSEK

MOSEK is a commercial software package. Since it is more stable and offers faster solve times, we provide continuing support for it (with signal decomposition problem formulations using CVXPY). However, you will still need to obtain a license. If installing with pip, you can install the optional MOSEK dependency by running pip install "solar-data-tools[mosek]". If installing from conda, you will have to manually install MOSEK if you desire to use it as conda does not support optional dependencies like pip.

More information about MOSEK and how to obtain a license is available here:

Usage

Users will primarily interact with this software through the DataHandler class. By default, Solar Data Tools uses CLARABEL as the solver all signal decomposition problems. If you would like to specify another solver (such as MOSEK), just pass the keyword argument solver to DataHandler.pipeline with the solver of choice.

from solardatatools import DataHandler
from solardatatools.dataio import get_pvdaq_data

pv_system_data = get_pvdaq_data(sysid=35, api_key='DEMO_KEY', year=[2011, 2012, 2013])

dh = DataHandler(pv_system_data)
dh.run_pipeline(power_col='dc_power')

If everything is working correctly, you should see a run summary like the following

total time: 25.99 seconds
--------------------------------
Breakdown
--------------------------------
Preprocessing              6.76s
Cleaning                   0.41s
Filtering/Summarizing      18.83s
    Data quality           0.21s
    Clear day detect       0.44s
    Clipping detect        15.51s
    Capacity change detect 2.67s

You can also find more in-depth tutorials and guides in our documentation.

Contributing

We welcome contributions of any form! Please see our Contribution Guidelines for more information.

Citing Solar Data Tools

If you use Solar Data Tools in your research, please cite:

Recommended citation

Sara A. Miskovich, Bennet E. Meyers, et al., "Solar Data Tools: a Python library for automated analysis of unlabeled PV data," Journal of Open Source Software, 10(110), 8478, 2025, doi: 10.21105/joss.08478

Citing technical details (e.g., SDT algorithms)

Bennet E. Meyers, PVInsight (Final Technical Report), SLAC Report SLAC-R-1155, 2021, doi: 10.2172/1897181

Bennet E. Meyers, Elpiniki Apostolaki-Iosifidou and Laura Schelhas, "Solar Data Tools: Automatic Solar Data Processing Pipeline," 2020 47th IEEE Photovoltaic Specialists Conference (PVSC), Calgary, AB, Canada, 2020, pp. 0655-0656, doi: 10.1109/PVSC45281.2020.9300847.

Citing a specific version

You can also cite the DOI corresponding to the specific version of Solar Data Tools that you used. Solar Data Tools DOIs are listed at here.

Versioning

We use Semantic Versioning for versioning. For the versions available, see the tags on this repository.

Authors

See also the list of contributors who participated in this project.

Copyright Notice

COPYRIGHT © 2025 Alliance for Sustainable Energy, LLC and SLAC National Accelerator Laboratory. All rights reserved. This work is supported in part by the U.S. Department of Energy, Office of Basic Energy Sciences under contract DE-AC02-76SF00515.

Usage Restrictions

Neither the name of the Leland Stanford Junior University, SLAC National Accelerator Laboratory, U.S. Department of Energy nor the names of its contributors may be used to endorse or promote products derived from this software without specific prior written permission.

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

solar_data_tools-2.1.4.tar.gz (76.9 MB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

solar_data_tools-2.1.4-py3-none-any.whl (77.0 MB view details)

Uploaded Python 3

File details

Details for the file solar_data_tools-2.1.4.tar.gz.

File metadata

  • Download URL: solar_data_tools-2.1.4.tar.gz
  • Upload date:
  • Size: 76.9 MB
  • Tags: Source
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/6.1.0 CPython/3.13.12

File hashes

Hashes for solar_data_tools-2.1.4.tar.gz
Algorithm Hash digest
SHA256 87101d7edb6356b277362bd8a2bd4f8d0197de87f44be1bf9dcf57a1dd55de63
MD5 0a70fab6f7ec47890725a5bae86e75c8
BLAKE2b-256 c5163092d4b405fc0dda42b899a8bb16a0cb306631ea471409aa3bf3aec5d969

See more details on using hashes here.

Provenance

The following attestation bundles were made for solar_data_tools-2.1.4.tar.gz:

Publisher: build.yml on NatLabRockies/solar-data-tools

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

File details

Details for the file solar_data_tools-2.1.4-py3-none-any.whl.

File metadata

File hashes

Hashes for solar_data_tools-2.1.4-py3-none-any.whl
Algorithm Hash digest
SHA256 c849c35fdb0011ff9f65b0ec7ac2fa395ac9db9a74a58b068bbba92165f7b995
MD5 45afb23e0dea2a64a350aaaf39c2358f
BLAKE2b-256 6c913a4e8c27e42a0a240ea21df6713034e4c1b2476fc0469b486915ddb56d30

See more details on using hashes here.

Provenance

The following attestation bundles were made for solar_data_tools-2.1.4-py3-none-any.whl:

Publisher: build.yml on NatLabRockies/solar-data-tools

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page