Install & Setup#

Install with conda#

Warning

When installing solar-data-tools using conda, you will need to add three channels, conda-forge, slacgismo, and stanfordcvxgrp, to your conda config (or alternatively specify them using the -c flag as shown in the examples below). Failure to do so will result in the installation of an outdated solar-data-tools version. Note that we will be moving solar-data-tools to conda-forge soon, which will simplify the installation process. Check back soon for an update! For more on conda channels, see the conda docs.

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 -c slacgismo -c stanfordcvxgrp

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 -c slacgismo -c stanfordcvxgrp

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, and both are open source.

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: