Skip to content

Utility for facilitating parallel parameter sweeps

License

Notifications You must be signed in to change notification settings

eviatarbach/parasweep

Repository files navigation

parasweep

Documentation Status

parasweep is a free and open-source Python utility for facilitating parallel parameter sweeps with computational models. Instead of requiring parameters to be passed by command-line, which can be error-prone and time-consuming, parasweep leverages the model's existing configuration files using a template system, requiring minimal code changes. After the sweep values are specified, a parallel job is dispatched for each parameter set, with support for common high-performance computing job schedulers. Post-processing is facilitated by providing a mapping between the parameter sets and the simulations.

The following paper gives a description as well as a simple example to get started:

Bach, Eviatar (2021). parasweep: A template-based utility for generating, dispatching, and post-processing of parameter sweeps. SoftwareX, 13, 100631, https://doi.org/10.1016/j.softx.2020.100631.

Please cite it if you find parasweep useful for your project!

Dependencies

  • Python 3.6+
  • xarray
  • numpy
  • scipy
  • Mako (optional)
  • drmaa-python (optional)

Credits

Developed by Eviatar Bach <[email protected]>. Special thanks to Daniel Philipps (danielphili) for a bug fix and feature suggestion.

This package was created with Cookiecutter and the audreyr/cookiecutter-pypackage project template.