Skip to content

Repository files navigation

Pytest Tests codecov Documentation Status GitHub contributors Merged PRs Code style: black

sparow

Description

Sparow is a Python library of optimization solvers for stochastic programming.

Installation

Sparow requires the installation of or-topas, which can be installed using pip as follows:

git clone git@github.com:or-fusion/or_topas.git
cd or_topas
pip install -e .
cd ..

Developers should install Sparow using pip as follows:

git clone git@github.com:or-fusion/sparow.git
cd sparow
pip install -e .
cd ..

There are some shell scripts and plotting code located in sparow/bin that can be used for running numerical experiments with the Uncertainty Quantification (UQ) workflows. In these scripts, you can change the file paths to use your own custom stochastic programming models (see the README.md in sparow/conf_intervals for more details). If you want to run these optional plotting scripts that generate figures from results stored in CSV format, install the plotting dependencies:

cd sparow
pip install -e ".[plot]"
cd ..

Additionally, the following syntax generates a summary that includes code coverage:

pytest --cov-report term-missing --cov=sparow .

About

Stochastic Programming And Related Optimization Workflows

Topics

Resources

Contributing

Stars

3 stars

Watchers

1 watching

Forks

Releases

Packages

Used by

Contributors

Languages