parasweep 2019.2

Utility for facilitating parallel parameter sweeps.

=========
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.

* Free software: MIT license
* Documentation: https://parasweep.readthedocs.io.

Usage
-----

See the :doc:`examples` and the documentation for
:func:`~parasweep.sweep.run_sweep` for full usage details.

Dependencies
------------

* Python 3
* xarray
* numpy
* Mako (optional)
* drmaa-python (optional)

Credits
-------

Developed by `Eviatar Bach <http://eviatarbach.com/>`_ <[e-mail]>.

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


=======
History
=======

2019.02 (2019-02-07)
--------------------

* Separating sweep logic into a separate module.
* Adding FilteredCartesianSweep sweep type.
* Numerous documentation changes, including many more examples.

2019.01 (2019-01-21)
--------------------

* First release on PyPI.