https://github.com/eviatarbach/parasweep

Utility for facilitating parallel parameter sweeps
https://github.com/eviatarbach/parasweep

parameter-sweep python

Last synced: 6 months ago
JSON representation

Utility for facilitating parallel parameter sweeps

• Host: GitHub
• URL: https://github.com/eviatarbach/parasweep
• Owner: eviatarbach
• License: mit
• Created: 2018-03-25T22:23:37.000Z (over 8 years ago)
• Default Branch: main
• Last Pushed: 2021-04-08T16:25:07.000Z (about 5 years ago)
• Last Synced: 2025-09-25T02:28:00.473Z (10 months ago)
• Topics: parameter-sweep, python
• Language: Python
• Homepage:
• Size: 121 KB
• Stars: 6
• Watchers: 3
• Forks: 1
• Open Issues: 0
• Metadata Files:
  • Readme: README.rst
  • Changelog: HISTORY.rst
  • Contributing: CONTRIBUTING.rst
  • License: LICENSE

Awesome Lists containing this project

README

          
=========

parasweep

=========

.. image:: https://img.shields.io/pypi/v/parasweep.svg

        :target: https://pypi.python.org/pypi/parasweep

.. image:: https://readthedocs.org/projects/parasweep/badge/?version=latest

        :target: https://parasweep.readthedocs.io/en/latest/?badge=latest

        :alt: 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!**

* Free software: MIT license

* Documentation: http://www.parasweep.io

* Code: https://github.com/eviatarbach/parasweep

Dependencies

------------

* Python 3.6+

* xarray

* numpy

* scipy

* Mako (optional)

* drmaa-python (optional)

Credits

-------

Developed by `Eviatar Bach `_ . 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.

.. _Cookiecutter: https://github.com/audreyr/cookiecutter

.. _`audreyr/cookiecutter-pypackage`: https://github.com/audreyr/cookiecutter-pypackage